Prepare for 1.4.0 release.
[inoclam.git] / man / inoclam.8
blob5b90d7b443a43e8ee860eeb09db6ea86239bdc3f
1 .\" inoclam - Inotify+ClamAV virus scanner
2 .\" Copyright (C) 2007, 2008, 2009 Vermont Department of Taxes
3 .\"
4 .\" This program is free software; you can redistribute it and/or modify
5 .\" it under the terms of the GNU General Public License version 2 as
6 .\" published by the Free Software Foundation.
7 .\"
8 .\" This program is distributed in the hope that it will be useful,
9 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
10 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11 .\" GNU General Public License for more details.
12 .\"
13 .\" You should have received a copy of the GNU General Public License
14 .\" along with this program; if not, write to the Free Software
15 .\" Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16 .TH INOCLAM 8 "v1.4.0 (Amy)" "April 16, 2009"
18 .SH NAME
19 inoclam \- directory monitor with virus scanning capabilities.
21 .SH SYNOPSIS
22 .B inoclam
23 .I [OPTIONS]
24 .br
26 .SH DESCRIPTION
27 \fBinoclam\fP uses inotify  to watch user specified directories. When a 
28 file is created, changed or copied to one of the monitored directories, 
29 the file is virus checked with Clam Anti-Virus. If a virus is detected, 
30 the file is optionally removed from the file system and the 
31 administrator is optionally notified.
33 .SH OPTIONS
34 .TP
35 \fB\-c\fP, \fB\-\-config=[FILE]\fP
36 Specifiy an alternate config location.
37 .TP
38 \fB\-h\fP, \fB\-\-help\fP
39 Display a summary of command line options and exit.
40 .TP
41 \fB\-f\fP, \fB\-\-foreground\fP
42 Instead of running as a background process, run in the foreground. This 
43 option is useful for debugging.
44 .TP
45 \fB\-k\fP, \fB\-\-kill\fP
46 Kill the running instance of \fBinoclam\fP and exit. If \fBinoclam\fP is 
47 not running, display an error message and exit.
48 .TP
49 \fB\-v\fP, \fB\-\-version\fP
50 Display program version information and exit.
52 .SH FILES
53 .I /etc/inoclam.conf
54 .RS
55 The \fBinoclam\fP configuration file.
57 .SH BUGS
58 Please send any comments or bug reports to \fBinoclam-discuss\fP
59 mailing list. To subscribe, visit the mailman web interface at
60 https://lists.sourceforge.net/lists/listinfo/inoclam-discuss
62 .SH HOMEPAGE
63 http://www.inoclam.org/
65 .SH AUTHORS
66 Tom Cort <tom.cort@state.vt.us>
67 .br
68 Matt Gagne <matt.gagne@state.vt.us>
70 .SH COPYRIGHT
71 Copyright \(co 2007, 2008, 2009 Vermont Department of Taxes
73 This program is free software; you can redistribute it and/or modify
74 it under the terms of the GNU General Public License version 2 as
75 published by the Free Software Foundation.
77 This program is distributed in the hope that it will be useful,
78 but WITHOUT ANY WARRANTY; without even the implied warranty of
79 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
80 GNU General Public License for more details.
82 You should have received a copy of the GNU General Public License
83 along with this program; if not, write to the Free Software
84 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
86 .SH "SEE ALSO"
87 .PP
88 \fBinoclam.conf\fR(5)