a0faaedf |
.\" Manual page created by Tomasz Kojm, 20020415 |
34f1f7dd |
.TH "freshclam" "1" "September 1, 2004" "Tomasz Kojm" "Clam AntiVirus" |
468b9e48 |
.SH "NAME"
.LP |
a0faaedf |
freshclam \- update virus databases |
468b9e48 |
.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 |
5aad82e2 |
Freshclam reads its configuration from freshclam.conf. The settings can be overwritten with command line options. |
468b9e48 |
.TP
\fB\-h, \-\-help\fR
Output help information and exit.
.TP
\fB\-V, \-\-version\fR |
a0faaedf |
Print version number and exit. |
468b9e48 |
.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 |
a0faaedf |
Save download report in FILE. |
468b9e48 |
.TP
\fB\-\-datadir=DIRECTORY\fR |
521b19b4 |
Install new database in DIRECTORY. The directory must be writeable for the 'clamav' user or unprivileged user running freshclam. |
468b9e48 |
.TP
\fB\-u USER, \-\-user USER\fR |
a0faaedf |
Run as USER. By default (when started by root) freshclam drops privileges and works as the 'clamav' user. |
468b9e48 |
.TP
\fB\-d, \-\-daemon\fR
Run in a daemon mode. This option requires \-\-checks.
.TP |
5aad82e2 |
\fB\-p FILE, \-\-pid=FILE\fR
Save daemon's pid in FILE.
.TP |
34f1f7dd |
\fB\-\-no\-dns\fR
This option forces old non\-DNS verification method (without a TTL delay).
.TP |
468b9e48 |
\fB\-c #n, \-\-checks=#n\fR |
8373a9b0 |
Check #n times per day for a new database. #n must be between 1 and 50. |
468b9e48 |
.TP |
09b431f0 |
\fB\-\-daemon\-notify=/path/to/clamd.conf\fR |
a0faaedf |
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. |
468b9e48 |
.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:
|
a0faaedf |
\fBfreshclam \-\-datadir=.\fR |
468b9e48 |
.TP |
a0faaedf |
(2) Run as a daemon and check 2 times per day for new database: |
468b9e48 |
\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 |
1f5be3bf |
51: Can't check MD5 sum. |
468b9e48 |
.TP
52: Connection (network) problem.
.TP |
1f5be3bf |
53: Can't unlink a file. |
468b9e48 |
.TP |
a0faaedf |
54: MD5 or digital signature verification error. |
468b9e48 |
.TP
55: Error reading file.
.TP |
1f5be3bf |
56: Config file error.
.TP
57: Can't create a new file.
.TP
58: Can't read database from remote server.
.TP
59: Mirrors are not fully synchronized (try again later).
.TP |
468b9e48 |
60: Can't get information about clamav user from /etc/passwd. |
eeb69538 |
.TP
61: Can't drop privileges. |
468b9e48 |
.SH "CREDITS"
Please check the full documentation for credits.
.SH "AUTHOR"
.LP |
530534f5 |
Tomasz Kojm <tkojm@clamav.net> |
468b9e48 |
.SH "SEE ALSO"
.LP |
09b431f0 |
clamd(8), clamdscan(1), clamscan(1), sigtool(1), clamd.conf(5) |