← Back to branch summary

~ubuntu-branches/ubuntu/breezy/clamav/breezy-backports

« back to all changes in this revision

Viewing changes to docs/man/clamscan.1

  • Committer: Bazaar Package Importer
  • Author(s): Stephen Gran
  • Date: 2005-09-19 09:05:59 UTC
  • mfrom: (1.1.1 upstream)
  • Revision ID: james.westby@ubuntu.com-20050919090559-hikpqduq8yx5qxo2
Tags: 0.87-1
http://bugs.debian.org/328660
http://bugs.debian.org/323132
http://bugs.debian.org/327707
http://bugs.debian.org/328912
* New upstream version
  - Fixes CAN-2005-2920 and CAN-2005-2919 (closes: #328660)
* New logcheck line for clamav-daemon (closes: #323132)
* relibtoolize and apply kfreebsd patch (closes: #327707)
* Make sure init.d script starts freshclam up again after upgrade when run
  from if-up.d (closes: #328912)

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/man/clamscan.1
1
1
.\" Manual page created by Tomasz Kojm, 14/15 IV 2002
2
 
.TH "clamscan" "1" "March 14, 2004" "Tomasz Kojm" "Clam AntiVirus"
 
2
.TH "clamscan" "1" "May 11, 2005" "Tomasz Kojm" "Clam AntiVirus"
3
3
.SH "NAME"
4
4
.LP 
5
5
clamscan \- scan files and directories against viruses
29
29
Be quiet (only print error messages).
30
30
.TP 
31
31
\fB\-\-stdout\fR
32
 
Write all messages to the standard output (stdout) instead of the standard error output (stderr).
 
32
Write all messages (except for libclamav output) to the standard output (stdout).
33
33
.TP 
34
34
\fB\-d FILE/DIR, \-\-database=FILE/DIR\fR
35
35
Load virus database from FILE or load all virus database files from DIR.
40
40
\fB\-\-tempdir=DIRECTORY\fR
41
41
Create temporary files in DIRECTORY. Directory must be writeable for the 'clamav' user or unprivileged user running clamscan.
42
42
.TP 
 
43
\fB\-\-leave\-temps\fR
 
44
Do not remove temporary files.
 
45
.TP 
43
46
\fB\-r, \-\-recursive\fR
44
47
Scan directories recursively. All the subdirectories in the given directory will be scanned.
45
48
.TP 
47
50
Sound bell on virus detection.
48
51
.TP 
49
52
\fB\-\-no\-summary\fR
50
 
Disable summary printing at the end of scanning.
51
 
.TP 
52
 
\fB\-\-exclude=PATT\fR
53
 
Don't scan file names containing PATT. It may be used multiple times.
54
 
.TP 
55
 
\fB\-\-include=PATT\fR
56
 
Only scan file names containing PATT. It may be used multiple times.
57
 
.TP 
58
 
\fB\-\-mbox\fR
59
 
Enable scanning of various mail file types (also treat stdin as a mailbox \- for backward compatibility).
 
53
Do not display summary at the end of scanning.
 
54
.TP 
 
55
\fB\-\-exclude=PATT, \-\-exclude\-dir=PATT\fR
 
56
Don't scan file/directory names containing PATT. It may be used multiple times.
 
57
.TP 
 
58
\fB\-\-include=PATT, \-\-include\-dir=PATT\fR
 
59
Only scan file/directory names containing PATT. It may be used multiple times.
60
60
.TP 
61
61
\fB\-i, \-\-infected\fR
62
62
Only print infected files.
67
67
\fB\-\-move=DIRECTORY\fR
68
68
Move infected files into DIRECTORY. Directory must be writeable for the 'clamav' user or unprivileged user running clamscan.
69
69
.TP 
70
 
EXTRACTION OPTIONS:
 
70
\fB\-\-no\-mail\fR
 
71
Disable scanning of mail files.
 
72
.TP 
 
73
\fB\-\-no\-pe\fR
 
74
PE stands for Portable Executable \- it's an executable file format used in all 32\-bit versions of Windows operating systems. By default ClamAV performs deeper analysis of executable files and attempts to decompress popular executable packers such as UPX, Petite, and FSG. This option \fBdisables\fR PE support and should be used with care!
71
75
.TP 
72
76
\fB\-\-no\-ole2\fR
73
77
Disable support for Microsoft Office document files.
74
78
.TP 
 
79
\fB\-\-no\-html\fR
 
80
Disable support for HTML detection and normalisation.
 
81
.TP 
75
82
\fB\-\-no\-archive\fR
76
83
Disable archive support built in libclamav.
77
84
.TP 
 
85
\fB\-\-detect\-broken\fR
 
86
Mark broken executables as viruses (Broken.Executable).
 
87
.TP 
78
88
\fB\-\-block\-encrypted\fR
79
89
Mark encrypted archives as viruses (Encrypted.Zip, Encrypted.RAR).
80
90
.TP 
 
91
\fB\-\-block\-max\fR
 
92
Mark archives as viruses (e.g. RAR.ExceededFileSize, Zip.ExceededFilesLimit) if max\-files, max\-space, or max\-recursion is reached.
 
93
.TP 
 
94
\fB\-\-mail\-follow\-urls\fR
 
95
If an email contains URLs ClamAV can download and scan them. \fBWARNING: This option may open your system to a DoS attack. Never use it on loaded servers.\fR
 
96
.TP 
81
97
\fB\-\-max\-files=#n\fR
82
98
Extract first #n files from each archive. This option protects your system against DoS attacks (default: 500)
83
99
.TP 
85
101
Extract first #n kilobytes from each archive. You may give the number in megabytes in format xM or xm, where x is a number. This option protects your system against DoS attacks (default: 10 MB)
86
102
.TP 
87
103
\fB\-\-max\-recursion=#n\fR
88
 
Set archive recursion level limit. This option protects your system against DoS attacks (default: 5).
 
104
Set archive recursion level limit. This option protects your system against DoS attacks (default: 8).
89
105
.TP 
90
106
\fB\-\-max\-ratio=#n\fR
91
 
Set maximum archive compression ratio limit. This option protects your system against DoS attacks (default: 200).
 
107
Set maximum archive compression ratio limit. This option protects your system against DoS attacks (default: 250).
 
108
.TP 
 
109
\fB\-\-max\-dir\-recurion=#n\fR
 
110
Maximum depth directories are scanned at (default: 15).
92
111
.TP 
93
112
\fB\-\-unzip[=FULLPATH]\fR
94
113
In most cases you don't need this option \- the built\-in unarchiver will do extract Zip archives. This option however may be used as a backup for internal unpacker \- see the full documentation for more information. When enabled without an argument, unzip program will be searched in $PATH. If unzip cannot be found in $PATH, you must force it with =pathname. Remember about '=' between the option and an argument.
141
160
.TP 
142
161
(5) Scan mail spool directory:
143
162
 
144
 
\fBclamscan \-r \-\-mbox /var/spool/mail\fR
 
163
\fBclamscan \-r /var/spool/mail\fR
145
164
.SH "RETURN CODES"
146
165
.LP 
147
166
Note: some return codes may only appear in a one file mode (clamscan is started with file argument). Those are marked with \fB(ofm)\fR.
174
193
.TP 
175
194
61: Can't fork.
176
195
.TP 
 
196
62: Can't initialize logger.
 
197
.TP 
177
198
63: Can't create temporary files/directories (check permissions).
178
199
.TP 
179
200
64: Can't write to temporary directory (please specify another one).