inoclam.8

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