← Back to branch summary

~ubuntu-branches/ubuntu/feisty/clamav/feisty

« back to all changes in this revision

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

  • Committer: Bazaar Package Importer
  • Author(s): Kees Cook
  • Date: 2007-02-20 10:33:44 UTC
  • mfrom: (0.7.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20070220103344-yrxzd2x7lhee3r02
Tags: 0.90-1ubuntu1
* Merge from debian unstable, remaining changes:
  - debian/clamav-base.init-stub, debian/clamav-daemon.init,
    debian/rules: init script stub for common setup functions.
  - debian/control: Maintainers updated for Ubuntu.

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/man/freshclam.conf.5.in
1
 
.\" Manual page created by Magnus Ekdahl and Thomas Lamy
2
 
.TH "freshclam.conf" "5" "September 27, 2004" "Thomas Lamy" "Clam AntiVirus"
 
1
.TH "freshclam.conf" "5" "February 12, 2007" "ClamAV 0.90" "Clam AntiVirus"
3
2
.SH "NAME"
4
3
.LP 
5
 
\fBfreshclam.conf\fR \- Configuration file for Clam AntiVirus Database Updater
 
4
\fBfreshclam.conf\fR \- Configuration file for Clam AntiVirus database update tool
6
5
.SH "DESCRIPTION"
7
6
.LP 
8
7
The file freshclam.conf configures the Clam AntiVirus Database Updater, freshclam(1).
9
8
.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:
 
9
The file consists of comments and options with arguments. Each line which starts with a hash (\fB#\fR) symbol is ignored by the parser. Options and arguments are case sensitive and of the form \fBOption Argument\fR. The arguments are of the following types:
 
10
.TP
 
11
\fBBOOL\fR 
 
12
Boolean value (yes/no or true/false or 1/0).
11
13
.TP 
12
14
\fBSTRING\fR
13
15
String without blank characters.
29
31
.br 
30
32
Default: @CLAMAVUSER@
31
33
.TP 
32
 
\fBAllowSupplementaryGroups\fR
 
34
\fBAllowSupplementaryGroups BOOL\fR
33
35
Initialize supplementary group access (freshclam must be started by root).
34
36
.br 
35
37
Default: disabled
39
41
.br 
40
42
Default: @DBDIR@
41
43
.TP 
42
 
\fBChecks NUM\fR
 
44
\fBChecks NUMBER\fR
43
45
Number of database checks per day.
44
46
.br 
45
47
Default: 12
49
51
.br 
50
52
Default: disabled.
51
53
.TP 
52
 
\fBLogSyslog\fR
 
54
\fBLogSyslog BOOL\fR
53
55
Enable logging to Syslog. May be used in combination with UpdateLogFile.
54
56
.br 
55
57
Default: disabled.
56
58
.TP 
57
 
\fBLogFacility\fR
 
59
\fBLogFacility STRING\fR
58
60
Specify the type of syslog messages \- please refer to 'man syslog' for facility names.
59
61
.br 
60
62
Default: LOG_LOCAL6
61
63
.TP 
62
 
\fBPidFile\fR
63
 
This option allows you to save the process identifier of the daemon.
 
64
\fBPidFile STRING\fR
 
65
This option allows you to save the process identifier of the daemon to a file specified in the argument.
64
66
.br 
65
67
Default: disabled
66
68
.TP 
67
 
\fBLogVerbose\fR
 
69
\fBLogVerbose BOOL\fR
68
70
Enable verbose logging.
69
71
.br 
70
72
Default: disabled
71
73
.TP 
72
74
\fBDNSDatabaseInfo STRING\fR
73
 
This directive enables database and software version verification through DNS TXT records.
 
75
This directive enables database and software version checks through DNS TXT records.
74
76
.br 
75
77
Default: enabled, pointing to current.cvd.clamav.net
76
78
.TP 
79
81
.br 
80
82
Default: database.clamav.net
81
83
.TP 
82
 
\fBMaxAttempts NUM\fR
83
 
Freshclam(1) tries every mirror this number of times before switching to the next mirror.
 
84
\fBMaxAttempts NUMBER\fR
 
85
How many attempts (per mirror) to make before giving up.
84
86
.br .
85
87
Default: 3 (per mirror)
86
88
.TP 
87
 
\fBHTTPProxyServer STR\fR, \fBHTTPProxyPort NUM\fR
 
89
\fBScriptedUpdates BOOL\fR
 
90
With this option you can control scripted updates. It's highly recommended to keep it enabled.
 
91
.br .
 
92
Default: enabled
 
93
.TP 
 
94
\fBHTTPProxyServer STR\fR, \fBHTTPProxyPort NUMBER\fR
88
95
Use given proxy server and TCP port for database downloads.
89
96
.TP 
90
 
\fBHTTPProxyUsername STR\fR,\fBHTTPProxyPassword STR\fR
 
97
\fBHTTPProxyUsername STR\fR,\fBHTTPProxyPassword STRING\fR
91
98
Proxy usage is authenticated through given username and password.
92
99
.br .
93
100
Default: no proxy authentication
102
109
.br .
103
110
Default: Use OS\'es default outgoing IP address.
104
111
.TP 
105
 
\fBNotifyClamd \[STRING\]\fR
106
 
Notify a running clamd(8) to reload its database after a download has occurred. Optionally a clamd.conf(5) file location may be given to tell freshclam(1) how to communicate with clamd(8).
 
112
\fBNotifyClamd STRING\fR
 
113
Notify a running clamd(8) to reload its database after a download has occurred. The path for clamd.conf file must be provided.
107
114
.br .
108
115
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.
109
116
.TP 
122
129
.br 
123
130
Default: disabled
124
131
.TP
125
 
\fBConnectTimeout\fR
 
132
\fBConnectTimeout NUMBER\fR
126
133
Timeout in seconds when connecting to database server.
127
134
.br 
128
135
Default: 10
129
136
.TP
130
 
\fBReceiveTimeout\fR
 
137
\fBReceiveTimeout NUMER\fR
131
138
Timeout in seconds when reading from database server.
132
139
.br 
133
140
Default: 30
134
 
.SH "NOTE"
135
 
While not reasonable, any configuration option from clamd.conf(5) may be given.
136
141
.SH "FILES"
137
142
.LP 
138
143
@CFGDIR@/freshclam.conf
139
144
.SH "AUTHOR"
140
145
.LP 
141
 
Thomas Lamy <thomas.lamy@netwake.de>
 
146
Thomas Lamy <thomas.lamy@netwake.de>, Tomasz Kojm <tkojm@clamav.net>
142
147
.SH "SEE ALSO"
143
148
.LP 
144
 
freshclam(1), clamd.conf(5), clamd(8), clamscan(1)
 
149
freshclam(1), clamd.conf(5), clamd(8), clamav-milter(8), clamscan(1)
145
150