~ubuntu-branches/ubuntu/breezy/clamav/breezy-backports

« back to all changes in this revision

Viewing changes to docs/man/freshclam.conf.5.in

  • Committer: Bazaar Package Importer
  • Author(s): Stephen Gran
  • Date: 2005-09-19 09:05:59 UTC
  • mfrom: (1.1.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20050919090559-hikpqduq8yx5qxo2
Tags: 0.87-1
* New upstream version
  - Fixes CAN-2005-2920 and CAN-2005-2919 (closes: #328660)
* New logcheck line for clamav-daemon (closes: #323132)
* relibtoolize and apply kfreebsd patch (closes: #327707)
* Make sure init.d script starts freshclam up again after upgrade when run
  from if-up.d (closes: #328912)

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
.\" Manual page created by Magnus Ekdahl and Thomas Lamy
 
2
.TH "freshclam.conf" "5" "September 27, 2004" "Thomas Lamy" "Clam AntiVirus"
 
3
.SH "NAME"
 
4
.LP 
 
5
\fBfreshclam.conf\fR \- Configuration file for Clam AntiVirus Database Updater
 
6
.SH "DESCRIPTION"
 
7
.LP 
 
8
The file freshclam.conf configures the Clam AntiVirus Database Updater, freshclam(1).
 
9
.SH "FILE FORMAT"
 
10
The file consists of comments and options with arguments. Each line that starts with a hash (\fB#\fR) symbol is a comment. Options and arguments are case sensitive and of the form \fBOption Argument\fR. The (possibly optional) arguments are of the following types:
 
11
.TP 
 
12
\fBSTRING\fR
 
13
String without blank characters.
 
14
.TP 
 
15
\fBSIZE\fR
 
16
Size in bytes. You can use 'M' or 'm' modifiers for megabytes and 'K' or 'k' for kilobytes.
 
17
.TP 
 
18
\fBNUMBER\fR
 
19
Unsigned integer.
 
20
.SH "DIRECTIVES"
 
21
.LP 
 
22
When an option is not used (hashed or doesn't exist in the configuration file) freshclam takes a default action.
 
23
.TP 
 
24
\fBExample\fR
 
25
If this option is set freshclam will not run.
 
26
.TP 
 
27
\fBDatabaseOwner STRING\fR
 
28
When started by root, drop privileges to a specified user. 
 
29
.br 
 
30
Default: @CLAMAVUSER@
 
31
.TP 
 
32
\fBAllowSupplementaryGroups\fR
 
33
Initialize supplementary group access (freshclam must be started by root).
 
34
.br 
 
35
Default: disabled
 
36
.TP 
 
37
\fBDatabaseDirectory STRING\fR
 
38
Path to a directory containing database files.
 
39
.br 
 
40
Default: @DBDIR@
 
41
.TP 
 
42
\fBChecks NUM\fR
 
43
Number of database checks per day.
 
44
.br 
 
45
Default: 12
 
46
.TP 
 
47
\fBUpdateLogFile STRING\fR
 
48
Enable logging to a specified file. Highly recommended.
 
49
.br 
 
50
Default: disabled.
 
51
.TP 
 
52
\fBLogSyslog\fR
 
53
Enable logging to Syslog. May be used in combination with UpdateLogFile.
 
54
.br 
 
55
Default: disabled.
 
56
.TP 
 
57
\fBLogFacility\fR
 
58
Specify the type of syslog messages \- please refer to 'man syslog' for facility names.
 
59
.br 
 
60
Default: LOG_LOCAL6
 
61
.TP 
 
62
\fBPidFile\fR
 
63
This option allows you to save the process identifier of the daemon.
 
64
.br 
 
65
Default: disabled
 
66
.TP 
 
67
\fBLogVerbose\fR
 
68
Enable verbose logging.
 
69
.br 
 
70
Default: disabled
 
71
.TP 
 
72
\fBDNSDatabaseInfo STRING\fR
 
73
This directive enables database and software version verification through DNS TXT records.
 
74
.br 
 
75
Default: enabled, pointing to current.cvd.clamav.net
 
76
.TP 
 
77
\fBDatabaseMirror STRING\fR
 
78
Server name where database updates are downloaded from. In order to download the database from the closest mirror you should configure freshclam to use db.xy.clamav.net where xy represents your country code. If this option is given multiple times, freshclam(1) tries them in the order given. It's strongly recommended that you use db.xy.clamav.net as the first mirror and database.clamav.net as the second.
 
79
.br 
 
80
Default: database.clamav.net
 
81
.TP 
 
82
\fBMaxAttempts NUM\fR
 
83
Freshclam(1) tries every mirror this number of times before switching to the next mirror.
 
84
.br .
 
85
Default: 3 (per mirror)
 
86
.TP 
 
87
\fBHTTPProxyServer STR\fR, \fBHTTPProxyPort NUM\fR
 
88
Use given proxy server and TCP port for database downloads.
 
89
.TP 
 
90
\fBHTTPProxyUsername STR\fR,\fBHTTPProxyPassword STR\fR
 
91
Proxy usage is authenticated through given username and password.
 
92
.br .
 
93
Default: no proxy authentication
 
94
.TP 
 
95
\fBLocalIPAddress IP\fR
 
96
Use \fBIP\fR as client address for downloading databases. Useful for multi homed systems.
 
97
.br .
 
98
Default: Use OS\'es default outgoing IP address.
 
99
.TP 
 
100
\fBNotifyClamd STRING\fR
 
101
Notify a running clamd(8) to reload it\'s database after a download has occured. Optionally a clamd.conf(5) file location may be given to tell freshclam(1) how to communicate with clamd(8).
 
102
.br .
 
103
Default: The default is to not notify clamd. See clamd.conf(5)\'s option SelfCheck for how clamd(8) handles database updates in this case.
 
104
.TP 
 
105
\fBOnUpdateExecute STRING\fR
 
106
Execute this command after the database has been successfully updated.
 
107
.br 
 
108
Default: disabled
 
109
.TP 
 
110
\fBOnErrorExecute STRING\fR
 
111
Execute this command after a database update has failed.
 
112
.br 
 
113
Default: disabled
 
114
.SH "NOTE"
 
115
While not reasonable, any configuration option from clamd.conf(5) may be given.
 
116
.SH "FILES"
 
117
.LP 
 
118
@CFGDIR@/freshclam.conf
 
119
.SH "AUTHOR"
 
120
.LP 
 
121
Thomas Lamy <thomas.lamy@netwake.de>
 
122
.SH "SEE ALSO"
 
123
.LP 
 
124
freshclam(1), clamd.conf(5), clamd(8), clamscan(1)
 
125