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       --debug
29              Enable debug messages from LibClamAV.
30
31       --quiet
32              Be quiet - output only error messages.
33
34       --no-warnings
35              Don't print and log warnings.
36
37       --stdout
38              Write all messages to stdout.
39
40       --show-progress
41              Show download progress percentage.
42
43       --config-file=FILE
44              Read configuration from FILE.
45
46       -l FILE, --log=FILE
47              Log report to FILE.
48
49       -d, --daemon
50              Run  in a daemon mode. Defaults to 12 checks per day unless oth‐
51              erwise specified by --checks or freshclam.conf.
52
53       -p FILE, --pid=FILE
54              Write daemon's pid to FILE.
55
56       -u USER, --user USER
57              Run as USER. By default (when started by root)  freshclam  drops
58              privileges and operates as the '' user.
59
60       --no-dns
61              This  option  forces  old non-DNS verification method (without a
62              TTL delay).
63
64       -c #n, --checks=#n
65              Check #n times per day for a new database. #n must be between  1
66              and 50.
67
68       --datadir=DIRECTORY
69              Install  new  database  in  DIRECTORY.  The  directory  must  be
70              writable for the '' user or unprivileged user running freshclam.
71
72       --daemon-notify=/path/to/clamd.conf
73              Notify the daemon about the new database. By default it reads  a
74              hardcoded  config  file  but  you  can use a different one. Both
75              local and TCP sockets are supported.
76
77       -a IP, --local-address=IP
78              Use (local) IP for HTTP downloads. Useful for  multi-homed  sys‐
79              tems.  If binding fails for whatever reason, a warning is issued
80              and freshclam behaves like without this flag.
81
82       --on-update-execute=COMMAND
83              Execute COMMAND after successful update.
84
85       --on-error-execute=COMMAND
86              Execute COMMAND if error occurred. Remember, that virus database
87              freshness is the most important thing in anti-virus system. With
88              this option freshclam can alert you (eg. send  SMS)  when  some‐
89              thing is going wrong.
90
91       --on-outdated-execute=COMMAND
92              Execute  COMMAND when freshclam reports outdated version. In the
93              command string %v will be replaced by the new version number.
94
95       --list-mirrors
96              Print mirror details from mirrors.dat (cache file for the mirror
97              manager).
98
99       --update-db=DBNAME
100              With  this  option you can limit updates to a subset of database
101              files.  The  DBNAME  should  be  "main",  "daily",   "bytecode",
102              "safebrowsing"  or  one  of  the  3rd party database names. This
103              option can be used multiple times and only works with the  offi‐
104              cial and 3rd party databases distributed through the ClamAV mir‐
105              rors, your custom databases (specified with DatabaseCustomURL in
106              freshclam.conf) will not be ignored.
107

EXAMPLES

109       (0) Download database to default directory:
110
111              freshclam
112
113       (1) Download database to current directory:
114
115              freshclam --datadir=.
116
117       (2) Run as a daemon and check 2 times per day for new database:
118
119              freshclam -d -c 2
120

RETURN CODES

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

FILES

158       /etc/freshclam.conf
159

CREDITS

161       Please check the full documentation for credits.
162

AUTHOR

164       Tomasz Kojm <tkojm@clamav.net>, Kevin Lin <klin@sourcefire.com>
165