docs/man/clamdscan.1.in
a39ae468
 .TH "Clamd client" "1" "February 12, 2007" "ClamAV @VERSION@" "Clam AntiVirus"
28e73e95
 .SH "NAME"
 .LP 
f3a638e4
 clamdscan \- scan files and directories for viruses using Clam AntiVirus Daemon
28e73e95
 .SH "SYNOPSIS"
 .LP 
a9ebff44
 clamdscan [options] [file/directory]
28e73e95
 .SH "DESCRIPTION"
 .LP 
f3a638e4
 clamdscan is a simple clamd client which may be used as a clamscan replacement. It accepts all the options implemented in clamscan but most of them will be ignored because its scanning abilities only depend on clamd.
28e73e95
 .SH "OPTIONS"
 .LP 
 
 .TP 
 \fB\-h, \-\-help\fR
f3a638e4
 Display help information and exit.
28e73e95
 .TP 
 \fB\-V, \-\-version\fR
5def21ff
 Print version number and exit.
28e73e95
 .TP 
 \fB\-v, \-\-verbose\fR
f3a638e4
 Be verbose.
28e73e95
 .TP 
 \fB\-\-quiet\fR
 Be quiet \- only output error messages.
 .TP 
 \fB\-\-stdout\fR
8589f1a0
 Write all messages (except for libclamav output) to the standard output (stdout).
28e73e95
 .TP 
a9ebff44
 \fB\-\-config\-file=FILE\fR
 Read clamd settings from FILE.
 .TP 
28e73e95
 \fB\-l FILE, \-\-log=FILE\fR
5def21ff
 Save the scan report to FILE.
28e73e95
 .TP 
3bb3357a
 \fB\-m, \-\-multiscan\fR
 Always use MULTISCAN instead of CONTSCAN.
 .TP
63abd169
 \fB\-\-remove\fR
 Remove infected files. \fBBe careful.\fR
 .TP 
 \fB\-\-move=DIRECTORY\fR
 Move infected files into DIRECTORY.
 .TP 
02b4b0c7
 \fB\-\-no\-summary\fR
 Do not display summary at the end of scanning.
c1a133a0
 .TP
c1c9d9f9
 \fB\-\-reload\fR
 Request clamd to reload virus database.
 .TP
c1a133a0
 \fB\-\-fdpass\fR
 Pass the file descriptor permissions clamd. This is useful if clamd is running as a different user as it is faster than streaming the file to clamd.
 Only available if connected to clamd through local(unix) sockets and scanning stdin.
28e73e95
 .SH "EXAMPLES"
 .LP 
 .TP 
 (0) To scan a one file:
 
 \fBclamdscan file\fR
 .TP 
5def21ff
 (1) To scan a current working directory:
28e73e95
 
 \fBclamdscan\fR
 .TP 
 (2) To scan all files in /home:
 
 \fBclamdscan /home\fR
c1a133a0
 .TP
 (3) To scan a file when clamd is running as a different user:
 
 \fBclamdscan - <file_to_scan\fR
28e73e95
 .SH "RETURN CODES"
 .LP 
 0 : No virus found.
 .TP 
 1 : Virus(es) found.
 .TP 
5def21ff
 2 : An error occured.
28e73e95
 .SH "CREDITS"
 Please check the full documentation for credits.
 .SH "AUTHOR"
 .LP 
5def21ff
 Tomasz Kojm <tkojm@clamav.net>
28e73e95
 .SH "SEE ALSO"
 .LP 
f3a638e4
 clamd(8), clamd.conf(5), clamscan(1), freshclam(1)