????
| Current Path : /usr/src/razor-agents-2.85/blib/man5/ |
| Current File : //usr/src/razor-agents-2.85/blib/man5/razor-agent.conf.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-AGENT.CONF 1"
.TH RAZOR-AGENT.CONF 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\-agent.conf" \- Configuration file for Razor Agents
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\f(CW\*(C`razor\-agent.conf\*(C'\fR is a configuration file read by the razor agents,
which include \fIrazor\-check\fR\|(1), \fIrazor\-admin\fR\|(1), \fIrazor\-report\fR\|(1), and
\&\fIrazor\-revoke\fR\|(1). The format is \*(L"attribute = value\*(R" pairs, one pair per
line. Lines that begin with `#' are treated as comments.
.SH "ATTRIBUTES"
.IX Header "ATTRIBUTES"
Following attributes can be specified:
.IP "\fBrazorhome\fR" 4
.IX Item "razorhome"
Directory where Razor Agents look for files. All files in \f(CW\*(C`razor\-agent.conf\*(C'\fR
without a full path will be relative to \f(CW\*(C`razorhome\*(C'\fR.
The default is \f(CW\*(C`/etc/razor/\*(C'\fR for root, and \f(CW\*(C`~/.razor/\*(C'\fR for every other
user. If \f(CW\*(C`razorhome\*(C'\fR does not exist, it will be created.
.IP "\fBlogfile\fR" 4
.IX Item "logfile"
Log file for the Razor Agents. The default is \f(CW\*(C`razor\-agent.log\*(C'\fR.
.IP "\fBdebuglevel\fR" 4
.IX Item "debuglevel"
Controls the amount of messages written to logfile. It is an integer between
0 and 20. For Example, a value of \f(CW1\fR logs only startup
and error messages, \f(CW5\fR includes every transaction with the server,
and \f(CW14\fR is extremely verbose information intended for debugging use only.
\&\s-1NOTE: \s0\f(CW15\fR and higher create debug files on your filesystem \*(-- do not use unless you
know what you are doing.
The default is \f(CW5\fR.
.IP "\fBidentity\fR" 4
.IX Item "identity"
Specify an identify file to use for storing a newly registered identity
during \fIrazor\-admin\fR\|(1). For \fIrazor\-report\fR\|(1) and \fIrazor\-revoke\fR\|(1),
use this identity when authenticating with Razor Servers.
If not specified, \f(CW\*(C`<razorhome>/identity\-<user>\*(C'\fR is used.
.IP "\fBlistfile_nomination\fR" 4
.IX Item "listfile_nomination"
File where Razor Nomination Servers are listed, in order of closest
\&\s-1TCP\s0 ping time. Nomination Servers are used by \fIrazor\-report\fR\|(1) and \fIrazor\-revoke\fR\|(1).
This file is created automatically.
The default is \f(CW\*(C`servers.nomination.lst\*(C'\fR.
.IP "\fBlistfile_catalogue\fR" 4
.IX Item "listfile_catalogue"
File where Razor Catalogue Servers are listed, in order of closest
\&\s-1TCP\s0 ping time. Catalogue Servers are used by \fIrazor\-check\fR\|(1).
This file is created automatically.
The default is \f(CW\*(C`servers.catalogue.lst\*(C'\fR.
.IP "\fBlistfile_discovery\fR" 4
.IX Item "listfile_discovery"
File where Razor Discovery Servers are listed, in random order.
This file is created automatically using \s-1DNS.\s0
The default is \f(CW\*(C`servers.discovery.lst\*(C'\fR.
.IP "\fBrediscovery_wait_dns\fR" 4
.IX Item "rediscovery_wait_dns"
Max time in seconds Razor Agents will wait before computing a new
\&\f(CW\*(C`listfile_discovery\*(C'\fR using \s-1DNS.\s0
The default is \f(CW604800\fR, which is 7 days.
.IP "\fBrediscovery_wait\fR" 4
.IX Item "rediscovery_wait"
Max time in seconds Razor Agents will wait before computing a new
\&\f(CW\*(C`listfile_nomination\*(C'\fR and a new \f(CW\*(C`listfile_catalogue\*(C'\fR.
The default is \f(CW172800\fR, which is 2 days.
.IP "\fBturn_off_discovery\fR" 4
.IX Item "turn_off_discovery"
Turns off closest host discovery. When set to 1, \f(CW\*(C`listfile_catalogue\*(C'\fR
and \f(CW\*(C`listfile_nomination\*(C'\fR will not be updated and \f(CW\*(C`listfile_discovery\*(C'\fR
is not read or updated. The default is \f(CW0\fR.
.IP "\fBignorelist\fR" 4
.IX Item "ignorelist"
Automatically ignore mailing list posts. If set to \f(CW0\fR, mailing
list posts will be handled like all other mail.
The default is \f(CW0\fR.
.IP "\fBwhitelist\fR" 4
.IX Item "whitelist"
Name of whitelist file. Razor Agents can consult a whitelist of addresses
and \s-1SHA1\s0 hashes before checking a mail with Razor Servers.
If the address/hash is found on the whitelist, the mail is marked `not spam',
without checking against the server. The format of the whitelist can be found in
\&\fIrazor\-whitelist\fR\|(5) manpage. The default is \f(CW\*(C`razor\-whitelist\*(C'\fR.
.IP "\fBmin_cf\fR" 4
.IX Item "min_cf"
When checking spam, the server optionally returns a spam confidence value
ranging from 0 (not confident) to 100 (absolutely or 100% confident).
To be considered spam, the server's spam confidence value must be greater
than or equal to \f(CW\*(C`min_cf\*(C'\fR. \f(CW\*(C`min_cf\*(C'\fR can be a number or an expression containing
ac, the average confidence published by a Razor Server. Examples: 0, 60,
100, ac, ac + 10, ac \- 20. If an expression evaluates to less than 0 it
becomes 0, likewise those greater than 100 become 100.
The default is \f(CW\*(C`ac\*(C'\fR.
.IP "\fBreport_headers\fR" 4
.IX Item "report_headers"
When reporting spam, the entire email (headers and body) is sent to
a Razor Nomination Server. When set to \f(CW0\fR, all the headers are
removed except headers beginning with \f(CW\*(C`Content\-\*(C'\fR before sending,
and a special header beginning with \f(CW\*(C`X\-Razor2\*(C'\fR is added to note this action.
The default is \f(CW1\fR.
.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\-agents\fR\|(1), \fIrazor\-check\fR\|(1), \fIrazor\-admin\fR\|(1),
\&\fIrazor\-report\fR\|(1), \fIrazor\-revoke\fR\|(1), \fIrazor\-whitelist\fR\|(5)