← Back to branch summary

~ubuntu-branches/ubuntu/saucy/clamav/saucy-backports

« back to all changes in this revision

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

  • Committer: Package Import Robot
  • Author(s): Scott Kitterman
  • Date: 2014-07-15 01:08:10 UTC
  • mfrom: (0.35.47 sid)
  • Revision ID: package-import@ubuntu.com-20140715010810-ru66ek4fun2iseba
Tags: 0.98.4+dfsg-2~ubuntu13.10.1
https://launchpad.net/bugs/1341962
No-change backport to saucy (LP: #1341962)

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/man/freshclam.conf.5.in
1
 
.TH "freshclam.conf" "5" "February 12, 2007" "ClamAV @VERSION@" "Clam AntiVirus"
 
1
.TH "freshclam.conf" "5" "December 4, 2013" "ClamAV @VERSION@" "Clam AntiVirus"
2
2
.SH "NAME"
3
3
.LP 
4
4
\fBfreshclam.conf\fR \- Configuration file for Clam AntiVirus database update tool
25
25
.TP 
26
26
\fBExample\fR
27
27
If this option is set freshclam will not run.
28
 
.TP 
29
 
\fBDatabaseOwner STRING\fR
30
 
When started by root, drop privileges to a specified user. 
31
 
.br 
32
 
Default: @CLAMAVUSER@
33
 
.TP 
34
 
\fBAllowSupplementaryGroups BOOL\fR
35
 
Initialize supplementary group access (freshclam must be started by root).
36
 
.br 
37
 
Default: disabled
38
 
.TP 
39
 
\fBDatabaseDirectory STRING\fR
40
 
Path to a directory containing database files.
41
 
.br 
42
 
Default: @DBDIR@
43
 
.TP 
44
 
\fBChecks NUMBER\fR
45
 
Number of database checks per day.
46
 
.br 
47
 
Default: 12
48
 
.TP 
49
 
\fBUpdateLogFile STRING\fR
50
 
Enable logging to a specified file. Highly recommended.
51
 
.br 
52
 
Default: disabled.
53
28
.TP
54
29
\fBLogFileMaxSize SIZE\fR
55
30
Limit the size of the log file. The logger will be automatically disabled if the file is greater than SIZE. Value of 0 disables the limit.
56
31
.br
57
 
Default: 1M
58
 
.TP 
 
32
Default: 1M 
 
33
.TP
 
34
\fBLogTime BOOL\fR
 
35
Log time with each message.
 
36
.br
 
37
Default: no
 
38
.TP
59
39
\fBLogSyslog BOOL\fR
60
40
Enable logging to Syslog. May be used in combination with UpdateLogFile.
61
41
.br 
66
46
.br 
67
47
Default: LOG_LOCAL6
68
48
.TP 
 
49
\fBLogVerbose BOOL\fR
 
50
Enable verbose logging.
 
51
.br 
 
52
Default: disabled
 
53
.TP
 
54
\fBLogRotate BOOL\fR
 
55
Rotate log file. Requires LogFileMaxSize option set prior to this option.
 
56
.br
 
57
Default: no
 
58
.TP 
69
59
\fBPidFile STRING\fR
70
60
This option allows you to save the process identifier of the daemon to a file specified in the argument.
71
61
.br 
72
62
Default: disabled
73
63
.TP 
74
 
\fBLogVerbose BOOL\fR
75
 
Enable verbose logging.
 
64
\fBDatabaseDirectory STRING\fR
 
65
Path to a directory containing database files.
 
66
.br 
 
67
Default: @DBDIR@
 
68
.TP
 
69
\fBForeground BOOL\fR
 
70
Don't fork into background.
 
71
.br
 
72
Default: no
 
73
.TP
 
74
\fBDebug BOOL\fR
 
75
Enable debug messages in libclamav.
 
76
.br
 
77
Default: no
 
78
.TP 
 
79
\fBAllowSupplementaryGroups BOOL\fR
 
80
Initialize supplementary group access (freshclam must be started by root).
76
81
.br 
77
82
Default: disabled
78
83
.TP 
 
84
\fBUpdateLogFile STRING\fR
 
85
Enable logging to a specified file. Highly recommended.
 
86
.br 
 
87
Default: disabled.
 
88
.TP 
 
89
\fBDatabaseOwner STRING\fR
 
90
When started by root, drop privileges to a specified user. 
 
91
.br 
 
92
Default: @CLAMAVUSER@
 
93
.TP 
 
94
\fBChecks NUMBER\fR
 
95
Number of database checks per day.
 
96
.br 
 
97
Default: 12
 
98
.TP 
79
99
\fBDNSDatabaseInfo STRING\fR
80
 
This directive enables database and software version checks through DNS TXT records.
 
100
Use DNS to verify the virus database version. Freshclam uses DNS TXT records to verify the versions of the database and software itself. With this directive you can change the database verification domain.
 
101
.br
 
102
\fBWARNING:\fR Please don't change it unless you're configuring freshclam to use your own database verification domain.
81
103
.br 
82
104
Default: enabled, pointing to current.cvd.clamav.net
83
105
.TP 
84
106
\fBDatabaseMirror STRING\fR
85
 
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.
 
107
DatabaseMirror specifies to which mirror(s) freshclam should connect. You should have at least two entries: db.XY.clamav.net (or db.XY.ipv6.clamav.net for IPv6) and database.clamav.net (in this order). Please replace XY with your country code (see http://www.iana.org/cctld/cctld-whois.htm). database.clamav.net is a round-robin record which points to our most reliable mirrors. It's used as a fall back in case db.XY.clamav.net is not working.
86
108
.br 
87
109
Default: database.clamav.net
88
110
.TP 
 
111
\fBPrivateMirror STR\fR
 
112
This option allows you to easily point freshclam to private mirrors. If PrivateMirror is set, freshclam does not attempt to use DNS to determine whether its databases are out-of-date, instead it will use the If-Modified-Since request or directly check the headers of the remote database files. For each database, freshclam first attempts to download the CLD file. If that fails, it tries to download the CVD file. This option overrides DatabaseMirror, DNSDatabaseInfo and ScriptedUpdates. It can be used multiple times to provide fall-back mirrors.
 
113
.br 
 
114
Default: disabled
 
115
.TP 
89
116
\fBMaxAttempts NUMBER\fR
90
117
How many attempts (per mirror) to make before giving up.
91
118
.br .
94
121
\fBScriptedUpdates BOOL\fR
95
122
With this option you can control scripted updates. It's highly recommended to keep it enabled.
96
123
.br .
97
 
Default: enabled
 
124
Default: yes
98
125
.TP 
99
126
\fBTestDatabases BOOL\fR
100
127
With this option enabled, freshclam will attempt to load new databases into memory to make sure they are properly handled by libclamav before replacing the old ones.
105
132
By default freshclam will keep the local databases (.cld) uncompressed to make their handling faster. With this option you can enable the compression; the change will take effect with the next database update.
106
133
.br 
107
134
Default: no
 
135
.TP
 
136
\fBExtraDatabase STRING\fR
 
137
Download an additional 3rd party signature database distributed through the ClamAV mirrors. This option can be used multiple times. Here you can find a list of available databases: http://www.clamav.net/download/cvd/3rdparty
 
138
.br
 
139
Default: disabled
108
140
.TP 
109
 
\fBDatabaseCustomURL STR\fR
 
141
\fBDatabaseCustomURL STRING\fR
110
142
With this option you can provide custom sources (http:// or file://) for database files. This option can be used multiple times.
111
143
.br 
112
 
Default: no custom URLs
113
 
.TP 
114
 
\fBPrivateMirror STR\fR
115
 
This option allows you to easily point freshclam to private mirrors. If PrivateMirror is set, freshclam does not attempt to use DNS to determine whether its databases are out-of-date, instead it will use the If-Modified-Since request or directly check the headers of the remote database files. For each database, freshclam first attempts to download the CLD file. If that fails, it tries to download the CVD file. This option overrides DatabaseMirror, DNSDatabaseInfo and ScriptedUpdates. It can be used multiple times to provide fall-back mirrors.
116
 
.br 
117
144
Default: disabled
118
145
.TP 
119
146
\fBHTTPProxyServer STR\fR, \fBHTTPProxyPort NUMBER\fR
122
149
\fBHTTPProxyUsername STR\fR,\fBHTTPProxyPassword STRING\fR
123
150
Proxy usage is authenticated through given username and password.
124
151
.br .
125
 
Default: no proxy authentication
 
152
Default: disabled
126
153
.TP 
127
154
\fBHTTPUserAgent STRING\fR
128
155
If your servers are behind a firewall/proxy which applies User-Agent filtering, you can use this option to force the use of a different User-Agent header.
129
156
.br .
130
157
Default: clamav/version_number
131
158
.TP 
132
 
\fBLocalIPAddress IP\fR
133
 
Use \fBIP\fR as client address for downloading databases. Useful for multi homed systems.
134
 
.br .
135
 
Default: Use OS\'es default outgoing IP address.
136
 
.TP 
137
159
\fBNotifyClamd STRING\fR
138
160
Notify a running clamd(8) to reload its database after a download has occurred. The path for clamd.conf file must be provided.
139
161
.br .
140
 
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.
 
162
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.
141
163
.TP 
142
164
\fBOnUpdateExecute STRING\fR
143
165
Execute this command after the database has been successfully updated.
144
166
.br 
145
167
Default: disabled
 
168
.TP
 
169
\fBOnErrorExecute STRING\fR
 
170
Execute this command after a database update has failed.
 
171
.br 
 
172
Default: disabled
146
173
.TP 
147
174
\fBOnOutdatedExecute STRING\fR
148
175
Execute this command when freshclam reports outdated version. In the command string %v will be replaced by the new version number.
149
176
.br 
150
177
Default: disabled
151
 
.TP
152
 
\fBOnErrorExecute STRING\fR
153
 
Execute this command after a database update has failed.
154
 
.br 
155
 
Default: disabled
 
178
.TP 
 
179
\fBLocalIPAddress IP\fR
 
180
Use \fBIP\fR as client address for downloading databases. Useful for multi homed systems.
 
181
.br .
 
182
Default: Use OS'es default outgoing IP address.
156
183
.TP
157
184
\fBConnectTimeout NUMBER\fR
158
185
Timeout in seconds when connecting to database server.
193
220
@CFGDIR@/freshclam.conf
194
221
.SH "AUTHOR"
195
222
.LP 
196
 
Thomas Lamy <thomas.lamy@netwake.de>, Tomasz Kojm <tkojm@clamav.net>
 
223
Thomas Lamy <thomas.lamy@netwake.de>, Tomasz Kojm <tkojm@clamav.net>, Kevin Lin <klin@sourcefire.com>
197
224
.SH "SEE ALSO"
198
225
.LP 
199
226
freshclam(1), clamd.conf(5), clamd(8), clamscan(1)