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  many  addi‐
26              tional informations.
27
28       --quiet
29              Be quiet - output only error messages.
30
31       --stdout
32              Write all messages to stdout.
33
34       -l FILE, --log=FILE
35              Write download report to FILE.
36
37       --datadir=DIRECTORY
38              Install  new  database  in  DIRECTORY.  The  directory  must  be
39              writable for the '' user or unprivileged user running freshclam.
40
41       -u USER, --user USER
42              Run as USER. By default (when started by root)  freshclam  drops
43              privileges and operates as the '' user.
44
45       -d, --daemon
46              Run  in  a daemon mode. This option requires --checks.  -p FILE,
47              --pid=FILE Write daemon's pid to FILE.
48
49       --no-dns
50              This option forces old non-DNS verification  method  (without  a
51              TTL delay).
52
53       -c #n, --checks=#n
54              Check  #n times per day for a new database. #n must be between 1
55              and 50.
56
57       --daemon-notify=/path/to/clamd.conf
58              Notify the daemon about the new database. By default it reads  a
59              hardcoded  config  file  but  you  can use a different one. Both
60              local and TCP sockets are supported.
61
62       -a IP, --local-address=IP
63              Use (local) IP for HTTP downloads. Useful for  multi-homed  sys‐
64              tems.  If binding fails for whatever reason, a warning is issued
65              and freshclam behaves like without this flag.
66
67       --on-error-execute=COMMAND
68              Execute COMMAND if error occurred. Remember, that virus database
69              freshness is the most important thing in anti-virus system. With
70              this option freshclam can alert you (eg. send  SMS)  when  some‐
71              thing is going wrong.
72
73       --on-update-execute=COMMAND
74              Execute COMMAND after successful update.
75
76       --on-outdated-execute=COMMAND
77              Execute  COMMAND when freshclam reports outdated version. In the
78              command string %v will be replaced by the new version number.
79
80       --list-mirrors
81              Pring mirror details from mirrors.dat (cache file for the mirror
82              manager).
83

EXAMPLES

85       (0) Download database to default directory:
86
87              freshclam
88
89       (1) Download database to current directory:
90
91              freshclam --datadir=.
92
93       (2) Run as a daemon and check 2 times per day for new database:
94
95              freshclam -d -c 2
96

RETURN CODES

98       0 : Database successfully updated.
99
100       1 : Database is up-to-date.
101
102       40: Unknown option passed.
103
104       50: Can't change directory.
105
106       51: Can't check MD5 sum.
107
108       52: Connection (network) problem.
109
110       53: Can't unlink file.
111
112       54: MD5 or digital signature verification error.
113
114       55: Error reading file.
115
116       56: Config file error.
117
118       57: Can't create new file.
119
120       58: Can't read database from remote server.
121
122       59: Mirrors are not fully synchronized (try again later).
123
124       60: Can't get information about '' user from /etc/passwd.
125
126       61: Can't drop privileges.
127
128       62: Can't initialize logger.
129

FILES

131       /etc/freshclam.conf
132

CREDITS

134       Please check the full documentation for credits.
135

AUTHOR

137       Tomasz Kojm <tkojm@clamav.net>
138