~ubuntu-branches/ubuntu/feisty/clamav/feisty

« back to all changes in this revision

Viewing changes to docs/man/clamd.8.in

  • Committer: Bazaar Package Importer
  • Author(s): Kees Cook
  • Date: 2007-02-20 10:33:44 UTC
  • mfrom: (0.7.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20070220103344-yrxzd2x7lhee3r02
Tags: 0.90-1ubuntu1
* Merge from debian unstable, remaining changes:
  - debian/clamav-base.init-stub, debian/clamav-daemon.init,
    debian/rules: init script stub for common setup functions.
  - debian/control: Maintainers updated for Ubuntu.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
.\" Manual page created by Tomasz Kojm, 20020929
2
 
.TH "Clam Daemon" "8" "November 11, 2003" "Tomasz Kojm" "Clam AntiVirus"
 
1
.TH "Clam Daemon" "8" "February 12, 2007" "ClamAV 0.90" "Clam AntiVirus"
3
2
.SH "NAME"
4
3
.LP 
5
4
clamd \- an anti\-virus daemon
8
7
clamd [options]
9
8
.SH "DESCRIPTION"
10
9
.LP 
11
 
The daemon listens for incoming connections on Unix or TCP socket and scans files or directories on demand. It's a part of the Clam AntiVirus package. It reads its configuration information from a clamd.conf file. It provides on\-access scanning feature (clamuko) under Linux.
 
10
The daemon listens for incoming connections on Unix and/or TCP socket and scans files or directories on demand. It reads the configuration from @CFGDIR@/clamd.conf
12
11
.SH "COMMANDS"
13
12
.LP 
14
13
clamd recognizes the following commands:
15
14
 
16
 
Note: It's recommended to prefix clamd commands with the letter \fBn\fR (eg. nSCAN) to indicate that the command will be delimited by a newline character and that clamd should continue reading command data until a newline is read. The newline delimiter assures that the complete command and its entire argument will be processed as a single command.
17
15
.TP 
18
16
\fBPING\fR
19
17
Check the server's state. It should reply with "PONG".
20
18
.TP 
21
19
\fBVERSION\fR
22
 
Print a version information.
 
20
Print program and database versions.
23
21
.TP 
24
22
\fBRELOAD\fR
25
23
Reload the virus databases.
26
24
.TP 
27
 
\fBQUIT\fR
 
25
\fBSHUTDOWN\fR
28
26
Perform a clean exit.
29
27
.TP 
30
28
\fBSCAN file/directory\fR
34
32
Scan a file or directory (recursively) with archive support disabled. A full path is required.
35
33
.TP 
36
34
\fBCONTSCAN file/directory\fR
37
 
Scan a file or directory (recursively) with archive support enabled and continue scanning even when virus is found. A full path is required.
 
35
Scan file or directory (recursively) with archive support enabled and don't stop the scanning when a virus is found.
38
36
.TP 
39
37
\fBMULTISCAN file/directory\fR
40
 
Scan directories with multiple threads.
 
38
Scan file in a standard way or scan directory (recursively) using multiple threads (to make the scanning faster on SMP machines).
41
39
.TP 
42
40
\fBSTREAM\fR
43
 
Scan stream \- on this command clamd will return "PORT number" and you can connect to that port and send a data to scan.
 
41
Scan stream \- on this command clamd will return "PORT number" you should connect to and send data to scan.
 
42
.TP 
 
43
\fBSESSION, END\fR
 
44
Start/end a clamd session which will allow you to run multiple commands per TCP session. It's recommended to prefix clamd commands with the letter \fBn\fR (eg. nSCAN) to indicate that the command will be delimited by a newline character and that clamd should continue reading command data until a newline is read. The newline delimiter assures that the complete command and its entire argument will be processed as a single command.
44
45
.SH "OPTIONS"
45
46
.LP 
46
47
 
63
64
Tomasz Kojm <tkojm@clamav.net>
64
65
.SH "SEE ALSO"
65
66
.LP 
66
 
clamdscan(1), clamscan(1), freshclam(1), sigtool(1), clamd.conf(5), clamav\-milter(8)
 
67
clamd.conf(5), clamdscan(1), clamscan(1), freshclam(1), sigtool(1), clamav\-milter(8)