Browse code

use actual version and user names in man pages (bb#408)

git-svn: trunk@2963

Tomasz Kojm authored on 2007/03/21 11:12:51
Showing 20 changed files
... ...
@@ -1,3 +1,8 @@
1
+Wed Mar 21 01:15:51 CET 2007 (tk)
2
+---------------------------------
3
+  * docs/man: use actual version and user names in man pages (bb#408),
4
+	      thanks to Fabio Pedretti <pedretti*eco.unibs.it>
5
+
1 6
 Wed Mar 21 00:31:29 CET 2007 (tk)
2 7
 ---------------------------------
3 8
   * shared/misc.c: minor fixes to deamonize() (bb#319), thanks to Reinhard Max
... ...
@@ -59,12 +59,18 @@ target_triplet = @target@
59 59
 DIST_COMMON = README $(am__configure_deps) $(srcdir)/Makefile.am \
60 60
 	$(srcdir)/Makefile.in $(srcdir)/clamav-config.h.in \
61 61
 	$(srcdir)/clamav-config.in $(srcdir)/libclamav.pc.in \
62
-	$(top_srcdir)/configure $(top_srcdir)/docs/man/clamd.8.in \
62
+	$(top_srcdir)/configure \
63
+	$(top_srcdir)/docs/man/clamav-milter.8.in \
64
+	$(top_srcdir)/docs/man/clamconf.1.in \
65
+	$(top_srcdir)/docs/man/clamd.8.in \
63 66
 	$(top_srcdir)/docs/man/clamd.conf.5.in \
67
+	$(top_srcdir)/docs/man/clamdscan.1.in \
68
+	$(top_srcdir)/docs/man/clamscan.1.in \
64 69
 	$(top_srcdir)/docs/man/freshclam.1.in \
65
-	$(top_srcdir)/docs/man/freshclam.conf.5.in AUTHORS COPYING \
66
-	ChangeLog INSTALL NEWS config.guess config.sub depcomp \
67
-	install-sh ltmain.sh missing mkinstalldirs
70
+	$(top_srcdir)/docs/man/freshclam.conf.5.in \
71
+	$(top_srcdir)/docs/man/sigtool.1.in AUTHORS COPYING ChangeLog \
72
+	INSTALL NEWS config.guess config.sub depcomp install-sh \
73
+	ltmain.sh missing mkinstalldirs
68 74
 subdir = .
69 75
 ACLOCAL_M4 = $(top_srcdir)/aclocal.m4
70 76
 am__aclocal_m4_deps = $(top_srcdir)/acinclude.m4 \
... ...
@@ -75,9 +81,11 @@ am__CONFIG_DISTCLEAN_FILES = config.status config.cache config.log \
75 75
  configure.lineno configure.status.lineno
76 76
 mkinstalldirs = $(SHELL) $(top_srcdir)/mkinstalldirs
77 77
 CONFIG_HEADER = clamav-config.h
78
-CONFIG_CLEAN_FILES = clamav-config libclamav.pc docs/man/clamd.8 \
79
-	docs/man/clamd.conf.5 docs/man/freshclam.1 \
80
-	docs/man/freshclam.conf.5
78
+CONFIG_CLEAN_FILES = clamav-config libclamav.pc \
79
+	docs/man/clamav-milter.8 docs/man/clamconf.1 docs/man/clamd.8 \
80
+	docs/man/clamd.conf.5 docs/man/clamdscan.1 docs/man/clamscan.1 \
81
+	docs/man/freshclam.1 docs/man/freshclam.conf.5 \
82
+	docs/man/sigtool.1
81 83
 am__installdirs = "$(DESTDIR)$(bindir)" "$(DESTDIR)$(pkgconfigdir)"
82 84
 binSCRIPT_INSTALL = $(INSTALL_SCRIPT)
83 85
 SCRIPTS = $(bin_SCRIPTS)
... ...
@@ -299,14 +307,24 @@ clamav-config: $(top_builddir)/config.status $(srcdir)/clamav-config.in
299 299
 	cd $(top_builddir) && $(SHELL) ./config.status $@
300 300
 libclamav.pc: $(top_builddir)/config.status $(srcdir)/libclamav.pc.in
301 301
 	cd $(top_builddir) && $(SHELL) ./config.status $@
302
+docs/man/clamav-milter.8: $(top_builddir)/config.status $(top_srcdir)/docs/man/clamav-milter.8.in
303
+	cd $(top_builddir) && $(SHELL) ./config.status $@
304
+docs/man/clamconf.1: $(top_builddir)/config.status $(top_srcdir)/docs/man/clamconf.1.in
305
+	cd $(top_builddir) && $(SHELL) ./config.status $@
302 306
 docs/man/clamd.8: $(top_builddir)/config.status $(top_srcdir)/docs/man/clamd.8.in
303 307
 	cd $(top_builddir) && $(SHELL) ./config.status $@
304 308
 docs/man/clamd.conf.5: $(top_builddir)/config.status $(top_srcdir)/docs/man/clamd.conf.5.in
305 309
 	cd $(top_builddir) && $(SHELL) ./config.status $@
310
+docs/man/clamdscan.1: $(top_builddir)/config.status $(top_srcdir)/docs/man/clamdscan.1.in
311
+	cd $(top_builddir) && $(SHELL) ./config.status $@
312
+docs/man/clamscan.1: $(top_builddir)/config.status $(top_srcdir)/docs/man/clamscan.1.in
313
+	cd $(top_builddir) && $(SHELL) ./config.status $@
306 314
 docs/man/freshclam.1: $(top_builddir)/config.status $(top_srcdir)/docs/man/freshclam.1.in
307 315
 	cd $(top_builddir) && $(SHELL) ./config.status $@
308 316
 docs/man/freshclam.conf.5: $(top_builddir)/config.status $(top_srcdir)/docs/man/freshclam.conf.5.in
309 317
 	cd $(top_builddir) && $(SHELL) ./config.status $@
318
+docs/man/sigtool.1: $(top_builddir)/config.status $(top_srcdir)/docs/man/sigtool.1.in
319
+	cd $(top_builddir) && $(SHELL) ./config.status $@
310 320
 install-binSCRIPTS: $(bin_SCRIPTS)
311 321
 	@$(NORMAL_INSTALL)
312 322
 	test -z "$(bindir)" || $(mkdir_p) "$(DESTDIR)$(bindir)"
... ...
@@ -25906,7 +25906,7 @@ cat >>confdefs.h <<_ACEOF
25906 25906
 _ACEOF
25907 25907
 
25908 25908
 
25909
-ac_config_files="$ac_config_files libclamav/Makefile clamscan/Makefile database/Makefile docs/Makefile clamd/Makefile clamdscan/Makefile clamav-milter/Makefile freshclam/Makefile sigtool/Makefile clamconf/Makefile etc/Makefile Makefile clamav-config libclamav.pc docs/man/clamd.8 docs/man/clamd.conf.5 docs/man/freshclam.1 docs/man/freshclam.conf.5"
25909
+ac_config_files="$ac_config_files libclamav/Makefile clamscan/Makefile database/Makefile docs/Makefile clamd/Makefile clamdscan/Makefile clamav-milter/Makefile freshclam/Makefile sigtool/Makefile clamconf/Makefile etc/Makefile Makefile clamav-config libclamav.pc docs/man/clamav-milter.8 docs/man/clamconf.1 docs/man/clamd.8 docs/man/clamd.conf.5 docs/man/clamdscan.1 docs/man/clamscan.1 docs/man/freshclam.1 docs/man/freshclam.conf.5 docs/man/sigtool.1"
25910 25910
 
25911 25911
 cat >confcache <<\_ACEOF
25912 25912
 # This file is a shell script that caches the results of configure
... ...
@@ -26528,10 +26528,15 @@ do
26528 26528
     "Makefile") CONFIG_FILES="$CONFIG_FILES Makefile" ;;
26529 26529
     "clamav-config") CONFIG_FILES="$CONFIG_FILES clamav-config" ;;
26530 26530
     "libclamav.pc") CONFIG_FILES="$CONFIG_FILES libclamav.pc" ;;
26531
+    "docs/man/clamav-milter.8") CONFIG_FILES="$CONFIG_FILES docs/man/clamav-milter.8" ;;
26532
+    "docs/man/clamconf.1") CONFIG_FILES="$CONFIG_FILES docs/man/clamconf.1" ;;
26531 26533
     "docs/man/clamd.8") CONFIG_FILES="$CONFIG_FILES docs/man/clamd.8" ;;
26532 26534
     "docs/man/clamd.conf.5") CONFIG_FILES="$CONFIG_FILES docs/man/clamd.conf.5" ;;
26535
+    "docs/man/clamdscan.1") CONFIG_FILES="$CONFIG_FILES docs/man/clamdscan.1" ;;
26536
+    "docs/man/clamscan.1") CONFIG_FILES="$CONFIG_FILES docs/man/clamscan.1" ;;
26533 26537
     "docs/man/freshclam.1") CONFIG_FILES="$CONFIG_FILES docs/man/freshclam.1" ;;
26534 26538
     "docs/man/freshclam.conf.5") CONFIG_FILES="$CONFIG_FILES docs/man/freshclam.conf.5" ;;
26539
+    "docs/man/sigtool.1") CONFIG_FILES="$CONFIG_FILES docs/man/sigtool.1" ;;
26535 26540
 
26536 26541
   *) { { echo "$as_me:$LINENO: error: invalid argument: $ac_config_target" >&5
26537 26542
 echo "$as_me: error: invalid argument: $ac_config_target" >&2;}
... ...
@@ -1115,8 +1115,13 @@ etc/Makefile
1115 1115
 Makefile
1116 1116
 clamav-config
1117 1117
 libclamav.pc
1118
+docs/man/clamav-milter.8
1119
+docs/man/clamconf.1
1118 1120
 docs/man/clamd.8
1119 1121
 docs/man/clamd.conf.5
1122
+docs/man/clamdscan.1
1123
+docs/man/clamscan.1
1120 1124
 docs/man/freshclam.1
1121 1125
 docs/man/freshclam.conf.5
1126
+docs/man/sigtool.1
1122 1127
 ])
... ...
@@ -16,5 +16,5 @@
16 16
 #  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
17 17
 #  MA 02110-1301, USA.
18 18
 
19
-EXTRA_DIST = html man clamdoc.pdf clamdoc.tex clamav-mirror-howto.pdf clamav-mirror-howto.tex signatures.pdf signatures.tex clam.eps
19
+EXTRA_DIST = html man/*.in clamdoc.pdf clamdoc.tex clamav-mirror-howto.pdf clamav-mirror-howto.tex signatures.pdf signatures.tex clam.eps
20 20
 man_MANS = man/clamscan.1 man/freshclam.1 man/sigtool.1 man/clamd.8 man/clamd.conf.5 man/clamdscan.1 man/clamav-milter.8 man/freshclam.conf.5 man/clamconf.1
... ...
@@ -199,7 +199,7 @@ target_alias = @target_alias@
199 199
 target_cpu = @target_cpu@
200 200
 target_os = @target_os@
201 201
 target_vendor = @target_vendor@
202
-EXTRA_DIST = html man clamdoc.pdf clamdoc.tex clamav-mirror-howto.pdf clamav-mirror-howto.tex signatures.pdf signatures.tex clam.eps
202
+EXTRA_DIST = html man/*.in clamdoc.pdf clamdoc.tex clamav-mirror-howto.pdf clamav-mirror-howto.tex signatures.pdf signatures.tex clam.eps
203 203
 man_MANS = man/clamscan.1 man/freshclam.1 man/sigtool.1 man/clamd.8 man/clamd.conf.5 man/clamdscan.1 man/clamav-milter.8 man/freshclam.conf.5 man/clamconf.1
204 204
 all: all-am
205 205
 
... ...
@@ -386,6 +386,7 @@ CTAGS:
386 386
 
387 387
 
388 388
 distdir: $(DISTFILES)
389
+	$(mkdir_p) $(distdir)/man
389 390
 	@srcdirstrip=`echo "$(srcdir)" | sed 's|.|.|g'`; \
390 391
 	topsrcdirstrip=`echo "$(top_srcdir)" | sed 's|.|.|g'`; \
391 392
 	list='$(DISTFILES)'; for file in $$list; do \
392 393
deleted file mode 100644
... ...
@@ -1,310 +0,0 @@
1
-.TH "clamav-milter" "8" "March 23, 2004" "" "Clam AntiVirus"
2
-.SH "NAME"
3
-.LP
4
-clamav\-milter \- milter compatible mail scanner
5
-.SH "SYNOPSIS"
6
-.LP
7
-clamav\-milter [options] socket_address
8
-.SH "DESCRIPTION"
9
-.LP
10
-Clamav\-milter is a filter for \fBsendmail(1)\fR mail server.
11
-It uses a mail scanning engine built into \fBclamd(8)\fR.
12
-.LP
13
-Clamav\-milter can use load balancing and fault tolerant techniques to connect
14
-to more than one clamd(8) server and seamlessly hot-swap to even the load
15
-between different machines and to keep scanning for viruses even when a server
16
-goes down.
17
-When it is configured to use clamd on the the localhost, when
18
-the \-\-external flag (see below) is not given or
19
-LocalSocket in set in \fBclamd.conf(5)\fR,
20
-clamav\-milter verifies that it can communicate with clamd; if it cannot, it
21
-terminates.
22
-.LP
23
-clamav\-milter supports tcpwrappers, the value for \fIdaemon_list\fR
24
-is "clamav\-milter".
25
-.LP
26
-The socket_address argument is the socket used to communicate with
27
-\fBsendmail(8)\fR.
28
-It must agree with the entry in sendmail.cf or sendmail.mc.
29
-The file associated with the socket must be creatable by clamav\-milter,
30
-if the User option is set in clamd.conf,
31
-then that user must have the rights to create the file.
32
-.SH "OPTIONS"
33
-.LP
34
-
35
-.TP
36
-\fB-a FROM, \-\-from<=EMAIL>\fR
37
-Source email address of notices. The default is MAILER-DAEMON.
38
-If \fI=EMAIL\fR is not given, thus \-\-from, then the from address is set
39
-to the originating email address, however since it is likely that address is
40
-forged it must not be relied upon.
41
-\fB\-h, \-\-help\fR
42
-Output the help information and exit.
43
-.TP
44
-\fB\-H, \-\-headers\fR
45
-Include all headers in the content of emails generated by clamav\-milter.
46
-This is useful for system administrators who may want to look at headers
47
-to check if any of their machines are infected.
48
-.TP
49
-\fB\-V, \-\-version\fR
50
-Print the version number and exit.
51
-.TP
52
-\fB\-c FILE, \-\-config\-file=FILE\fR
53
-By default clamav\-milter uses a default configuration file, this option allows you to specify another one.
54
-.TP
55
-\fB\-D, \-\-debug\fR
56
-Enables debugging.
57
-.TP
58
-\fB\-x n, \-\-debug\-level=n\fR
59
-Set the debug level to n (where n from [0..9]) if \fBclamav\-milter\fR was
60
-configured and compiled with \-\-clamav-debug enabled.
61
-Will be replaced by \-\-debug for compatibility with other programs in the
62
-suite.
63
-.TP
64
-\fB-A, \-\-advisory\fR
65
-When in advisory mode, clamav\-milter flags emails with viruses but
66
-still forwards them. The default option is to stop viruses.
67
-This mode is incompatible with \-\-quarantine and \-\-quarantine-dir.
68
-.TP
69
-\fB\-b, \-\-bounce\fR
70
-Send a failure message to the sender, and to the postmaster.
71
-[ \fBWarning\fR: most viruses and worms
72
-fake their source address, so this option is not recommended, and needs
73
-to be enabled at compile-time ].
74
-See also \-\-noreject.
75
-.TP
76
-\fB\-B, \-\-broadcast[=<iface>]\fR
77
-When a virus is intercepted, broadcast a UDP message to the TCPSocket port set
78
-in \fBclamd.conf\fR.
79
-If the optional \fIiface\fR option is given, broadcasts will be sent on
80
-that interface. The default is set by the operating system, usually to the
81
-first NIC.
82
-A future network management program (yet to be written) will intercept these
83
-broadcasts to raise a warning on the operator's desk.
84
-.TP
85
-\fB-d, \-\-dont-scan-on-error\fR
86
-If a system error occurs pass messages through unscanned,
87
-usually when a system error occurs the milter raises a temporary failure which
88
-generally causes the message to remain in the queue.
89
-.TP
90
-\fB-f, \-\-force-scan\fR
91
-Always scan, wherever the message came from (see also --local and --outgoing).
92
-You probably don't want this.
93
-.TP
94
-\fB-e, \-\-external\fR
95
-Usually clamav\-milter scans the emails itself without the use of an
96
-external program.
97
-The \-\-external option informs clamav\-milter to use an external program such
98
-as clamd(8) running either on the local server or other server(s) to perform
99
-the scanning.
100
-.TP
101
-\fB\-k, \-\-blacklist-time=time\fR
102
-Tells the number of seconds to black list an IP address (IPv4 only). This
103
-is especially useful with phishing which often send a number of emails one
104
-after the other.
105
-.IP
106
-Blacklisting speeds up scanning significantly, however it does have drawbacks
107
-since it is possible for a site to be incorrectly blacklisted because of DHCP
108
-or an unsafe smart-host.
109
-To avoid this, clamav-milter's blacklist does not last for ever.
110
-The recommended value is 60.
111
-.IP
112
-Machines on the LAN, the local host, and machines that are our MX peers are
113
-never blacklisted.
114
-.TP
115
-\fB\f-K, \-\-dont-blacklist=IP[,IP...]\fR
116
-Instructs clamav-milter to refrain from blacklisting IP the given addresses.
117
-This is useful for sites that receive email from upstream servers that are
118
-either untrusted or have no virus.
119
-Without this option many false positives could occur.
120
-This scenario often happens when the upstream server belongs to an
121
-ISP that may not have AV software.
122
-.TP
123
-\fB-l, \-\-local\fR
124
-Also scan messages sent from LAN. You probably want this especially if
125
-your LAN is populated by machines running Windows or DOS.
126
-.IP
127
-Machines with IP addresses within the ranges 192.168.0.0/16, 10.0.0.0/24,
128
-172.16.0.0/20 and 169.254.0.0/16 are defined as 'local'. Messages from
129
-other machines are always scanned.
130
-An extra IP address may be added with the \-\-ignore option.
131
-.TP
132
-\fB-M, \-\-freshclam-monitor\fR
133
-When not running in external mode, this option tells clamav\-milter how
134
-often to check that the virus database has been updated, probably by
135
-freshclam(1).
136
-The option takes one parameter, which is a number in seconds.
137
-The default is 300 seconds.
138
-The checking cannot be disabled, a value less than or equal to zero will be
139
-rejected.
140
-.TP
141
-\fB-n, \-\-noxheader\fR
142
-Usually clamav\-milter adds headings to messages that are scanned.
143
-The headers are of the form "X-Virus-Scanned: version",
144
-and "X-Virus-Status: clean/infected/not-scanned".
145
-This option instructs
146
-clamav\-milter to refrain from adding this heading.
147
-.TP
148
-\fB-N, \-\-noreject\fR
149
-When clamav\-milter processes an e-mail which contains a virus it rejects
150
-the e-mail by using the SMTP code 550 or 554 depending on the state machine.
151
-This option causes clamav\-milter to silently discard such messages.
152
-It is recommended that system administrators use this option when NOT using
153
-the \-\-bounce option.
154
-.TP
155
-\fB-o, \-\-outgoing\fR
156
-Scan messages generated from this machine. You probably don't need this.
157
-.TP
158
-\fB-i, \-\-pidfile=FILE\fR
159
-Notifies clamav\-milter to store its process ID in FILE.
160
-The file must be creatable by clamav\-milter,
161
-if the User option is set in
162
-\fBclamd.conf(5)\fR,
163
-then that user must have the rights to create the file.
164
-.TP
165
-\fB-p, \-\-postmaster=EMAILADDRESS\fR
166
-Sets the e-mail address that receives notifications of viruses caught,
167
-when the \-\-quiet option is not given.
168
-.TP
169
-\fB-P, \-\-postmaster-only\fR
170
-When the \-\-quiet option is not given, send a notification to the postmaster.
171
-Setting this flag will include the ID of the message in the email's body
172
-which can ease searching through system logs if the administrator believes it
173
-is a locally sourced virus.
174
-Without this option, the intended recipient of the email will also receive a
175
-copy of the notification of the interception.
176
-.TP
177
-\fB-q, \-\-quiet\fR
178
-Don't send any notification messages when a virus or worm is detected.
179
-This option overrides the \-\-bounce and \-\-postmaster-only options, and is
180
-the way to turn off notification to the postmaster.
181
-.TP
182
-\fB-Q, \-\-quarantine=EMAILADDRESS\fR
183
-If this e-mail address is given, messages containing a virus or worm are
184
-redirected to it.
185
-.TP
186
-\fB-r, \-\-report-phish=EMAILADDRESS\fR
187
-Report caught phishing to an anti-phish organisation's email address such
188
-as pirt_clamav@castlecops.com and reportphishing@antiphishing.org.
189
-.TP
190
-\fB-U, \-\-quarantine-dir=DIR\fR
191
-If this option is given, infected files are left in this directory.
192
-The directory must not be publicly readable or writable, if it is,
193
-clamav\-milter will issue an error and fail to start.
194
-\fBNote\fR - this option only works when using LocalSocket.
195
-.TP
196
-\fB\-\-server=HOSTNAME/ADDRESS, \-s HOSTNAME/ADDRESS\fR
197
-IP address or hostname of server(s) running clamd (when using TCPsocket and
198
-\-\-external).
199
-More than one server may be specified, separating the server's names by colons.
200
-If more than one server is specified, clamav\-milter will load balance
201
-between the available servers. All the servers must be up when clamav\-milter
202
-starts, however afterwards it is fault tolerant to a server becoming
203
-unavailable, and will only raise an error if all of the servers cannot be
204
-reached.
205
-The default value for ADDRESS is 127.0.0.1 (localhost).
206
-.TP
207
-\fB\-\-sign, \-S\fR
208
-Add a hard\-coded signature to each scanned file. It is likely that this
209
-signature will only display on the end user's terminal if the message is
210
-plain/text or not encoded.
211
-.TP
212
-\fB\-\-signature-file, \-F\fR
213
-Location of file to be appended to each scanned message. Overrides \-S.
214
-.TP
215
-\fB\-\-max\-children=n, \-m n\fR
216
-Set a hint of the maximum number of children. If the number is hit the
217
-maximum time a pending thread will be held up is set by \-\-timeout, so the
218
-number of threads can exceed this number for short periods of time.
219
-There is no default, if this argument is not \fBclamav\-milter\fR will
220
-spawn as many children as is necessary up to the MaxThreads limit set
221
-in \fBclamd.conf\fR.
222
-When clamav\-milter has been built with SESSION mode this argument is
223
-mandatory since it tells clamav\-milter the number of sessions to keep open
224
-to clamd servers.
225
-When not built with in SESSION mode it is unlikely that you will need this
226
-unless your system is under great load.
227
-Note, however, that the default build is for SESSION to be disabled.
228
-.TP
229
-\fB\-\-dont\-wait\fR
230
-Tells clamav\-milter what do to if the max-children number is exceeded.
231
-Usually clamav\-milter waits until a child dies or the timeout value has been
232
-exceeded, which ever comes first, however with dont-wait enabled, clamav\-milter
233
-will inform the remote SMTP client to retry later.
234
-.TP
235
-\fB\-\-ignore ipAddr\fR
236
-\fIipAddr\fR is taken to be an extra IPv4 address which is treated as being on
237
-the LAN for the purposes of the \-\-local argument.
238
-.TP
239
-\fB\-\-template\-file=file \-t file\fR
240
-File points to a file whose contents is sent as the warning message whenever a
241
-virus is intercepted.
242
-Occurrences of %v within the file is replaced with the message
243
-returned from clamd, which includes the name of the virus.
244
-Occurrences of %h are replaced with the message's headers.
245
-The %v string can be escaped thus, \\%v, to send the string %v.
246
-The % character can be escaped thus, %%, to send the % character.
247
-Any occurrence of strings in dollar signs are replaced with the appropriate
248
-sendmail-variable, e.g. ${if_addr}$.
249
-If the \-t option is not given, clamav\-milter defaults to a hard-coded message.
250
-Note that to send warning messages, clamav\-milter must be able to execute
251
-sendmail.
252
-.TP
253
-\fB\-\-template\-headers=file\fR
254
-File points to a file whose contents are added to the headers of the
255
-warning message given to the \fB\-\-template\-file\fR option.
256
-For example, to state the character set of the message,
257
-put "Content-Type: text/plain; charset=koi8-r" into the file.
258
-.TP
259
-\fB\-\-timeout=n \-T n\fR
260
-Used in conjunction with max\-children. If clamav\-milter waits for more than
261
-\fIn\fR seconds (default 300) it proceeds with scanning. Setting \fIn\fR to zero
262
-will turn off the timeout and clamav\-milter will wait indefinitely for the
263
-scanning to quit. In practice the timeout set by sendmail will then take over.
264
-.TP
265
-\fB\-\-detect-forged-local-address \-L\fR
266
-When neither \-\-force, \-\-local nor \-\-outgoing is given,
267
-this option intercepts incoming mails that incorrectly claim to be from the
268
-local domain.
269
-.TP
270
-\fB\-\-whitelist-file=FILE, \-W file\fR
271
-This option specifies a file which contains a list of e-mail addresses.
272
-E-mails sent to or from these addresses will NOT be checked.
273
-While this is not an Anti-Virus function, it is quite useful for some systems.
274
-The address given to the \-\-quarantine directive is always whitelisted.
275
-.IP
276
-The file consists of a list of addresses, each address on a line enclosed
277
-in angle brackets (e.g. <foo@bar.com>).
278
-Optionally each line can start with the string \fITo:\fR or \fIFrom:\fR
279
-indicating if it is the sender or recipient that is to be whitelisted. If the
280
-field is missing, the default is \fITo\fR.
281
-Lines starting with #, : or ! are ignored.
282
-.TP
283
-\fB\-\-sendmail-cf=FILE\fR
284
-When starting, clamav\-milter runs some sanity checks against the sendmail.cf
285
-file, usually in /etc/sendmail.cf or /etc/mail/sendmail.cf. This directive
286
-tells clamav\-milter where to find the sendmail.cf file.
287
-.TP
288
-\fB\-\-black-hole-mode\fR
289
-Since \fIsendmail\fR calls its milters before it looks in its alias and virtuser
290
-tables, clamav-milter can spend time looking for malware that's going to be
291
-thrown away even if the message is clean.
292
-.IP
293
-Enable this to not scan these messages (in practice clamav\-milter will discard
294
-these messages so the message doesn't go further down the milter call chain).
295
-.IP
296
-Sadly, these days sendmail \-bv only works as root,
297
-so this option is not compatible with the User directive in clamd.conf,
298
-which some may view as a security risk.
299
-Only enable this if your site has many addresses aliased to /dev/null.
300
-.SH "BUGS"
301
-There is no support for IPv6.
302
-.SH "EXAMPLES"
303
-.LP
304
-clamav\-milter \-o local:/var/run/clamav/clmilter.sock
305
-.SH "AUTHOR"
306
-.LP
307
-Nigel Horne <njh@bandsman.co.uk>
308
-.SH "SEE ALSO"
309
-.LP
310
-sendmail(1), clamd(8), clamscan(1), freshclam(1), sigtool(1), clamd.conf(5), hosts_access(5)
311 1
new file mode 100644
... ...
@@ -0,0 +1,310 @@
0
+.TH "clamav-milter" "8" "March 23, 2004" "ClamAV @VERSION@" "Clam AntiVirus"
1
+.SH "NAME"
2
+.LP
3
+clamav\-milter \- milter compatible mail scanner
4
+.SH "SYNOPSIS"
5
+.LP
6
+clamav\-milter [options] socket_address
7
+.SH "DESCRIPTION"
8
+.LP
9
+Clamav\-milter is a filter for \fBsendmail(1)\fR mail server.
10
+It uses a mail scanning engine built into \fBclamd(8)\fR.
11
+.LP
12
+Clamav\-milter can use load balancing and fault tolerant techniques to connect
13
+to more than one clamd(8) server and seamlessly hot-swap to even the load
14
+between different machines and to keep scanning for viruses even when a server
15
+goes down.
16
+When it is configured to use clamd on the the localhost, when
17
+the \-\-external flag (see below) is not given or
18
+LocalSocket in set in \fBclamd.conf(5)\fR,
19
+clamav\-milter verifies that it can communicate with clamd; if it cannot, it
20
+terminates.
21
+.LP
22
+clamav\-milter supports tcpwrappers, the value for \fIdaemon_list\fR
23
+is "clamav\-milter".
24
+.LP
25
+The socket_address argument is the socket used to communicate with
26
+\fBsendmail(8)\fR.
27
+It must agree with the entry in sendmail.cf or sendmail.mc.
28
+The file associated with the socket must be creatable by clamav\-milter,
29
+if the User option is set in clamd.conf,
30
+then that user must have the rights to create the file.
31
+.SH "OPTIONS"
32
+.LP
33
+
34
+.TP
35
+\fB-a FROM, \-\-from<=EMAIL>\fR
36
+Source email address of notices. The default is MAILER-DAEMON.
37
+If \fI=EMAIL\fR is not given, thus \-\-from, then the from address is set
38
+to the originating email address, however since it is likely that address is
39
+forged it must not be relied upon.
40
+\fB\-h, \-\-help\fR
41
+Output the help information and exit.
42
+.TP
43
+\fB\-H, \-\-headers\fR
44
+Include all headers in the content of emails generated by clamav\-milter.
45
+This is useful for system administrators who may want to look at headers
46
+to check if any of their machines are infected.
47
+.TP
48
+\fB\-V, \-\-version\fR
49
+Print the version number and exit.
50
+.TP
51
+\fB\-c FILE, \-\-config\-file=FILE\fR
52
+By default clamav\-milter uses a default configuration file, this option allows you to specify another one.
53
+.TP
54
+\fB\-D, \-\-debug\fR
55
+Enables debugging.
56
+.TP
57
+\fB\-x n, \-\-debug\-level=n\fR
58
+Set the debug level to n (where n from [0..9]) if \fBclamav\-milter\fR was
59
+configured and compiled with \-\-clamav-debug enabled.
60
+Will be replaced by \-\-debug for compatibility with other programs in the
61
+suite.
62
+.TP
63
+\fB-A, \-\-advisory\fR
64
+When in advisory mode, clamav\-milter flags emails with viruses but
65
+still forwards them. The default option is to stop viruses.
66
+This mode is incompatible with \-\-quarantine and \-\-quarantine-dir.
67
+.TP
68
+\fB\-b, \-\-bounce\fR
69
+Send a failure message to the sender, and to the postmaster.
70
+[ \fBWarning\fR: most viruses and worms
71
+fake their source address, so this option is not recommended, and needs
72
+to be enabled at compile-time ].
73
+See also \-\-noreject.
74
+.TP
75
+\fB\-B, \-\-broadcast[=<iface>]\fR
76
+When a virus is intercepted, broadcast a UDP message to the TCPSocket port set
77
+in \fBclamd.conf\fR.
78
+If the optional \fIiface\fR option is given, broadcasts will be sent on
79
+that interface. The default is set by the operating system, usually to the
80
+first NIC.
81
+A future network management program (yet to be written) will intercept these
82
+broadcasts to raise a warning on the operator's desk.
83
+.TP
84
+\fB-d, \-\-dont-scan-on-error\fR
85
+If a system error occurs pass messages through unscanned,
86
+usually when a system error occurs the milter raises a temporary failure which
87
+generally causes the message to remain in the queue.
88
+.TP
89
+\fB-f, \-\-force-scan\fR
90
+Always scan, wherever the message came from (see also --local and --outgoing).
91
+You probably don't want this.
92
+.TP
93
+\fB-e, \-\-external\fR
94
+Usually clamav\-milter scans the emails itself without the use of an
95
+external program.
96
+The \-\-external option informs clamav\-milter to use an external program such
97
+as clamd(8) running either on the local server or other server(s) to perform
98
+the scanning.
99
+.TP
100
+\fB\-k, \-\-blacklist-time=time\fR
101
+Tells the number of seconds to black list an IP address (IPv4 only). This
102
+is especially useful with phishing which often send a number of emails one
103
+after the other.
104
+.IP
105
+Blacklisting speeds up scanning significantly, however it does have drawbacks
106
+since it is possible for a site to be incorrectly blacklisted because of DHCP
107
+or an unsafe smart-host.
108
+To avoid this, clamav-milter's blacklist does not last for ever.
109
+The recommended value is 60.
110
+.IP
111
+Machines on the LAN, the local host, and machines that are our MX peers are
112
+never blacklisted.
113
+.TP
114
+\fB\f-K, \-\-dont-blacklist=IP[,IP...]\fR
115
+Instructs clamav-milter to refrain from blacklisting IP the given addresses.
116
+This is useful for sites that receive email from upstream servers that are
117
+either untrusted or have no virus.
118
+Without this option many false positives could occur.
119
+This scenario often happens when the upstream server belongs to an
120
+ISP that may not have AV software.
121
+.TP
122
+\fB-l, \-\-local\fR
123
+Also scan messages sent from LAN. You probably want this especially if
124
+your LAN is populated by machines running Windows or DOS.
125
+.IP
126
+Machines with IP addresses within the ranges 192.168.0.0/16, 10.0.0.0/24,
127
+172.16.0.0/20 and 169.254.0.0/16 are defined as 'local'. Messages from
128
+other machines are always scanned.
129
+An extra IP address may be added with the \-\-ignore option.
130
+.TP
131
+\fB-M, \-\-freshclam-monitor\fR
132
+When not running in external mode, this option tells clamav\-milter how
133
+often to check that the virus database has been updated, probably by
134
+freshclam(1).
135
+The option takes one parameter, which is a number in seconds.
136
+The default is 300 seconds.
137
+The checking cannot be disabled, a value less than or equal to zero will be
138
+rejected.
139
+.TP
140
+\fB-n, \-\-noxheader\fR
141
+Usually clamav\-milter adds headings to messages that are scanned.
142
+The headers are of the form "X-Virus-Scanned: version",
143
+and "X-Virus-Status: clean/infected/not-scanned".
144
+This option instructs
145
+clamav\-milter to refrain from adding this heading.
146
+.TP
147
+\fB-N, \-\-noreject\fR
148
+When clamav\-milter processes an e-mail which contains a virus it rejects
149
+the e-mail by using the SMTP code 550 or 554 depending on the state machine.
150
+This option causes clamav\-milter to silently discard such messages.
151
+It is recommended that system administrators use this option when NOT using
152
+the \-\-bounce option.
153
+.TP
154
+\fB-o, \-\-outgoing\fR
155
+Scan messages generated from this machine. You probably don't need this.
156
+.TP
157
+\fB-i, \-\-pidfile=FILE\fR
158
+Notifies clamav\-milter to store its process ID in FILE.
159
+The file must be creatable by clamav\-milter,
160
+if the User option is set in
161
+\fBclamd.conf(5)\fR,
162
+then that user must have the rights to create the file.
163
+.TP
164
+\fB-p, \-\-postmaster=EMAILADDRESS\fR
165
+Sets the e-mail address that receives notifications of viruses caught,
166
+when the \-\-quiet option is not given.
167
+.TP
168
+\fB-P, \-\-postmaster-only\fR
169
+When the \-\-quiet option is not given, send a notification to the postmaster.
170
+Setting this flag will include the ID of the message in the email's body
171
+which can ease searching through system logs if the administrator believes it
172
+is a locally sourced virus.
173
+Without this option, the intended recipient of the email will also receive a
174
+copy of the notification of the interception.
175
+.TP
176
+\fB-q, \-\-quiet\fR
177
+Don't send any notification messages when a virus or worm is detected.
178
+This option overrides the \-\-bounce and \-\-postmaster-only options, and is
179
+the way to turn off notification to the postmaster.
180
+.TP
181
+\fB-Q, \-\-quarantine=EMAILADDRESS\fR
182
+If this e-mail address is given, messages containing a virus or worm are
183
+redirected to it.
184
+.TP
185
+\fB-r, \-\-report-phish=EMAILADDRESS\fR
186
+Report caught phishing to an anti-phish organisation's email address such
187
+as pirt_clamav@castlecops.com and reportphishing@antiphishing.org.
188
+.TP
189
+\fB-U, \-\-quarantine-dir=DIR\fR
190
+If this option is given, infected files are left in this directory.
191
+The directory must not be publicly readable or writable, if it is,
192
+clamav\-milter will issue an error and fail to start.
193
+\fBNote\fR - this option only works when using LocalSocket.
194
+.TP
195
+\fB\-\-server=HOSTNAME/ADDRESS, \-s HOSTNAME/ADDRESS\fR
196
+IP address or hostname of server(s) running clamd (when using TCPsocket and
197
+\-\-external).
198
+More than one server may be specified, separating the server's names by colons.
199
+If more than one server is specified, clamav\-milter will load balance
200
+between the available servers. All the servers must be up when clamav\-milter
201
+starts, however afterwards it is fault tolerant to a server becoming
202
+unavailable, and will only raise an error if all of the servers cannot be
203
+reached.
204
+The default value for ADDRESS is 127.0.0.1 (localhost).
205
+.TP
206
+\fB\-\-sign, \-S\fR
207
+Add a hard\-coded signature to each scanned file. It is likely that this
208
+signature will only display on the end user's terminal if the message is
209
+plain/text or not encoded.
210
+.TP
211
+\fB\-\-signature-file, \-F\fR
212
+Location of file to be appended to each scanned message. Overrides \-S.
213
+.TP
214
+\fB\-\-max\-children=n, \-m n\fR
215
+Set a hint of the maximum number of children. If the number is hit the
216
+maximum time a pending thread will be held up is set by \-\-timeout, so the
217
+number of threads can exceed this number for short periods of time.
218
+There is no default, if this argument is not \fBclamav\-milter\fR will
219
+spawn as many children as is necessary up to the MaxThreads limit set
220
+in \fBclamd.conf\fR.
221
+When clamav\-milter has been built with SESSION mode this argument is
222
+mandatory since it tells clamav\-milter the number of sessions to keep open
223
+to clamd servers.
224
+When not built with in SESSION mode it is unlikely that you will need this
225
+unless your system is under great load.
226
+Note, however, that the default build is for SESSION to be disabled.
227
+.TP
228
+\fB\-\-dont\-wait\fR
229
+Tells clamav\-milter what do to if the max-children number is exceeded.
230
+Usually clamav\-milter waits until a child dies or the timeout value has been
231
+exceeded, which ever comes first, however with dont-wait enabled, clamav\-milter
232
+will inform the remote SMTP client to retry later.
233
+.TP
234
+\fB\-\-ignore ipAddr\fR
235
+\fIipAddr\fR is taken to be an extra IPv4 address which is treated as being on
236
+the LAN for the purposes of the \-\-local argument.
237
+.TP
238
+\fB\-\-template\-file=file \-t file\fR
239
+File points to a file whose contents is sent as the warning message whenever a
240
+virus is intercepted.
241
+Occurrences of %v within the file is replaced with the message
242
+returned from clamd, which includes the name of the virus.
243
+Occurrences of %h are replaced with the message's headers.
244
+The %v string can be escaped thus, \\%v, to send the string %v.
245
+The % character can be escaped thus, %%, to send the % character.
246
+Any occurrence of strings in dollar signs are replaced with the appropriate
247
+sendmail-variable, e.g. ${if_addr}$.
248
+If the \-t option is not given, clamav\-milter defaults to a hard-coded message.
249
+Note that to send warning messages, clamav\-milter must be able to execute
250
+sendmail.
251
+.TP
252
+\fB\-\-template\-headers=file\fR
253
+File points to a file whose contents are added to the headers of the
254
+warning message given to the \fB\-\-template\-file\fR option.
255
+For example, to state the character set of the message,
256
+put "Content-Type: text/plain; charset=koi8-r" into the file.
257
+.TP
258
+\fB\-\-timeout=n \-T n\fR
259
+Used in conjunction with max\-children. If clamav\-milter waits for more than
260
+\fIn\fR seconds (default 300) it proceeds with scanning. Setting \fIn\fR to zero
261
+will turn off the timeout and clamav\-milter will wait indefinitely for the
262
+scanning to quit. In practice the timeout set by sendmail will then take over.
263
+.TP
264
+\fB\-\-detect-forged-local-address \-L\fR
265
+When neither \-\-force, \-\-local nor \-\-outgoing is given,
266
+this option intercepts incoming mails that incorrectly claim to be from the
267
+local domain.
268
+.TP
269
+\fB\-\-whitelist-file=FILE, \-W file\fR
270
+This option specifies a file which contains a list of e-mail addresses.
271
+E-mails sent to or from these addresses will NOT be checked.
272
+While this is not an Anti-Virus function, it is quite useful for some systems.
273
+The address given to the \-\-quarantine directive is always whitelisted.
274
+.IP
275
+The file consists of a list of addresses, each address on a line enclosed
276
+in angle brackets (e.g. <foo@bar.com>).
277
+Optionally each line can start with the string \fITo:\fR or \fIFrom:\fR
278
+indicating if it is the sender or recipient that is to be whitelisted. If the
279
+field is missing, the default is \fITo\fR.
280
+Lines starting with #, : or ! are ignored.
281
+.TP
282
+\fB\-\-sendmail-cf=FILE\fR
283
+When starting, clamav\-milter runs some sanity checks against the sendmail.cf
284
+file, usually in /etc/sendmail.cf or /etc/mail/sendmail.cf. This directive
285
+tells clamav\-milter where to find the sendmail.cf file.
286
+.TP
287
+\fB\-\-black-hole-mode\fR
288
+Since \fIsendmail\fR calls its milters before it looks in its alias and virtuser
289
+tables, clamav-milter can spend time looking for malware that's going to be
290
+thrown away even if the message is clean.
291
+.IP
292
+Enable this to not scan these messages (in practice clamav\-milter will discard
293
+these messages so the message doesn't go further down the milter call chain).
294
+.IP
295
+Sadly, these days sendmail \-bv only works as root,
296
+so this option is not compatible with the User directive in clamd.conf,
297
+which some may view as a security risk.
298
+Only enable this if your site has many addresses aliased to /dev/null.
299
+.SH "BUGS"
300
+There is no support for IPv6.
301
+.SH "EXAMPLES"
302
+.LP
303
+clamav\-milter \-o local:/var/run/clamav/clmilter.sock
304
+.SH "AUTHOR"
305
+.LP
306
+Nigel Horne <njh@bandsman.co.uk>
307
+.SH "SEE ALSO"
308
+.LP
309
+sendmail(1), clamd(8), clamscan(1), freshclam(1), sigtool(1), clamd.conf(5), hosts_access(5)
0 310
deleted file mode 100644
... ...
@@ -1,30 +0,0 @@
1
-.TH "Config tool" "1" "February 12, 2007" "ClamAV 0.90" "Clam AntiVirus"
2
-.SH "NAME"
3
-.LP 
4
-clamconf \- Clam AntiVirus configuration utility
5
-.SH "SYNOPSIS"
6
-.LP 
7
-clamconf [options]
8
-.SH "DESCRIPTION"
9
-.LP 
10
-clamconf displays the values of configuration options.
11
-.SH "OPTIONS"
12
-.LP 
13
-
14
-.TP 
15
-\fB\-h, \-\-help\fR
16
-Display help and exit.
17
-.TP 
18
-\fB\-c DIR, \-\-config\-dir DIR\fR
19
-Search for configuration files clamd.conf and freshclam.conf in DIR.
20
-.TP 
21
-\fB\-n, \-\-non\-default\fR
22
-Only print non-default settings.
23
-.SH "CREDITS"
24
-The idea of this tool is based on Postfix's postconf. clamconf was created under pressure from Tomasz Papszun ;-)
25
-.SH "AUTHOR"
26
-.LP 
27
-Tomasz Kojm <tkojm@clamav.net>
28
-.SH "SEE ALSO"
29
-.LP 
30
-clamd.conf(5), freshclam.conf(5)
31 1
new file mode 100644
... ...
@@ -0,0 +1,30 @@
0
+.TH "Config tool" "1" "February 12, 2007" "ClamAV @VERSION@" "Clam AntiVirus"
1
+.SH "NAME"
2
+.LP 
3
+clamconf \- Clam AntiVirus configuration utility
4
+.SH "SYNOPSIS"
5
+.LP 
6
+clamconf [options]
7
+.SH "DESCRIPTION"
8
+.LP 
9
+clamconf displays the values of configuration options.
10
+.SH "OPTIONS"
11
+.LP 
12
+
13
+.TP 
14
+\fB\-h, \-\-help\fR
15
+Display help and exit.
16
+.TP 
17
+\fB\-c DIR, \-\-config\-dir DIR\fR
18
+Search for configuration files clamd.conf and freshclam.conf in DIR.
19
+.TP 
20
+\fB\-n, \-\-non\-default\fR
21
+Only print non-default settings.
22
+.SH "CREDITS"
23
+The idea of this tool is based on Postfix's postconf. clamconf was created under pressure from Tomasz Papszun ;-)
24
+.SH "AUTHOR"
25
+.LP 
26
+Tomasz Kojm <tkojm@clamav.net>
27
+.SH "SEE ALSO"
28
+.LP 
29
+clamd.conf(5), freshclam.conf(5)
... ...
@@ -1,4 +1,4 @@
1
-.TH "Clam Daemon" "8" "February 12, 2007" "ClamAV 0.90" "Clam AntiVirus"
1
+.TH "Clam Daemon" "8" "February 12, 2007" "ClamAV @VERSION@" "Clam AntiVirus"
2 2
 .SH "NAME"
3 3
 .LP 
4 4
 clamd \- an anti\-virus daemon
... ...
@@ -1,4 +1,4 @@
1
-.TH "clamd.conf" "5" "February 12, 2007" "ClamAV 0.90" "Clam AntiVirus"
1
+.TH "clamd.conf" "5" "February 12, 2007" "ClamAV @VERSION@" "Clam AntiVirus"
2 2
 .SH "NAME"
3 3
 .LP 
4 4
 \fBclamd.conf\fR \- Configuration file for Clam AntiVirus Daemon
5 5
deleted file mode 100644
... ...
@@ -1,75 +0,0 @@
1
-.TH "Clamd client" "1" "February 12, 2007" "ClamAV 0.90" "Clam AntiVirus"
2
-.SH "NAME"
3
-.LP 
4
-clamdscan \- scan files and directories for viruses using Clam AntiVirus Daemon
5
-.SH "SYNOPSIS"
6
-.LP 
7
-clamdscan [options] [file/directory]
8
-.SH "DESCRIPTION"
9
-.LP 
10
-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.
11
-.SH "OPTIONS"
12
-.LP 
13
-
14
-.TP 
15
-\fB\-h, \-\-help\fR
16
-Display help information and exit.
17
-.TP 
18
-\fB\-V, \-\-version\fR
19
-Print version number and exit.
20
-.TP 
21
-\fB\-v, \-\-verbose\fR
22
-Be verbose.
23
-.TP 
24
-\fB\-\-quiet\fR
25
-Be quiet \- only output error messages.
26
-.TP 
27
-\fB\-\-stdout\fR
28
-Write all messages (except for libclamav output) to the standard output (stdout).
29
-.TP 
30
-\fB\-\-config\-file=FILE\fR
31
-Read clamd settings from FILE.
32
-.TP 
33
-\fB\-l FILE, \-\-log=FILE\fR
34
-Save the scan report to FILE.
35
-.TP 
36
-\fB\-m, \-\-multiscan\fR
37
-Always use MULTISCAN instead of CONTSCAN.
38
-.TP
39
-\fB\-\-remove\fR
40
-Remove infected files. \fBBe careful.\fR
41
-.TP 
42
-\fB\-\-move=DIRECTORY\fR
43
-Move infected files into DIRECTORY.
44
-.TP 
45
-\fB\-\-no\-summary\fR
46
-Do not display summary at the end of scanning.
47
-.SH "EXAMPLES"
48
-.LP 
49
-.TP 
50
-(0) To scan a one file:
51
-
52
-\fBclamdscan file\fR
53
-.TP 
54
-(1) To scan a current working directory:
55
-
56
-\fBclamdscan\fR
57
-.TP 
58
-(2) To scan all files in /home:
59
-
60
-\fBclamdscan /home\fR
61
-.SH "RETURN CODES"
62
-.LP 
63
-0 : No virus found.
64
-.TP 
65
-1 : Virus(es) found.
66
-.TP 
67
-2 : An error occured.
68
-.SH "CREDITS"
69
-Please check the full documentation for credits.
70
-.SH "AUTHOR"
71
-.LP 
72
-Tomasz Kojm <tkojm@clamav.net>
73
-.SH "SEE ALSO"
74
-.LP 
75
-clamd(8), clamd.conf(5), clamscan(1), freshclam(1)
76 1
new file mode 100644
... ...
@@ -0,0 +1,75 @@
0
+.TH "Clamd client" "1" "February 12, 2007" "ClamAV @VERSION@" "Clam AntiVirus"
1
+.SH "NAME"
2
+.LP 
3
+clamdscan \- scan files and directories for viruses using Clam AntiVirus Daemon
4
+.SH "SYNOPSIS"
5
+.LP 
6
+clamdscan [options] [file/directory]
7
+.SH "DESCRIPTION"
8
+.LP 
9
+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.
10
+.SH "OPTIONS"
11
+.LP 
12
+
13
+.TP 
14
+\fB\-h, \-\-help\fR
15
+Display help information and exit.
16
+.TP 
17
+\fB\-V, \-\-version\fR
18
+Print version number and exit.
19
+.TP 
20
+\fB\-v, \-\-verbose\fR
21
+Be verbose.
22
+.TP 
23
+\fB\-\-quiet\fR
24
+Be quiet \- only output error messages.
25
+.TP 
26
+\fB\-\-stdout\fR
27
+Write all messages (except for libclamav output) to the standard output (stdout).
28
+.TP 
29
+\fB\-\-config\-file=FILE\fR
30
+Read clamd settings from FILE.
31
+.TP 
32
+\fB\-l FILE, \-\-log=FILE\fR
33
+Save the scan report to FILE.
34
+.TP 
35
+\fB\-m, \-\-multiscan\fR
36
+Always use MULTISCAN instead of CONTSCAN.
37
+.TP
38
+\fB\-\-remove\fR
39
+Remove infected files. \fBBe careful.\fR
40
+.TP 
41
+\fB\-\-move=DIRECTORY\fR
42
+Move infected files into DIRECTORY.
43
+.TP 
44
+\fB\-\-no\-summary\fR
45
+Do not display summary at the end of scanning.
46
+.SH "EXAMPLES"
47
+.LP 
48
+.TP 
49
+(0) To scan a one file:
50
+
51
+\fBclamdscan file\fR
52
+.TP 
53
+(1) To scan a current working directory:
54
+
55
+\fBclamdscan\fR
56
+.TP 
57
+(2) To scan all files in /home:
58
+
59
+\fBclamdscan /home\fR
60
+.SH "RETURN CODES"
61
+.LP 
62
+0 : No virus found.
63
+.TP 
64
+1 : Virus(es) found.
65
+.TP 
66
+2 : An error occured.
67
+.SH "CREDITS"
68
+Please check the full documentation for credits.
69
+.SH "AUTHOR"
70
+.LP 
71
+Tomasz Kojm <tkojm@clamav.net>
72
+.SH "SEE ALSO"
73
+.LP 
74
+clamd(8), clamd.conf(5), clamscan(1), freshclam(1)
0 75
deleted file mode 100644
... ...
@@ -1,241 +0,0 @@
1
-.TH "clamscan" "1" "February 12, 2007" "ClamAV 0.90" "Clam AntiVirus"
2
-.SH "NAME"
3
-.LP 
4
-clamscan \- scan files and directories for viruses
5
-.SH "SYNOPSIS"
6
-.LP 
7
-clamscan [options] [file/directory/\-]
8
-.SH "DESCRIPTION"
9
-.LP 
10
-clamscan is a command line anti\-virus scanner.
11
-.SH "OPTIONS"
12
-.LP 
13
-
14
-.TP 
15
-\fB\-h, \-\-help\fR
16
-Print help information and exit.
17
-.TP 
18
-\fB\-V, \-\-version\fR
19
-Print version number and exit.
20
-.TP 
21
-\fB\-v, \-\-verbose\fR
22
-Be verbose.
23
-.TP 
24
-\fB\-\-debug\fR
25
-Display debug messages from libclamav.
26
-.TP 
27
-\fB\-\-quiet\fR
28
-Be quiet (only print error messages).
29
-.TP 
30
-\fB\-\-stdout\fR
31
-Write all messages (except for libclamav output) to the standard output (stdout).
32
-.TP 
33
-\fB\-d FILE/DIR, \-\-database=FILE/DIR\fR
34
-Load virus database from FILE or load all virus database files from DIR.
35
-.TP 
36
-\fB\-l FILE, \-\-log=FILE\fR
37
-Save scan report to FILE.
38
-.TP 
39
-\fB\-\-tempdir=DIRECTORY\fR
40
-Create temporary files in DIRECTORY. Directory must be writable for the 'clamav' user or unprivileged user running clamscan.
41
-.TP 
42
-\fB\-\-leave\-temps\fR
43
-Do not remove temporary files.
44
-.TP 
45
-\fB\-r, \-\-recursive\fR
46
-Scan directories recursively. All the subdirectories in the given directory will be scanned.
47
-.TP 
48
-\fB\-\-bell\fR
49
-Sound bell on virus detection.
50
-.TP 
51
-\fB\-\-no\-summary\fR
52
-Do not display summary at the end of scanning.
53
-.TP 
54
-\fB\-\-exclude=PATT, \-\-exclude\-dir=PATT\fR
55
-Don't scan file/directory names containing PATT. It may be used multiple times.
56
-.TP 
57
-\fB\-\-include=PATT, \-\-include\-dir=PATT\fR
58
-Only scan file/directory names containing PATT. It may be used multiple times.
59
-.TP 
60
-\fB\-i, \-\-infected\fR
61
-Only print infected files.
62
-.TP 
63
-\fB\-\-remove\fR
64
-Remove infected files. \fBBe careful.\fR
65
-.TP 
66
-\fB\-\-move=DIRECTORY\fR
67
-Move infected files into DIRECTORY. Directory must be writable for the 'clamav' user or unprivileged user running clamscan.
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 
72
-\fB\-\-no\-mail\fR
73
-Disable scanning of mail files.
74
-.TP 
75
-\fB\-\-no\-phishing\-sigs\fR
76
-Disable signature-based phishing detection.
77
-.TP 
78
-\fB\-\-no\-phishing\-scan\-urls\fR
79
-Disable url-based phishing detection. (Only available in experimental builds)
80
-.TP
81
-\fB\-\-no\-phishing\-restrictedscan\fR
82
-Enable phishing detection for all domains (might lead to false positives!).(Only available in experimental builds)
83
-.TP
84
-\fB\-\-phishing\-ssl\fR
85
-Always block SSL mismatches in URLs (might lead to false positives!). (Only available in experimental builds) 
86
-.TP
87
-\fB\-\-phishing\-cloak\fR
88
-Always block cloaked URLs (might lead to some false positives). (Only available in experimental builds)
89
-.TP
90
-\fB\-\-no\-algorithmic\fR
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.
92
-.TP 
93
-\fB\-\-no\-pe\fR
94
-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!
95
-.TP 
96
-\fB\-\-no\-elf\fR
97
-Executable and Linking Format is a standard format for UN*X executables. This option \fBdisables\fR ELF support.
98
-.TP 
99
-\fB\-\-no\-ole2\fR
100
-Disable support for Microsoft Office documents and .msi files.
101
-.TP 
102
-\fB\-\-no\-pdf\fR
103
-Disable scanning within PDF files.
104
-.TP 
105
-\fB\-\-no\-html\fR
106
-Disable support for HTML detection and normalisation.
107
-.TP 
108
-\fB\-\-no\-archive\fR
109
-Disable archive support built in libclamav.
110
-.TP 
111
-\fB\-\-detect\-broken\fR
112
-Mark broken executables as viruses (Broken.Executable).
113
-.TP 
114
-\fB\-\-block\-encrypted\fR
115
-Mark encrypted archives as viruses (Encrypted.Zip, Encrypted.RAR).
116
-.TP 
117
-\fB\-\-block\-max\fR
118
-Mark archives as viruses (e.g. RAR.ExceededFileSize, Zip.ExceededFilesLimit) if max\-files, max\-space, or max\-recursion is reached.
119
-.TP 
120
-\fB\-\-mail\-follow\-urls\fR
121
-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
122
-.TP 
123
-\fB\-\-max\-files=#n\fR
124
-Extract first #n files from each archive. This option protects your system against DoS attacks (default: 500)
125
-.TP 
126
-\fB\-\-max\-space=#n\fR
127
-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)
128
-.TP 
129
-\fB\-\-max\-recursion=#n\fR
130
-Set archive recursion level limit. This option protects your system against DoS attacks (default: 8).
131
-.TP 
132
-\fB\-\-max\-ratio=#n\fR
133
-Set maximum archive compression ratio limit. This option protects your system against DoS attacks (default: 250).
134
-.TP
135
-\fB\-\-max\-mail\-recursion=#n\fR
136
-Recursion level limit for the internal mail scanner.
137
-.TP 
138
-\fB\-\-max\-dir\-recursion=#n\fR
139
-Maximum depth directories are scanned at (default: 15).
140
-.TP 
141
-\fB\-\-unzip[=FULLPATH]\fR
142
-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.
143
-.TP 
144
-\fB\-\-unrar[=FULLPATH]\fR
145
-Scan .rar files. In most cases the unpacker built into libclamav is enough.
146
-.TP 
147
-\fB\-\-arj[=FULLPATH]\fR
148
-Scan .arj files.
149
-.TP 
150
-\fB\-\-unzoo[=FULLPATH]\fR
151
-Scan .zoo files.
152
-.TP 
153
-\fB\-\-lha[=FULLPATH]\fR
154
-Scan .lzh files.
155
-.TP 
156
-\fB\-\-jar[=FULLPATH]\fR
157
-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.
158
-.TP 
159
-\fB\-\-deb[=FULLPATH]\fR
160
-This option supports debian binary packages. Implies \-\-tgz, but doesn't conflict with \-\-tgz=FULLPATH. It requires ar utility.
161
-.TP 
162
-\fB\-\-tar[=FULLPATH]\fR
163
-This option supports non\-compressed tar archives. In most cases the unpacker built into libclamav is enough.
164
-.TP 
165
-\fB\-\-tgz[=FULLPATH]\fR
166
-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.
167
-.SH "EXAMPLES"
168
-.LP 
169
-.TP 
170
-(0) Scan a single file:
171
-
172
-\fBclamscan file\fR
173
-.TP 
174
-(1) Scan a current working directory:
175
-
176
-\fBclamscan\fR
177
-.TP 
178
-(2) Scan all files (and subdirectories) in /home:
179
-
180
-\fBclamscan \-r /home\fR
181
-.TP 
182
-(3) Load database from a file and limit disk usage to 50 MB:
183
-
184
-\fBclamscan \-d /tmp/newclamdb \-\-max\-space=50m \-r /tmp\fR
185
-.TP 
186
-(4) Scan a data stream:
187
-
188
-\fBcat testfile | clamscan \-\fR
189
-.TP 
190
-(5) Scan a mail spool directory:
191
-
192
-\fBclamscan \-r /var/spool/mail\fR
193
-.SH "RETURN CODES"
194
-.LP 
195
-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.
196
-
197
-0 : No virus found.
198
-.TP 
199
-1 : Virus(es) found.
200
-.TP 
201
-40: Unknown option passed.
202
-.TP 
203
-50: Database initialization error.
204
-.TP 
205
-52: Not supported file type.
206
-.TP 
207
-53: Can't open directory.
208
-.TP 
209
-54: Can't open file. (ofm)
210
-.TP 
211
-55: Error reading file. (ofm)
212
-.TP 
213
-56: Can't stat input file / directory.
214
-.TP 
215
-57: Can't get absolute path name of current working directory.
216
-.TP 
217
-58: I/O error, please check your file system.
218
-.TP 
219
-59: Can't get information about current user from /etc/passwd.
220
-.TP 
221
-60: Can't get information about user 'clamav' (default name) from /etc/passwd.
222
-.TP 
223
-61: Can't fork.
224
-.TP 
225
-62: Can't initialize logger.
226
-.TP 
227
-63: Can't create temporary files/directories (check permissions).
228
-.TP 
229
-64: Can't write to temporary directory (please specify another one).
230
-.TP 
231
-70: Can't allocate memory (calloc).
232
-.TP 
233
-71: Can't allocate memory (malloc).
234
-.SH "CREDITS"
235
-Please check the full documentation for credits.
236
-.SH "AUTHOR"
237
-.LP 
238
-Tomasz Kojm <tkojm@clamav.net>
239
-.SH "SEE ALSO"
240
-.LP 
241
-clamdscan(1), freshclam(1)
242 1
new file mode 100644
... ...
@@ -0,0 +1,241 @@
0
+.TH "clamscan" "1" "February 12, 2007" "ClamAV @VERSION@" "Clam AntiVirus"
1
+.SH "NAME"
2
+.LP 
3
+clamscan \- scan files and directories for viruses
4
+.SH "SYNOPSIS"
5
+.LP 
6
+clamscan [options] [file/directory/\-]
7
+.SH "DESCRIPTION"
8
+.LP 
9
+clamscan is a command line anti\-virus scanner.
10
+.SH "OPTIONS"
11
+.LP 
12
+
13
+.TP 
14
+\fB\-h, \-\-help\fR
15
+Print help information and exit.
16
+.TP 
17
+\fB\-V, \-\-version\fR
18
+Print version number and exit.
19
+.TP 
20
+\fB\-v, \-\-verbose\fR
21
+Be verbose.
22
+.TP 
23
+\fB\-\-debug\fR
24
+Display debug messages from libclamav.
25
+.TP 
26
+\fB\-\-quiet\fR
27
+Be quiet (only print error messages).
28
+.TP 
29
+\fB\-\-stdout\fR
30
+Write all messages (except for libclamav output) to the standard output (stdout).
31
+.TP 
32
+\fB\-d FILE/DIR, \-\-database=FILE/DIR\fR
33
+Load virus database from FILE or load all virus database files from DIR.
34
+.TP 
35
+\fB\-l FILE, \-\-log=FILE\fR
36
+Save scan report to FILE.
37
+.TP 
38
+\fB\-\-tempdir=DIRECTORY\fR
39
+Create temporary files in DIRECTORY. Directory must be writable for the '@CLAMAVUSER@' user or unprivileged user running clamscan.
40
+.TP 
41
+\fB\-\-leave\-temps\fR
42
+Do not remove temporary files.
43
+.TP 
44
+\fB\-r, \-\-recursive\fR
45
+Scan directories recursively. All the subdirectories in the given directory will be scanned.
46
+.TP 
47
+\fB\-\-bell\fR
48
+Sound bell on virus detection.
49
+.TP 
50
+\fB\-\-no\-summary\fR
51
+Do not display summary at the end of scanning.
52
+.TP 
53
+\fB\-\-exclude=PATT, \-\-exclude\-dir=PATT\fR
54
+Don't scan file/directory names containing PATT. It may be used multiple times.
55
+.TP 
56
+\fB\-\-include=PATT, \-\-include\-dir=PATT\fR
57
+Only scan file/directory names containing PATT. It may be used multiple times.
58
+.TP 
59
+\fB\-i, \-\-infected\fR
60
+Only print infected files.
61
+.TP 
62
+\fB\-\-remove\fR
63
+Remove infected files. \fBBe careful.\fR
64
+.TP 
65
+\fB\-\-move=DIRECTORY\fR
66
+Move infected files into DIRECTORY. Directory must be writable for the '@CLAMAVUSER@' user or unprivileged user running clamscan.
67
+.TP 
68
+\fB\-\-copy=DIRECTORY\fR
69
+Copy infected files into DIRECTORY. Directory must be writable for the '@CLAMAVUSER@' user or unprivileged user running clamscan.
70
+.TP 
71
+\fB\-\-no\-mail\fR
72
+Disable scanning of mail files.
73
+.TP 
74
+\fB\-\-no\-phishing\-sigs\fR
75
+Disable signature-based phishing detection.
76
+.TP 
77
+\fB\-\-no\-phishing\-scan\-urls\fR
78
+Disable url-based phishing detection. (Only available in experimental builds)
79
+.TP
80
+\fB\-\-no\-phishing\-restrictedscan\fR
81
+Enable phishing detection for all domains (might lead to false positives!).(Only available in experimental builds)
82
+.TP
83
+\fB\-\-phishing\-ssl\fR
84
+Always block SSL mismatches in URLs (might lead to false positives!). (Only available in experimental builds) 
85
+.TP
86
+\fB\-\-phishing\-cloak\fR
87
+Always block cloaked URLs (might lead to some false positives). (Only available in experimental builds)
88
+.TP
89
+\fB\-\-no\-algorithmic\fR
90
+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.
91
+.TP 
92
+\fB\-\-no\-pe\fR
93
+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!
94
+.TP 
95
+\fB\-\-no\-elf\fR
96
+Executable and Linking Format is a standard format for UN*X executables. This option \fBdisables\fR ELF support.
97
+.TP 
98
+\fB\-\-no\-ole2\fR
99
+Disable support for Microsoft Office documents and .msi files.
100
+.TP 
101
+\fB\-\-no\-pdf\fR
102
+Disable scanning within PDF files.
103
+.TP 
104
+\fB\-\-no\-html\fR
105
+Disable support for HTML detection and normalisation.
106
+.TP 
107
+\fB\-\-no\-archive\fR
108
+Disable archive support built in libclamav.
109
+.TP 
110
+\fB\-\-detect\-broken\fR
111
+Mark broken executables as viruses (Broken.Executable).
112
+.TP 
113
+\fB\-\-block\-encrypted\fR
114
+Mark encrypted archives as viruses (Encrypted.Zip, Encrypted.RAR).
115
+.TP 
116
+\fB\-\-block\-max\fR
117
+Mark archives as viruses (e.g. RAR.ExceededFileSize, Zip.ExceededFilesLimit) if max\-files, max\-space, or max\-recursion is reached.
118
+.TP 
119
+\fB\-\-mail\-follow\-urls\fR
120
+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
121
+.TP 
122
+\fB\-\-max\-files=#n\fR
123
+Extract first #n files from each archive. This option protects your system against DoS attacks (default: 500)
124
+.TP 
125
+\fB\-\-max\-space=#n\fR
126
+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)
127
+.TP 
128
+\fB\-\-max\-recursion=#n\fR
129
+Set archive recursion level limit. This option protects your system against DoS attacks (default: 8).
130
+.TP 
131
+\fB\-\-max\-ratio=#n\fR
132
+Set maximum archive compression ratio limit. This option protects your system against DoS attacks (default: 250).
133
+.TP
134
+\fB\-\-max\-mail\-recursion=#n\fR
135
+Recursion level limit for the internal mail scanner.
136
+.TP 
137
+\fB\-\-max\-dir\-recursion=#n\fR
138
+Maximum depth directories are scanned at (default: 15).
139
+.TP 
140
+\fB\-\-unzip[=FULLPATH]\fR
141
+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.
142
+.TP 
143
+\fB\-\-unrar[=FULLPATH]\fR
144
+Scan .rar files. In most cases the unpacker built into libclamav is enough.
145
+.TP 
146
+\fB\-\-arj[=FULLPATH]\fR
147
+Scan .arj files.
148
+.TP 
149
+\fB\-\-unzoo[=FULLPATH]\fR
150
+Scan .zoo files.
151
+.TP 
152
+\fB\-\-lha[=FULLPATH]\fR
153
+Scan .lzh files.
154
+.TP 
155
+\fB\-\-jar[=FULLPATH]\fR
156
+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.
157
+.TP 
158
+\fB\-\-deb[=FULLPATH]\fR
159
+This option supports debian binary packages. Implies \-\-tgz, but doesn't conflict with \-\-tgz=FULLPATH. It requires ar utility.
160
+.TP 
161
+\fB\-\-tar[=FULLPATH]\fR
162
+This option supports non\-compressed tar archives. In most cases the unpacker built into libclamav is enough.
163
+.TP 
164
+\fB\-\-tgz[=FULLPATH]\fR
165
+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.
166
+.SH "EXAMPLES"
167
+.LP 
168
+.TP 
169
+(0) Scan a single file:
170
+
171
+\fBclamscan file\fR
172
+.TP 
173
+(1) Scan a current working directory:
174
+
175
+\fBclamscan\fR
176
+.TP 
177
+(2) Scan all files (and subdirectories) in /home:
178
+
179
+\fBclamscan \-r /home\fR
180
+.TP 
181
+(3) Load database from a file and limit disk usage to 50 MB:
182
+
183
+\fBclamscan \-d /tmp/newclamdb \-\-max\-space=50m \-r /tmp\fR
184
+.TP 
185
+(4) Scan a data stream:
186
+
187
+\fBcat testfile | clamscan \-\fR
188
+.TP 
189
+(5) Scan a mail spool directory:
190
+
191
+\fBclamscan \-r /var/spool/mail\fR
192
+.SH "RETURN CODES"
193
+.LP 
194
+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.
195
+
196
+0 : No virus found.
197
+.TP 
198
+1 : Virus(es) found.
199
+.TP 
200
+40: Unknown option passed.
201
+.TP 
202
+50: Database initialization error.
203
+.TP 
204
+52: Not supported file type.
205
+.TP 
206
+53: Can't open directory.
207
+.TP 
208
+54: Can't open file. (ofm)
209
+.TP 
210
+55: Error reading file. (ofm)
211
+.TP 
212
+56: Can't stat input file / directory.
213
+.TP 
214
+57: Can't get absolute path name of current working directory.
215
+.TP 
216
+58: I/O error, please check your file system.
217
+.TP 
218
+59: Can't get information about current user from /etc/passwd.
219
+.TP 
220
+60: Can't get information about user '@CLAMAVUSER@' from /etc/passwd.
221
+.TP 
222
+61: Can't fork.
223
+.TP 
224
+62: Can't initialize logger.
225
+.TP 
226
+63: Can't create temporary files/directories (check permissions).
227
+.TP 
228
+64: Can't write to temporary directory (please specify another one).
229
+.TP 
230
+70: Can't allocate memory (calloc).
231
+.TP 
232
+71: Can't allocate memory (malloc).
233
+.SH "CREDITS"
234
+Please check the full documentation for credits.
235
+.SH "AUTHOR"
236
+.LP 
237
+Tomasz Kojm <tkojm@clamav.net>
238
+.SH "SEE ALSO"
239
+.LP 
240
+clamdscan(1), freshclam(1)
... ...
@@ -1,4 +1,4 @@
1
-.TH "freshclam" "1" "February 12, 2007" "ClamAV 0.90" "Clam AntiVirus"
1
+.TH "freshclam" "1" "February 12, 2007" "ClamAV @VERSION@" "Clam AntiVirus"
2 2
 .SH "NAME"
3 3
 .LP 
4 4
 freshclam \- update virus databases
... ...
@@ -31,10 +31,10 @@ Write all messages to stdout.
31 31
 Write download report to FILE.
32 32
 .TP 
33 33
 \fB\-\-datadir=DIRECTORY\fR
34
-Install new database in DIRECTORY. The directory must be writable for the 'clamav' user or unprivileged user running freshclam.
34
+Install new database in DIRECTORY. The directory must be writable for the '@CLAMAVUSER@' user or unprivileged user running freshclam.
35 35
 .TP 
36 36
 \fB\-u USER, \-\-user USER\fR
37
-Run as USER. By default (when started by root) freshclam drops privileges and operates as the 'clamav' user.
37
+Run as USER. By default (when started by root) freshclam drops privileges and operates as the '@CLAMAVUSER@' user.
38 38
 .TP 
39 39
 \fB\-d, \-\-daemon\fR
40 40
 Run in a daemon mode. This option requires \-\-checks.
... ...
@@ -105,7 +105,7 @@ Pring mirror details from mirrors.dat (cache file for the mirror manager).
105 105
 .TP 
106 106
 59: Mirrors are not fully synchronized (try again later).
107 107
 .TP 
108
-60: Can't get information about clamav user from /etc/passwd.
108
+60: Can't get information about '@CLAMAVUSER@' user from /etc/passwd.
109 109
 .TP 
110 110
 61: Can't drop privileges.
111 111
 .TP 
... ...
@@ -1,4 +1,4 @@
1
-.TH "freshclam.conf" "5" "February 12, 2007" "ClamAV 0.90" "Clam AntiVirus"
1
+.TH "freshclam.conf" "5" "February 12, 2007" "ClamAV @VERSION@" "Clam AntiVirus"
2 2
 .SH "NAME"
3 3
 .LP 
4 4
 \fBfreshclam.conf\fR \- Configuration file for Clam AntiVirus database update tool
5 5
deleted file mode 100644
... ...
@@ -1,87 +0,0 @@
1
-.TH "sigtool" "1" "February 12, 2007" "ClamAV 0.90" "Clam AntiVirus"
2
-.SH "NAME"
3
-.LP 
4
-sigtool \- signature and database management tool
5
-.SH "SYNOPSIS"
6
-.LP 
7
-sigtool [options]
8
-.SH "DESCRIPTION"
9
-.LP 
10
-sigtool can be used to generate MD5 checksums, convert data into hexadecimal format, list virus signatures and build/unpack/test/verify CVD databases and update scripts.
11
-.SH "OPTIONS"
12
-.LP 
13
-
14
-.TP 
15
-\fB\-h, \-\-help\fR
16
-Output help information and exit.
17
-.TP 
18
-\fB\-V, \-\-version\fR
19
-Print version number and exit.
20
-.TP 
21
-\fB\-\-quiet\fR
22
-Be quiet \- output only error messages.
23
-.TP 
24
-\fB\-\-stdout\fR
25
-Write all messages to stdout.
26
-.TP 
27
-\fB\-\-hex\-dump\fR
28
-Read data from stdin and write hex string to stdout.
29
-.TP 
30
-\fB\-\-md5 [FILES]\fR
31
-Generate MD5 checksum from stdin or MD5 sigs for FILES.
32
-.TP 
33
-\fB\-\-mdb [FILES]\fR
34
-Generate .mdb signatures for FILES.
35
-.TP 
36
-\fB\-\-html\-normalise=FILE\fR
37
-Create normalised HTML files comment.html, nocomment.html, and script.html in current working directory.
38
-.TP 
39
-\fB\-\-utf16\-decode=FILE\fR
40
-Decode UTF16 encoded data.
41
-.TP 
42
-\fB\-\-vba=FILE\fR
43
-Extract VBA/Word6 macros from given MS Office document.
44
-.TP 
45
-\fB\-\-vba\-hex=FILE\fR
46
-Extract Word6 macros from given MS Office document and display the corresponding hex values.
47
-.TP 
48
-\fB\-i, \-\-info\fR
49
-Print a CVD information and verify MD5 and a digital signature.
50
-.TP 
51
-\fB\-b, \-\-build\fR
52
-Build a CVD file. \-s, \-\-server is required.
53
-.TP 
54
-\fB\-\-server\fR
55
-ClamAV Signing Service address (for virus database maintainers only).
56
-.TP 
57
-\fB\-\-unpack FILE, \-u FILE\fR
58
-Unpack FILE (CVD) to a current directory.
59
-.TP 
60
-\fB\-\-unpack\-current\fR
61
-Unpack a local CVD file (main or daily) to current directory.
62
-.TP 
63
-\fB\-\-diff=OLD NEW, \-d OLD NEW\fR
64
-Create a diff file for OLD and NEW CVDs/INCDIRs.
65
-.TP 
66
-\fB\-\-run\-cdiff=FILE, \-r FILE\fR
67
-Execute update script FILE in current directory.
68
-.TP 
69
-\fB\-\-verify\-cdiff=FILE, \-r FILE\fR
70
-Verify DIFF against CVD/INCDIR.
71
-.TP 
72
-\fB\-l, \-\-list\-sigs\fR
73
-List signature names.
74
-.SH "EXAMPLES"
75
-.LP 
76
-.TP 
77
-Generate hex string from testfile and save it to testfile.hex:
78
-
79
-\fBcat testfile | sigtool \-\-hex\-dump > testfile.hex\fR
80
-.SH "CREDITS"
81
-Please check the full documentation for credits.
82
-.SH "AUTHOR"
83
-.LP 
84
-Tomasz Kojm <tkojm@clamav.net>
85
-.SH "SEE ALSO"
86
-.LP 
87
-clamd(8), clamdscan(1), clamscan(1), freshclam(1), clamd.conf(5), clamav\-milter(8)
88 1
new file mode 100644
... ...
@@ -0,0 +1,87 @@
0
+.TH "sigtool" "1" "February 12, 2007" "ClamAV @VERSION@" "Clam AntiVirus"
1
+.SH "NAME"
2
+.LP 
3
+sigtool \- signature and database management tool
4
+.SH "SYNOPSIS"
5
+.LP 
6
+sigtool [options]
7
+.SH "DESCRIPTION"
8
+.LP 
9
+sigtool can be used to generate MD5 checksums, convert data into hexadecimal format, list virus signatures and build/unpack/test/verify CVD databases and update scripts.
10
+.SH "OPTIONS"
11
+.LP 
12
+
13
+.TP 
14
+\fB\-h, \-\-help\fR
15
+Output help information and exit.
16
+.TP 
17
+\fB\-V, \-\-version\fR
18
+Print version number and exit.
19
+.TP 
20
+\fB\-\-quiet\fR
21
+Be quiet \- output only error messages.
22
+.TP 
23
+\fB\-\-stdout\fR
24
+Write all messages to stdout.
25
+.TP 
26
+\fB\-\-hex\-dump\fR
27
+Read data from stdin and write hex string to stdout.
28
+.TP 
29
+\fB\-\-md5 [FILES]\fR
30
+Generate MD5 checksum from stdin or MD5 sigs for FILES.
31
+.TP 
32
+\fB\-\-mdb [FILES]\fR
33
+Generate .mdb signatures for FILES.
34
+.TP 
35
+\fB\-\-html\-normalise=FILE\fR
36
+Create normalised HTML files comment.html, nocomment.html, and script.html in current working directory.
37
+.TP 
38
+\fB\-\-utf16\-decode=FILE\fR
39
+Decode UTF16 encoded data.
40
+.TP 
41
+\fB\-\-vba=FILE\fR
42
+Extract VBA/Word6 macros from given MS Office document.
43
+.TP 
44
+\fB\-\-vba\-hex=FILE\fR
45
+Extract Word6 macros from given MS Office document and display the corresponding hex values.
46
+.TP 
47
+\fB\-i, \-\-info\fR
48
+Print a CVD information and verify MD5 and a digital signature.
49
+.TP 
50
+\fB\-b, \-\-build\fR
51
+Build a CVD file. \-s, \-\-server is required.
52
+.TP 
53
+\fB\-\-server\fR
54
+ClamAV Signing Service address (for virus database maintainers only).
55
+.TP 
56
+\fB\-\-unpack FILE, \-u FILE\fR
57
+Unpack FILE (CVD) to a current directory.
58
+.TP 
59
+\fB\-\-unpack\-current\fR
60
+Unpack a local CVD file (main or daily) to current directory.
61
+.TP 
62
+\fB\-\-diff=OLD NEW, \-d OLD NEW\fR
63
+Create a diff file for OLD and NEW CVDs/INCDIRs.
64
+.TP 
65
+\fB\-\-run\-cdiff=FILE, \-r FILE\fR
66
+Execute update script FILE in current directory.
67
+.TP 
68
+\fB\-\-verify\-cdiff=FILE, \-r FILE\fR
69
+Verify DIFF against CVD/INCDIR.
70
+.TP 
71
+\fB\-l, \-\-list\-sigs\fR
72
+List signature names.
73
+.SH "EXAMPLES"
74
+.LP 
75
+.TP 
76
+Generate hex string from testfile and save it to testfile.hex:
77
+
78
+\fBcat testfile | sigtool \-\-hex\-dump > testfile.hex\fR
79
+.SH "CREDITS"
80
+Please check the full documentation for credits.
81
+.SH "AUTHOR"
82
+.LP 
83
+Tomasz Kojm <tkojm@clamav.net>
84
+.SH "SEE ALSO"
85
+.LP 
86
+clamd(8), clamdscan(1), clamscan(1), freshclam(1), clamd.conf(5), clamav\-milter(8)