.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "RAZOR-CHECK 1"
.TH RAZOR-CHECK 1 2024-09-01 "perl v5.40.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
"razor\-check" \- Razor Filtering Agent
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&    razor\-check [options]  [ mail1 [ mail2 .. ] ]
\&
\&    $ cat mbox | razor\-check
\&    $ razor\-check ./mbox
\&    $ razor\-check \-d mbox mail.1 mail.2 mail.3
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
\&\f(CW\*(C`razor\-check\*(C'\fR checks a mail against the distributed Razor Catalogue by
communicating with a Razor Catalogue Server. It should be invoked before
the mail is delivered or processed by a human. \f(CW\*(C`razor\-check\*(C'\fR terminates
with exit value \f(CW0\fR if the signature for the mail is catalogued on the
server (spam) or \f(CW1\fR if the mail is not catalogued by the server (not a
spam). \f(CW\*(C`razor\-check\*(C'\fR should be invoked against every incoming mail by
mail processors (like procmail) or MTAs (like sendmail). An alternate
method would be to call \f(CW\*(C`razor\-check\*(C'\fR from cron, at regular intervals,
to identify and mark spam in queued mailboxes.
.PP
If \f(CW\*(C`razor\-check\*(C'\fR is passed more than one mail, it will check each against
the database, printing out the serial number of every mail considered to
be spam.  \f(CW\*(C`razor\-check\*(C'\fR supports mbox-formatted files with 1 or more mails in
them as well as files containing a single RFC 822 (non-mbox) mail.  
More than one file may be present on the command line, can be either
a non-mbox or mbox in any order.
However, more than one non-mbox mail cannot be read from stdin.
.SH USAGE
.IX Header "USAGE"
\&\f(CW\*(C`razor\-check\*(C'\fR is usually run by piping the contents of the mail to it,
or by providing the name of the file that contains the mail message to
be checked as the last argument. \f(CW\*(C`razor\-check\*(C'\fR takes the following
arguments:
.ie n .IP """\-h""" 4
.el .IP \f(CW\-h\fR 4
.IX Item "-h"
Print a usage message and exit.
.ie n .IP """\-v""" 4
.el .IP \f(CW\-v\fR 4
.IX Item "-v"
Print the version number and exit.
.ie n .IP """\-d | \-\-verbose""" 4
.el .IP "\f(CW\-d | \-\-verbose\fR" 4
.IX Item "-d | --verbose"
Print debugging information.
.ie n .IP """\-debuglevel=n | \-dl=n""" 4
.el .IP "\f(CW\-debuglevel=n | \-dl=n\fR" 4
.IX Item "-debuglevel=n | -dl=n"
Set debug level to 'n'.  Default is 3 without \f(CW\*(C`\-d\*(C'\fR option, 9 with.
.ie n .IP """\-whitelist=file""" 4
.el .IP \f(CW\-whitelist=file\fR 4
.IX Item "-whitelist=file"
Specify file to use for whitelisting.  Overrides 'whitelist' option in 
\&\f(CW\*(C`razor\-agent.conf\*(C'\fR.
.ie n .IP """\-s""" 4
.el .IP \f(CW\-s\fR 4
.IX Item "-s"
Simulate a check. Do everything except talk to the server.
.ie n .IP """\-conf=filename""" 4
.el .IP \f(CW\-conf=filename\fR 4
.IX Item "-conf=filename"
Specifies an alternate configuration file. 
If not specified, it is computed, see \fBrazor\-agents\fR\|(1) manpage for details.
See \fBrazor\-agent.conf\fR\|(5) manpage for various configuration options.
The default is \f(CW\*(C`<razorhome>/razor\-agent.conf\*(C'\fR.
.ie n .IP """\-home=dir""" 4
.el .IP \f(CW\-home=dir\fR 4
.IX Item "-home=dir"
Specify razorhome directory.  This is where the configuration file, logfiles,
identities, and server files live.
If not specified, it is computed, see \fBrazor\-agents\fR\|(1) manpage for details.
.ie n .IP """\-logfile=file""" 4
.el .IP \f(CW\-logfile=file\fR 4
.IX Item "-logfile=file"
Specify file to log to instead of what is in the configuration file.
The default is \f(CW\*(C`<razorhome>/razor\-agent.log\*(C'\fR.
.ie n .IP """\-rs=razor.server.com""" 4
.el .IP \f(CW\-rs=razor.server.com\fR 4
.IX Item "-rs=razor.server.com"
Use this Razor Catalogue Server instead of reading \f(CW\*(C`servers.catalogue.lst\*(C'\fR.
.ie n .IP """\-H""" 4
.el .IP \f(CW\-H\fR 4
.IX Item "-H"
Compute and print the signature of the mail contents and exit. If
\&\f(CW\*(C`\-e=integer\*(C'\fR is not specified, all supported engines will be used.
.ie n .IP """\-S=string""" 4
.el .IP \f(CW\-S=string\fR 4
.IX Item "-S=string"
Accept a list of pre-computed (with \f(CW\*(C`\-H\*(C'\fR) signatures on the command
line, instead of computing one from mail content. Signatures can be
submitted in hex or base64, but base64 is preferred. Requires
\&\f(CW\*(C`\-e=integer\*(C'\fR. Usage:
.Sp
\&\f(CW\*(C`razor\-report \-e 1 \-S a8a3d545adb73f9733675571ffeaf10cba87745b\*(C'\fR
.ie n .IP """\-e=integer""" 4
.el .IP \f(CW\-e=integer\fR 4
.IX Item "-e=integer"
Specify engine used to create signatures. Must be 1, 2, 3, or 4 in this
version. Engine 1, or \f(CW\*(C`\-e=1\*(C'\fR, is used for Razor 1.x signatures. Used
only with \f(CW\*(C`\-S=string\*(C'\fR or \f(CW\*(C`\-H\*(C'\fR.
.ie n .IP """\-ep4=string""" 4
.el .IP \f(CW\-ep4=string\fR 4
.IX Item "-ep4=string"
String used by engine 4 when computing signatures. Published by the Razor
Catalogue Servers and updated very frequently. Used only when \f(CW\*(C`\-e=4\*(C'\fR.
.SH RECIPES
.IX Header "RECIPES"
\&\f(CW\*(C`razor\-check\*(C'\fR is usually invoked from \fBprocmail\fR\|(1). Here are some common
ways of using it with procmail:
.ie n .IP "To change the ""Subject"" header if mail is spam:" 4
.el .IP "To change the \f(CWSubject\fR header if mail is spam:" 4
.IX Item "To change the Subject header if mail is spam:"
.Vb 4
\&    :0 Wc
\&    | razor\-check
\&    :0 Waf
\&    | formail \-i "Subject: Razor Warning: SPAM/UBE/UCE"
.Ve
.ie n .IP "To add a ""X\-Razor2\-Warning"" header to spam:" 4
.el .IP "To add a \f(CWX\-Razor2\-Warning\fR header to spam:" 4
.IX Item "To add a X-Razor2-Warning header to spam:"
.Vb 4
\&    :0 Wc
\&    | razor\-check
\&    :0 Waf
\&    | formail \-A "X\-Razor2\-Warning: SPAM."
.Ve
.IP "To file spam in a mailbox" 4
.IX Item "To file spam in a mailbox"
.Vb 4
\&    :0 Wc
\&    | razor\-check
\&    :0 Wa
\&    /home/foo/Mail/razor\-caught
.Ve
.SH AUTHORS
.IX Header "AUTHORS"
Vipul Ved Prakash <mail@vipul.net>, and Chad Norwood <chad@samo.org>
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBrazor\-agents\fR\|(1), \fBrazor\-agent.conf\fR\|(5), \fBrazor\-admin\fR\|(1), 
\&\fBrazor\-report\fR\|(1), \fBrazor\-revoke\fR\|(1), \fBrazor\-whitelist\fR\|(5)
.SH LICENSE
.IX Header "LICENSE"
This is free software, distributed under the Artistic License 2.0.