← Back to branch summary

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

« back to all changes in this revision

Viewing changes to docs/man/clamscan.1

  • 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:
docs/man/clamscan.1
1
 
.\" Manual page created by Tomasz Kojm, 14/15 IV 2002
2
 
.TH "clamscan" "1" "November 14, 2005" "Tomasz Kojm" "Clam AntiVirus"
 
1
.TH "clamscan" "1" "February 12, 2007" "ClamAV 0.90" "Clam AntiVirus"
3
2
.SH "NAME"
4
3
.LP 
5
 
clamscan \- scan files and directories against viruses
 
4
clamscan \- scan files and directories for viruses
6
5
.SH "SYNOPSIS"
7
6
.LP 
8
7
clamscan [options] [file/directory/\-]
9
8
.SH "DESCRIPTION"
10
9
.LP 
11
 
clamscan is a command line anti\-virus scanner. It's a part of the Clam AntiVirus package.
 
10
clamscan is a command line anti\-virus scanner.
12
11
.SH "OPTIONS"
13
12
.LP 
14
13
 
23
22
Be verbose.
24
23
.TP 
25
24
\fB\-\-debug\fR
26
 
Enable debug messages (from libclamav).
 
25
Display debug messages from libclamav.
27
26
.TP 
28
27
\fB\-\-quiet\fR
29
28
Be quiet (only print error messages).
67
66
\fB\-\-move=DIRECTORY\fR
68
67
Move infected files into DIRECTORY. Directory must be writable for the 'clamav' user or unprivileged user running clamscan.
69
68
.TP 
 
69
\fB\-\-copy=DIRECTORY\fR
 
70
Copy infected files into DIRECTORY. Directory must be writable for the 'clamav' user or unprivileged user running clamscan.
 
71
.TP 
70
72
\fB\-\-no\-mail\fR
71
73
Disable scanning of mail files.
72
74
.TP 
73
 
\fB\-\-no\-phishing\fR
74
 
Disable detection of phishing messages.
 
75
\fB\-\-no\-phishing\-sigs\fR
 
76
Disable signature-based phishing detection.
75
77
.TP 
76
78
\fB\-\-no\-phishing\-scan\-urls\fR
77
79
Disable url-based phishing detection. (Only available in experimental builds)
85
87
\fB\-\-phishing\-cloak\fR
86
88
Always block cloaked URLs (might lead to some false positives). (Only available in experimental builds)
87
89
.TP
88
 
\fB\-\-no\-algo\fR
 
90
\fB\-\-no\-algorithmic\fR
89
91
In some cases (eg. complex malware, exploits in graphic files, and others), ClamAV uses special algorithms to provide accurate detection. This option disables the algorithmic detection.
90
92
.TP 
91
93
\fB\-\-no\-pe\fR
95
97
Executable and Linking Format is a standard format for UN*X executables. This option \fBdisables\fR ELF support.
96
98
.TP 
97
99
\fB\-\-no\-ole2\fR
98
 
Disable support for Microsoft Office document files.
 
100
Disable support for Microsoft Office documents and .msi files.
99
101
.TP 
100
102
\fB\-\-no\-html\fR
101
103
Disable support for HTML detection and normalisation.
119
121
Extract first #n files from each archive. This option protects your system against DoS attacks (default: 500)
120
122
.TP 
121
123
\fB\-\-max\-space=#n\fR
122
 
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)
 
124
Extract first #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: 10 MB)
123
125
.TP 
124
126
\fB\-\-max\-recursion=#n\fR
125
127
Set archive recursion level limit. This option protects your system against DoS attacks (default: 8).
134
136
Maximum depth directories are scanned at (default: 15).
135
137
.TP 
136
138
\fB\-\-unzip[=FULLPATH]\fR
137
 
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.
 
139
In most cases you don't need this option \- the built\-in unarchiver will extract Zip archives. Howvere, this option 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 the argument.
138
140
.TP 
139
141
\fB\-\-unrar[=FULLPATH]\fR
140
 
Scan .rar files.
 
142
Scan .rar files. In most cases the unpacker built into libclamav is enough.
141
143
.TP 
142
144
\fB\-\-arj[=FULLPATH]\fR
143
145
Scan .arj files.
149
151
Scan .lzh files.
150
152
.TP 
151
153
\fB\-\-jar[=FULLPATH]\fR
152
 
clamscan uses unzip for .jar files, so optionally eventually you will need to pass a full path to unzip.
 
154
clamscan uses unzip for .jar files, so in some cases you may need to pass a full path to unzip. In most cases the unpacker built into libclamav is enough.
153
155
.TP 
154
156
\fB\-\-deb[=FULLPATH]\fR
155
157
This option supports debian binary packages. Implies \-\-tgz, but doesn't conflict with \-\-tgz=FULLPATH. It requires ar utility.
156
158
.TP 
157
159
\fB\-\-tar[=FULLPATH]\fR
158
 
This option supports non\-compressed archives.
 
160
This option supports non\-compressed tar archives. In most cases the unpacker built into libclamav is enough.
159
161
.TP 
160
162
\fB\-\-tgz[=FULLPATH]\fR
161
 
This option supports tar.gz and .tgz files. You need GNU tar, on non\-Linux system you probably have it installed as gtar. If it's in $PATH, please use \-\-tgz=gtar in other case please pass a full path.
 
163
This option supports tar.gz and .tgz files. You need GNU tar, on non\-Linux system you probably have it installed as gtar. If it's in $PATH, please use \-\-tgz=gtar in other case please pass a full path. In most cases the unpacker built into libclamav is enough.
162
164
.SH "EXAMPLES"
163
165
.LP 
164
166
.TP 
165
 
(0) Scan selected file:
 
167
(0) Scan a single file:
166
168
 
167
169
\fBclamscan file\fR
168
170
.TP 
169
 
(1) Scan current working directory:
 
171
(1) Scan a current working directory:
170
172
 
171
173
\fBclamscan\fR
172
174
.TP 
174
176
 
175
177
\fBclamscan \-r /home\fR
176
178
.TP 
177
 
(3) Load database from selected file and limit disk usage to 50 Mb:
 
179
(3) Load database from a file and limit disk usage to 50 MB:
178
180
 
179
181
\fBclamscan \-d /tmp/newclamdb \-\-max\-space=50m \-r /tmp\fR
180
182
.TP 
181
 
(4) Scan data stream:
 
183
(4) Scan a data stream:
182
184
 
183
185
\fBcat testfile | clamscan \-\fR
184
186
.TP 
185
 
(5) Scan mail spool directory:
 
187
(5) Scan a mail spool directory:
186
188
 
187
189
\fBclamscan \-r /var/spool/mail\fR
188
190
.SH "RETURN CODES"
189
191
.LP 
190
 
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.
 
192
Note: some return codes may only appear in a single file mode (when clamscan is started with a single argument). Those are marked with \fB(ofm)\fR.
191
193
 
192
194
0 : No virus found.
193
195
.TP 
223
225
.TP 
224
226
64: Can't write to temporary directory (please specify another one).
225
227
.TP 
226
 
70: Can't allocate and clear memory (calloc).
 
228
70: Can't allocate memory (calloc).
227
229
.TP 
228
230
71: Can't allocate memory (malloc).
229
231
.SH "CREDITS"