From 82a1946eeeb511c2b77da592cbcfb6529ec5c06c Mon Sep 17 00:00:00 2001 From: Tom Cort Date: Tue, 11 Dec 2007 13:00:57 -0500 Subject: [PATCH] Add a man page. --- CMakeLists.txt | 6 ++++ TODO | 1 - inoclam.8 | 86 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 92 insertions(+), 1 deletion(-) create mode 100644 inoclam.8 diff --git a/CMakeLists.txt b/CMakeLists.txt index a9526cc..c8fd025 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -19,3 +19,9 @@ # Tom Cort ADD_SUBDIRECTORY(src) + +############################################# +# install the man page +############################################# + +INSTALL(FILES inoclam.8 DESTINATION share/man/man8) diff --git a/TODO b/TODO index 30b65de..ee62c79 100644 --- a/TODO +++ b/TODO @@ -1,4 +1,3 @@ - * Write a Man Page * Watch Multiple Directories * Notify Multiple E-Mail Addresses * Allow the user to specify more clamav options diff --git a/inoclam.8 b/inoclam.8 new file mode 100644 index 0000000..2292a0d --- /dev/null +++ b/inoclam.8 @@ -0,0 +1,86 @@ +.\" inoclam - Inotify+ClamAV virus scanner +.\" Copyright (C) 2007 Vermont Department of Taxes +.\" +.\" This program is free software; you can redistribute it and/or modify +.\" it under the terms of the GNU General Public License as published by +.\" the Free Software Foundation; either version 2 of the License, or +.\" (at your option) any later version. +.\" +.\" This program is distributed in the hope that it will be useful, +.\" but WITHOUT ANY WARRANTY; without even the implied warranty of +.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +.\" GNU General Public License for more details. +.\" +.\" You should have received a copy of the GNU General Public License +.\" along with this program; if not, write to the Free Software +.\" Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA +.\" +.\" Contributor(s): +.\" Tom Cort +.TH INOCLAM 8 "v1.2.0 (Zoidberg)" "December 11, 2007" + +.SH NAME +inoclam \- directory monitor with virus scanning capabilities. + +.SH SYNOPSIS +.B inoclam +.I [OPTIONS] +.br + +.SH DESCRIPTION +\fBinoclam\fP uses inotify to watch user specified directories. When a +file is created, changed or copied to one of the monitored directories, +the file is virus checked with Clam Anti-Virus. If a virus is detected, +the file is optionally removed from the file system and the +administrator is optionally notified. + +.SH OPTIONS +.TP +\fB\-h\fP, \fB\-\-help\fP +Display a summary of command line options and exit. +.TP +\fB\-f\fP, \fB\-\-foreground\fP +Instead of running as a background process, run in the foreground. This +option is useful for debugging. +.TP +\fB\-k\fP, \fB\-\-kill\fP +Kill the running instance of \fBinoclam\fP and exit. If \fBinoclam\fP is +not running, display an error message and exit. +.TP +\fB\-v\fP, \fB\-\-version\fP +Display program version information and exit. + +.SH FILES +.I /etc/inoclam.conf +.RS +The \fBinoclam\fP configuration file. + +.SH BUGS +Please send any comments or bug reports to \fBinoclam-discuss\fP +mailing list. To subscribe, visit the mailman web interface at +https://lists.sourceforge.net/lists/listinfo/inoclam-discuss + +.SH HOMEPAGE +http://www.inoclam.org/ + +.SH AUTHORS +Tom Cort +.br +Matt Gagne + +.SH COPYRIGHT +Copyright \(co 2007 Vermont Department of Taxes + +This program is free software; you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation; either version 2 of the License, or +(at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program; if not, write to the Free Software +Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA -- 2.11.4.GIT