????
| Current Path : /usr/src/razor-agents-2.85/blib/man5/ |
| Current File : //usr/src/razor-agents-2.85/blib/man5/razor-agents.5 |
.\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)
.\"
.\" 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
..
.\" Set up some character translations and predefined strings. \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote. \*(C+ will
.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
. ds -- \(*W-
. ds PI pi
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
. ds L" ""
. ds R" ""
. ds C` ""
. ds C' ""
'br\}
.el\{\
. ds -- \|\(em\|
. ds PI \(*p
. ds L" ``
. ds R" ''
. 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 turned on, 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
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff
.if n \{\
. ds #H 0
. ds #V .8m
. ds #F .3m
. ds #[ \f1
. ds #] \fP
.\}
.if t \{\
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
. ds #V .6m
. ds #F 0
. ds #[ \&
. ds #] \&
.\}
. \" simple accents for nroff and troff
.if n \{\
. ds ' \&
. ds ` \&
. ds ^ \&
. ds , \&
. ds ~ ~
. ds /
.\}
.if t \{\
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
. \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
. \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
. \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
. ds : e
. ds 8 ss
. ds o a
. ds d- d\h'-1'\(ga
. ds D- D\h'-1'\(hy
. ds th \o'bp'
. ds Th \o'LP'
. ds ae ae
. ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "RAZOR-AGENTS 1"
.TH RAZOR-AGENTS 1 "2008-07-21" "perl v5.16.3" "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 \fIrazor\-admin\fR\|(1).
See man page for details.
.PP
You can immediately check spam using \fIrazor\-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 \fIrazor\-admin\fR\|(1). After that, \fIrazor\-report\fR\|(1)
and \fIrazor\-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 \fIrazor\-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 \fIrazor\-report\fR\|(1) and \fIrazor\-revoke\fR\|(1).
.IP "\fBrazorhome/razor\-agent.log\fR" 4
.IX Item "razorhome/razor-agent.log"
Default log file. To change, edit \fIrazor\-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"
\&\fIrazor\-agent.conf\fR\|(5), \fIrazor\-check\fR\|(1), \fIrazor\-admin\fR\|(1),
\&\fIrazor\-report\fR\|(1), \fIrazor\-revoke\fR\|(1), \fIrazor\-whitelist\fR\|(5)