~ubuntu-branches/ubuntu/saucy/clamav/saucy-backports

« back to all changes in this revision

Viewing changes to docs/man/clamscan.1.in

  • Committer: Package Import Robot
  • Author(s): Scott Kitterman
  • Date: 2014-07-15 01:08:10 UTC
  • mfrom: (0.35.47 sid)
  • Revision ID: package-import@ubuntu.com-20140715010810-ru66ek4fun2iseba
Tags: 0.98.4+dfsg-2~ubuntu13.10.1
No-change backport to saucy (LP: #1341962)

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
.TH "clamscan" "1" "December 30, 2008" "ClamAV @VERSION@" "Clam AntiVirus"
 
1
.TH "clamscan" "1" "December 4, 2013" "ClamAV @VERSION@" "Clam AntiVirus"
2
2
.SH "NAME"
3
3
.LP 
4
4
clamscan \- scan files and directories for viruses
20
20
.TP 
21
21
\fB\-v, \-\-verbose\fR
22
22
Be verbose.
 
23
.TP
 
24
\fB\-a, \-\-archive\-verbose\fR
 
25
Show filenames inside scanned archives
23
26
.TP 
24
27
\fB\-\-debug\fR
25
28
Display debug messages from libclamav.
29
32
.TP 
30
33
\fB\-\-stdout\fR
31
34
Write all messages (except for libclamav output) to the standard output (stdout).
 
35
.TP
 
36
\fB\-\-no\-summary\fR
 
37
Do not display summary at the end of scanning.
 
38
.TP
 
39
\fB\-i, \-\-infected\fR
 
40
Only print infected files.
 
41
.TP
 
42
\fB\-o, \-\-suppress\-ok\-results\fR
 
43
Skip printing OK files
 
44
.TP
 
45
\fB\-\-bell\fR
 
46
Sound bell on virus detection.
 
47
.TP
 
48
\fB\-\-tempdir=DIRECTORY\fR
 
49
Create temporary files in DIRECTORY. Directory must be writable for the '@CLAMAVUSER@' user or unprivileged user running clamscan.
 
50
.TP
 
51
\fB\-\-leave\-temps\fR
 
52
Do not remove temporary files.
32
53
.TP 
33
54
\fB\-d FILE/DIR, \-\-database=FILE/DIR\fR
34
55
Load virus database from FILE or load all virus database files from DIR.
39
60
\fB\-l FILE, \-\-log=FILE\fR
40
61
Save scan report to FILE.
41
62
.TP 
42
 
\fB\-\-tempdir=DIRECTORY\fR
43
 
Create temporary files in DIRECTORY. Directory must be writable for the '@CLAMAVUSER@' user or unprivileged user running clamscan.
44
 
.TP 
45
 
\fB\-\-leave\-temps\fR
46
 
Do not remove temporary files.
47
 
.TP 
48
 
\fB\-f FILE, \-\-file\-list=FILE\fR
49
 
Scan files listed line by line in FILE.
50
 
.TP 
51
63
\fB\-r, \-\-recursive\fR
52
64
Scan directories recursively. All the subdirectories in the given directory will be scanned.
53
65
.TP 
63
75
\fB\-\-follow\-file\-symlinks=[0/1(*)/2]\fR
64
76
Follow file symlinks. There are 3 options: 0 - never follow file symlinks, 1 (default) - only follow file symlinks, which are passed as direct arguments to clamscan. 2 - always follow file symlinks.
65
77
.TP 
66
 
\fB\-\-bell\fR
67
 
Sound bell on virus detection.
68
 
.TP 
69
 
\fB\-\-no\-summary\fR
70
 
Do not display summary at the end of scanning.
71
 
.TP 
72
 
\fB\-\-exclude=REGEX, \-\-exclude\-dir=REGEX\fR
73
 
Don't scan file/directory names matching regular expression. These options can be used multiple times.
74
 
.TP 
75
 
\fB\-\-include=REGEX, \-\-include\-dir=REGEX\fR
76
 
Only scan file/directory matching regular expression. These options can be used multiple times.
77
 
.TP 
78
 
\fB\-i, \-\-infected\fR
79
 
Only print infected files.
 
78
\fB\-f FILE, \-\-file\-list=FILE\fR
 
79
Scan files listed line by line in FILE.
80
80
.TP 
81
81
\fB\-\-remove[=yes/no(*)]\fR
82
 
Remove infected files. \fBBe careful.\fR
 
82
Remove infected files. \fBBe careful!\fR
83
83
.TP 
84
84
\fB\-\-move=DIRECTORY\fR
85
85
Move infected files into DIRECTORY. Directory must be writable for the '@CLAMAVUSER@' user or unprivileged user running clamscan.
87
87
\fB\-\-copy=DIRECTORY\fR
88
88
Copy infected files into DIRECTORY. Directory must be writable for the '@CLAMAVUSER@' user or unprivileged user running clamscan.
89
89
.TP 
 
90
\fB\-\-exclude=REGEX, \-\-exclude\-dir=REGEX\fR
 
91
Don't scan file/directory names matching regular expression. These options can be used multiple times.
 
92
.TP 
 
93
\fB\-\-include=REGEX, \-\-include\-dir=REGEX\fR
 
94
Only scan file/directory matching regular expression. These options can be used multiple times.
 
95
.TP 
90
96
\fB\-\-bytecode[=yes(*)/no]\fR
91
97
With this option enabled ClamAV will load bytecode from the database. It is highly recommended you keep this option turned on, otherwise you may miss detections for many new viruses.
92
98
.TP 
138
144
\fB\-\-phishing\-cloak[=yes/no(*)]\fR
139
145
Block cloaked URLs (might lead to some false positives).
140
146
.TP
 
147
\fB\-\-partition\-intersection[=yes/no(*)]\fR
 
148
Detect partition intersections in raw disk images using heuristics.
 
149
.TP
141
150
\fB\-\-algorithmic\-detection[=yes(*)/no]\fR
142
151
In some cases (eg. complex malware, exploits in graphic files, and others), ClamAV uses special algorithms to provide accurate detection. This option can be used to control the algorithmic detection.
143
152
.TP 
152
161
.TP 
153
162
\fB\-\-scan\-pdf[=yes(*)/no]\fR
154
163
Scan within PDF files. If you turn off this option, the original files will still be scanned, but without decoding and additional processing.
 
164
.TP
 
165
\fB\-\-scan\-swf[=yes(*)/no]\fR
 
166
Scan SWF files. If you turn off this option, the original files will still be scanned but without additional processing.
155
167
.TP 
156
168
\fB\-\-scan\-html[=yes(*)/no]\fR
157
169
Detect, normalize/decrypt and scan HTML files and embedded scripts. If you turn off this option, the original files will still be scanned, but without additional processing.
165
177
\fB\-\-block\-encrypted[=yes/no(*)]\fR
166
178
Mark encrypted archives as viruses (Encrypted.Zip, Encrypted.RAR).
167
179
.TP 
 
180
\fB\-\-max\-filesize=#n\fR
 
181
Extract and scan at most #n bytes from each archive. You may pass the value in kilobytes in format xK or xk, or megabytes in format xM or xm, where x is a number. This option protects your system against DoS attacks (default: 25 MB, max: <4 GB)
 
182
.TP 
 
183
\fB\-\-max\-scansize=#n\fR
 
184
Extract and scan at most #n bytes from each archive. The size the archive plus the sum of the sizes of all files within archive count toward the scan size. For example, a 1M uncompressed archive containing a single 1M inner file counts as 2M toward max-scansize. You may pass the value in kilobytes in format xK or xk, or megabytes in format xM or xm, where x is a number. This option protects your system against DoS attacks (default: 100 MB, max: <4 GB)
 
185
.TP
168
186
\fB\-\-max\-files=#n\fR
169
187
Extract at most #n files from each scanned file (when this is an archive, a document or another kind of container). This option protects your system against DoS attacks (default: 10000)
170
188
.TP 
171
 
\fB\-\-max\-filesize=#n\fR
172
 
Extract and scan at most #n kilobytes from each archive. You may pass the value in megabytes in format xM or xm, where x is a number. This option protects your system against DoS attacks (default: 25 MB, max: <4 GB)
173
 
.TP 
174
 
\fB\-\-max\-scansize=#n\fR
175
 
Extract and scan at most #n kilobytes from each scanned file. You may pass the value in megabytes in format xM or xm, where x is a number. This option protects your system against DoS attacks (default: 100 MB, max: <4 GB)
176
 
.TP 
177
189
\fB\-\-max\-recursion=#n\fR
178
190
Set archive recursion level limit. This option protects your system against DoS attacks (default: 16).
179
191
.TP 
180
192
\fB\-\-max\-dir\-recursion=#n\fR
181
193
Maximum depth directories are scanned at (default: 15).
 
194
 
 
195
.TP
 
196
\fB\-\-max\-embeddedpe=#n\fR
 
197
Maximum size file to check for embedded PE. You may pass the value in kilobytes in format xK or xk, or megabytes in format xM or xm, where x is a number (default: 10 MB, max: <4 GB).
 
198
.TP
 
199
\fB\-\-max\-htmlnormalize=#n\fR
 
200
Maximum size of HTML file to normalize. You may pass the value in kilobytes in format xK or xk, or megabytes in format xM or xm, where x is a number (default: 10 MB, max: <4 GB).
 
201
.TP
 
202
\fB\-\-max\-htmlnotags=#n\fR
 
203
Maximum size of normalized HTML file to scan. You may pass the value in kilobytes in format xK or xk, or megabytes in format xM or xm, where x is a number (default: 2 MB, max: <4 GB).
 
204
.TP
 
205
\fB\-\-max\-scriptnormalize=#n\fR
 
206
Maximum size of script file to normalize. You may pass the value in kilobytes in format xK or xk, or megabytes in format xM or xm, where x is a number (default: 5 MB, max: <4 GB).
 
207
.TP
 
208
\fB\-\-max\-ziptypercg=#n\fR
 
209
Maximum size zip to type reanalyze. You may pass the value in kilobytes in format xK or xk, or megabytes in format xM or xm, where x is a number (default: 1 MB, max: <4 GB).
 
210
.TP
 
211
\fB\-\-max\-partitions=#n\fR
 
212
This option sets the maximum number of partitions of a raw disk image to be scanned. This must be a positive integer (default: 50).
 
213
.TP
 
214
\fB\-\-max\-iconspe=#n\fR
 
215
This option sets the maximum number of icons within a PE to be scanned. This must be a positive integer (default: 100).
 
216
.TP
 
217
\fB\-\-enable\-stats\fR
 
218
This option enables submission of statistical data. (Default: stats submissions disabled)
 
219
.TP
 
220
\fB\-\-stats\-host\-id\fR
 
221
This option sets the HostID, in the form of an UUID, to use when submitting statistical information.
 
222
.TP
 
223
\fB\-\-disable\-pe\-stats\fR
 
224
This option disables the submission of PE section data. (Default: submitting of PE section data enabled if stats submissions as a whole is enabled).
 
225
.TP
 
226
\fB\-\-stats\-timeout=#n\fR
 
227
This option sets the timeout in seconds to wait for communication back from the stats server. (Default: 10).
182
228
.SH "EXAMPLES"
183
229
.LP 
184
230
.TP 
216
262
Please check the full documentation for credits.
217
263
.SH "AUTHOR"
218
264
.LP 
219
 
Tomasz Kojm <tkojm@clamav.net>
 
265
Tomasz Kojm <tkojm@clamav.net>, Kevin Lin <klin@sourcefire.com>
220
266
.SH "SEE ALSO"
221
267
.LP 
222
268
clamdscan(1), freshclam(1), freshclam.conf(5)