freshclam(1)

1freshclam(1)                    Clam AntiVirus                    freshclam(1)
2
3
4

NAME

6       freshclam - update virus databases
7

SYNOPSIS

9       freshclam [options]
10

DESCRIPTION

12       freshclam is a virus database update tool for ClamAV.
13

OPTIONS

15       Freshclam reads its configuration from freshclam.conf. The settings can
16       be overwritten with command line options.
17
18       -h, --help
19              Output help information and exit.
20
21       -V, --version
22              Print version number and exit.
23
24       -v, --verbose
25              Be verbose. This option causes freshclam  to  print  much  addi‐
26              tional information.
27
28       --quiet
29              Be quiet - output only error messages.
30
31       --no-warnings
32              Don't print and log warnings.
33
34       -v, --debug
35              Enable debug messages from LibClamAV.
36
37       --stdout
38              Write all messages to stdout.
39
40       -l FILE, --log=FILE
41              Write download report to FILE.
42
43       --datadir=DIRECTORY
44              Install  new  database  in  DIRECTORY.  The  directory  must  be
45              writable for the '' user or unprivileged user running freshclam.
46
47       -u USER, --user USER
48              Run as USER. By default (when started by root)  freshclam  drops
49              privileges and operates as the '' user.
50
51       -d, --daemon
52              Run  in  a daemon mode. This option requires --checks.  -p FILE,
53              --pid=FILE Write daemon's pid to FILE.
54
55       --no-dns
56              This option forces old non-DNS verification  method  (without  a
57              TTL delay).
58
59       -c #n, --checks=#n
60              Check  #n times per day for a new database. #n must be between 1
61              and 50.
62
63       --daemon-notify=/path/to/clamd.conf
64              Notify the daemon about the new database. By default it reads  a
65              hardcoded  config  file  but  you  can use a different one. Both
66              local and TCP sockets are supported.
67
68       -a IP, --local-address=IP
69              Use (local) IP for HTTP downloads. Useful for  multi-homed  sys‐
70              tems.  If binding fails for whatever reason, a warning is issued
71              and freshclam behaves like without this flag.
72
73       --on-error-execute=COMMAND
74              Execute COMMAND if error occurred. Remember, that virus database
75              freshness is the most important thing in anti-virus system. With
76              this option freshclam can alert you (eg. send  SMS)  when  some‐
77              thing is going wrong.
78
79       --on-update-execute=COMMAND
80              Execute COMMAND after successful update.
81
82       --on-outdated-execute=COMMAND
83              Execute  COMMAND when freshclam reports outdated version. In the
84              command string %v will be replaced by the new version number.
85
86       --list-mirrors
87              Print mirror details from mirrors.dat (cache file for the mirror
88              manager).
89
90       --submit-stats[=/path/to/clamd.conf]
91              Upload  detection  statistics  to the ClamAV Project (see fresh‐
92              clam.conf(5):SubmitDetectionStats for more details). No database
93              update will be performed. This option only works in the interac‐
94              tive mode.
95

EXAMPLES

97       (0) Download database to default directory:
98
99              freshclam
100
101       (1) Download database to current directory:
102
103              freshclam --datadir=.
104
105       (2) Run as a daemon and check 2 times per day for new database:
106
107              freshclam -d -c 2
108

RETURN CODES

110       Some return codes of freshclam can be overwritten with a built-in  com‐
111       mand EXIT_n which can be passed to --on-*-execute, eg. --on-update-exe‐
112       cute=EXIT_1 will force freshclam to always return  1  after  successful
113       database update.
114
115       0 : Database is up-to-date or successfully updated.
116
117       40: Unknown option passed.
118
119       50: Can't change directory.
120
121       51: Can't check MD5 sum.
122
123       52: Connection (network) problem.
124
125       53: Can't unlink file.
126
127       54: MD5 or digital signature verification error.
128
129       55: Error reading file.
130
131       56: Config file error.
132
133       57: Can't create new file.
134
135       58: Can't read database from remote server.
136
137       59: Mirrors are not fully synchronized (try again later).
138
139       60: Can't get information about '' user from /etc/passwd.
140
141       61: Can't drop privileges.
142
143       62: Can't initialize logger.
144

FILES

146       /etc/freshclam.conf
147

CREDITS

149       Please check the full documentation for credits.
150

AUTHOR

152       Tomasz Kojm <tkojm@clamav.net>
153