.\" -*- 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-AGENTS 1"
.TH RAZOR-AGENTS 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\-Agents \- Collection of files for checking, reporting, and revoking 
spam
.SH DESCRIPTION
.IX Header "DESCRIPTION"
Vipul's Razor is a distributed, collaborative, spam detection, reporting, and filtering 
network. The primary focus of the system is to identify and remove all email 
spam from the internet.  Visit the website at http://razor.sourceforge.net/.
.SH USAGE
.IX Header "USAGE"
First a razorhome directory should be created where log, conf, and cached server 
information will live.  This is done via \f(CW\*(C`\-create\*(C'\fR option to \fBrazor\-admin\fR\|(1).
See man page for details.
.PP
You can immediately check spam using \fBrazor\-check\fR\|(1). 
See man page for details.
.PP
To report spam, an identity must be registered.  This is done via \f(CW\*(C`\-register\*(C'\fR
option to \fBrazor\-admin\fR\|(1).  After that, \fBrazor\-report\fR\|(1)
and \fBrazor\-revoke\fR\|(1) will work flawlessly.
.SH CONFIGURATION
.IX Header "CONFIGURATION"
All Razor-Agents share a configuration file.  The contents of the 
configuration file are detailed in the \fBrazor\-agent.conf\fR\|(5) manpage.
.PP
Config file is computed before razorhome, in the following order:
.PP
.Vb 4
\& \-conf=/path/file.conf           used if readable, else
\& <home>/.razor/razor\-agent.conf  used if readable, else
\& /etc/razor/razor\-agent.conf     used if readable, else
\& all defaults are used.
.Ve
.PP
To see configuration defaults, do
  razor-admin \-create \-conf=/tmp/razor2\-defaults.conf
.SH RAZORHOME
.IX Header "RAZORHOME"
All Razor-Agents also share a razorhome directory, where identity, logging, 
and cached information about servers is stored.
Razorhome is computed after configuration file, in the following order.
.PP
.Vb 5
\& \-home=/tmp/razor/                     used if readable, else
\& \*(Aqrazorhome\*(Aq from configuration file   used if readable, else
\& <home>/.razor/                        used if readable, else
\& <home>/.razor/                        is created.  if that fails, 
\&                                       no razorhome.
\&
\&
\& NOTE: If there is no razorhome, razor\-report and razor\-revoke will 
\&       not work unless you specify  \-ident=/path/identity 
\&       razor\-check will still work.
.Ve
.SH FILES
.IX Header "FILES"
Besides those listed at the end with their own manpages, Razor Agents 
also has the following files.
.IP \fBrazorhome/identity\fR 4
.IX Item "razorhome/identity"
Usually a symlink to identity file containing user+pass.
Used by \fBrazor\-report\fR\|(1) and \fBrazor\-revoke\fR\|(1).
.IP \fBrazorhome/razor\-agent.log\fR 4
.IX Item "razorhome/razor-agent.log"
Default log file.  To change, edit \fBrazor\-agent.conf\fR\|(5).
.IP \fBrazorhome/servers.*.lst\fR 4
.IX Item "razorhome/servers.*.lst"
Cached list of Razor Servers.  If more than one, they are ordered
by closest ping time.
.IP \fBrazorhome/server.<name>.lst\fR 4
.IX Item "razorhome/server.<name>.lst"
Cached info for <name> server. The \f(CW\*(C`srl\*(C'\fR key in this file
is compared against the server greeting, and if server's is greater,
new cache info is retrieved from the server.
.SH EXAMPLES
.IX Header "EXAMPLES"
.IP "razor-check \-d \-debuglevel=9 mbox" 4
.IX Item "razor-check -d -debuglevel=9 mbox"
Checks spam in mbox.  prints numbers for those found to be spam.
\&\-d logs to stdout, \-debuglevel=9 is verbose logging
.IP "razor-admin \-create \-home=/home/chad/.razor \-d \-s" 4
.IX Item "razor-admin -create -home=/home/chad/.razor -d -s"
Creates razorhome in /home/chad/.razor, log to stdout, does not connect to server (\-s simulate).
.IP "razor-report spam \-debuglevel=0" 4
.IX Item "razor-report spam -debuglevel=0"
sends spam to server, with no log msgs.
.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\-agent.conf\fR\|(5), \fBrazor\-check\fR\|(1), \fBrazor\-admin\fR\|(1), 
\&\fBrazor\-report\fR\|(1), \fBrazor\-revoke\fR\|(1), \fBrazor\-whitelist\fR\|(5)