1=head1 NAME
2
3C<razor-revoke> - Razor Revoking Agent
4
5=head1 SYNOPSIS
6
7    razor-revoke [options]  file_with_mail_in_rfc822_format
8
9    $ cat mail | razor-revoke
10    $ razor-revoke ./mail
11    $ razor-revoke -d ./mail
12
13=head1 DESCRIPTION
14
15C<razor-revoke> is the Razor Revoking Agent which is used for reporting
16messages as NOT spam to a Razor Nomination Server. For instance, it can
17be invoked if a check incorrectly marked a message as spam or after a
18message was incorrectly reported as spam. C<razor-revoke> should be
19generally called from a MUA, although there are no restrictions on
20invoking it from the command-line. C<razor-revoke> is a filter, which
21means that spam messages should be piped through it. By default,
22C<razor-revoke> backgrounds and detaches itself from the control
23terminal at start-up.
24
25If C<razor-revoke> is passed more than one mail, it will revoke each against
26the database.  Please use this with caution, we don't want the database
27to have inaccurate information.
28C<razor-revoke> supports mbox-formatted files with 1 or more mails in
29them as well as files containing a single RFC 822 (non-mbox) mail.
30More than one file may be present on the command line, can be either
31a non-mbox or mbox in any order.
32However, more than one non-mbox mail cannot be read from stdin.
33
34Both razor-report(1) and C<razor-revoke> require user authentication to
35work, see razor-admin(1). This allows the Razor Nomination Server to
36keep track of how many messages a user reports and revokes. The more
37messages a user correctly reports and/or correctly revokes, the more
38trust the user earns. Likewise, when messages are incorrectly reported
39or revoked, the trust goes down for that user. Highly trusted users will
40have the most affect on the Razor database.
41
42Note that even after a successful revoke, a mail might still be
43considered spam in the Razor Catalogue. For instance, this can occur if
44more trusted users consider the mail spam than not spam.
45
46=head1 USAGE
47
48C<razor-revoke> takes following arguments:
49
50=over 4
51
52=item C<-h>
53
54Print a usage message and exit.
55
56=item C<-v>
57
58Print the version number and exit.
59
60=item C<-d | --verbose>
61
62Print debugging information.
63
64=item C<-debuglevel=n | -dl=n>
65
66Set debug level to 'n'.  Default is 3 without C<-d> option, 9 with.
67
68=item C<-whitelist=file>
69
70Specify file to use for whitelisting.  Overrides 'whitelist' option in
71C<razor-agent.conf>.
72
73=item C<-s>
74
75Simulate a check. Do everything except talk to the server.
76
77=item C<-conf=filename>
78
79Specifies an alternate configuration file.
80If not specified, it is computed, see razor-agents(1) manpage for details.
81See razor-agent.conf(5) manpage for various configuration options.
82The default is C<E<lt>razorhomeE<gt>/razor-agent.conf>.
83
84=item C<-home=dir>
85
86Specify razorhome directory.  This is where the configuration file,
87logfiles, identities, and server files live.
88If not specified, it is computed, see razor-agents(1) manpage for details.
89
90=item C<-logfile=file>
91
92Specify file to log to instead of whats in configuration file.
93The default is C<E<lt>razorhomeE<gt>/razor-agent.log>.
94
95=item C<-ident=filename>
96
97Specify an identify file to use for authenticating with Razor Servers.
98If not specified, C<E<lt>razorhomeE<gt>/identity-E<lt>userE<gt>> is used.
99
100=item C<-rs=razor.server.com>
101
102Use this Razor Nomination Server instead of reading
103C<servers.nomination.lst>.
104
105=item C<-M | --mbox>
106
107Accept a mailbox name on the command line and revoke every mail in the
108mailbox against the database. If in foreground, C<-f>, C<razor-revoke>
109will print out the mail number of every mail that was accepted by the
110Catalogue server.
111
112 C<razor-revoke -f -M ~/Mail/incorrectly-marked-spam>
113
114=item C<-i=filename>
115
116Used identity from filename instead of reading E<lt>razorhomeE<gt>/identity.
117
118=item C<-a>
119
120Authenticate only. If authenticated, exit 0; if not, exit 1.
121
122=item C<-f>
123
124Stay in foreground, do not detach and run in background.
125
126=back
127
128=head1 INTEGRATION WITH MUTT
129
130Add the following line to C<mutt.conf>
131
132     macro index R "|/usr/bin/razor-revoke"
133
134Then press R on the spam message in C<mutt> to report it with
135C<razor-revoke>. Since C<razor-revoke> forks, the control will return
136immediately.
137
138=head1 AUTHORS
139
140Vipul Ved Prakash E<lt>mail@vipul.netE<gt>, and Chad Norwood E<lt>chad@samo.orgE<gt>
141
142=cut
143
144=head1 SEE ALSO
145
146razor-agents(1), razor-agent.conf(5), razor-check(1),
147razor-admin(1), razor-report(1), razor-whitelist(5)
148
149=head1 LICENSE
150
151This is free software, distributed under the ARTISTIC license.
152
153