5def21ff |
.\" Manual page created by Tomasz Kojm, 20020415
.TH "freshclam" "1" "November 11, 2003" "Tomasz Kojm" "Clam AntiVirus" |
28e73e95 |
.SH "NAME"
.LP |
5def21ff |
freshclam \- update virus databases |
28e73e95 |
.SH "SYNOPSIS"
.LP
freshclam [options]
.SH "DESCRIPTION"
.LP
freshclam updates the virus database. It's a part of the Clam AntiVirus package. It requires an Internet connection.
.SH "OPTIONS"
.LP
.TP
\fB\-h, \-\-help\fR
Output help information and exit.
.TP
\fB\-V, \-\-version\fR |
5def21ff |
Print version number and exit. |
28e73e95 |
.TP
\fB\-v, \-\-verbose\fR
Be verbose. This option causes freshclam to print many additional informations.
.TP
\fB\-\-quiet\fR
Be quiet \- output only error messages.
.TP
\fB\-\-stdout\fR
Write all messages to the standard output (stdout), instead of the standard error output (stderr).
.TP
\fB\-l FILE, \-\-log=FILE\fR |
5def21ff |
Save download report in FILE. |
28e73e95 |
.TP
\fB\-\-log\-verbose\fR |
5def21ff |
Save additional information (mostly needless) to the report file. |
28e73e95 |
.TP
\fB\-\-datadir=DIRECTORY\fR |
5def21ff |
Install downloaded database in DIRECTORY. The directory must be writeable for the 'clamav' user or unprivileged user running freshclam. |
28e73e95 |
.TP
\fB\-u USER, \-\-user USER\fR |
5def21ff |
Run as USER. By default (when started by root) freshclam drops privileges and works as the 'clamav' user. |
28e73e95 |
.TP
\fB\-d, \-\-daemon\fR
Run in a daemon mode. This option requires \-\-checks.
.TP
\fB\-c #n, \-\-checks=#n\fR |
5def21ff |
Check #n times pet day for new database. #n must be between 1 and 50. |
28e73e95 |
.TP
\fB\-\-http\-proxy=hostname[:port]\fR
Connect via a proxy server.
.TP
\fB\-\-proxy\-user=user:password\fR
Do proxy authorization for user. Password is required.
.TP
\fB\-\-daemon\-notify=/path/to/clamav.conf\fR |
5def21ff |
Notify the daemon about the new database. By default it reads a hardcoded config file but you can use an another one. Both local and TCP sockets are supported. |
28e73e95 |
.TP
\fB\-\-on\-error\-execute=COMMAND\fR
Execute COMMAND if error occured. Remeber, that virus database freshness is the most important thing in anti\-virus system. With this option freshclam can alert you (eg. send SMS) when something is going wrong.
.TP
\fB\-\-on\-update\-execute=COMMAND\fR
Execute COMMAND after succesful update.
.SH "EXAMPLES"
.LP
.TP
(0) Download database to default directory:
\fBfreshclam\fR
.TP
(1) Download database to current directory:
|
5def21ff |
\fBfreshclam \-\-datadir=.\fR |
28e73e95 |
.TP |
5def21ff |
(2) Run as a daemon and check 2 times per day for new database: |
28e73e95 |
\fBfreshclam \-d \-c 2\fR
.SH "RETURN CODES"
0 : Database succesfully updated.
.TP
1 : Database is up\-to\-date.
.TP
40: Unknown option passed.
.TP
50: Can't change directory.
.TP
51: Can't check MD5 sum of file.
.TP
52: Connection (network) problem.
.TP
53: Can't unlink file.
.TP |
5def21ff |
54: MD5 or digital signature verification error. |
28e73e95 |
.TP
55: Error reading file.
.TP
60: Can't get information about clamav user from /etc/passwd.
.SH "CREDITS"
Please check the full documentation for credits.
.SH "AUTHOR"
.LP |
5def21ff |
Tomasz Kojm <tk@clamav.net> |
28e73e95 |
.SH "SEE ALSO"
.LP |
5def21ff |
clamd(8), clamdscan(1), clamscan(1), sigtool(1), clamav.conf(5), clamav\-milter(8) |