From 4708e68b8783cac3ff62828d728593c778ac17f9 Mon Sep 17 00:00:00 2001
From: Tom Cort <tom.cort@state.vt.us>
Date: Tue, 11 Dec 2007 13:19:31 -0500
Subject: [PATCH] Add an inoclam.conf man page.

---
 CMakeLists.txt              |  1 +
 inoclam.8                   |  4 +++
 inoclam.8 => inoclam.conf.5 | 80 ++++++++++++++++++++++++++++++---------------
 3 files changed, 58 insertions(+), 27 deletions(-)
 copy inoclam.8 => inoclam.conf.5 (51%)

diff --git a/CMakeLists.txt b/CMakeLists.txt
index c8fd025..9c88f56 100644
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -25,3 +25,4 @@ ADD_SUBDIRECTORY(src)
 #############################################
 
 INSTALL(FILES inoclam.8 DESTINATION share/man/man8)
+INSTALL(FILES inoclam.conf.5 DESTINATION share/man/man5)
diff --git a/inoclam.8 b/inoclam.8
index 2292a0d..c11e9ee 100644
--- a/inoclam.8
+++ b/inoclam.8
@@ -84,3 +84,7 @@ 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
+
+.SH "SEE ALSO"
+.PP
+\fBinoclam.conf\fR(5)
diff --git a/inoclam.8 b/inoclam.conf.5
similarity index 51%
copy from inoclam.8
copy to inoclam.conf.5
index 2292a0d..bf9f55c 100644
--- a/inoclam.8
+++ b/inoclam.conf.5
@@ -17,43 +17,65 @@
 .\"
 .\" Contributor(s):
 .\"   Tom Cort <tom.cort@state.vt.us>
-.TH INOCLAM 8 "v1.2.0 (Zoidberg)" "December 11, 2007"
+.TH INOCLAM.CONF 5 "v1.2.0 (Zoidberg)" "December 11, 2007"
 
 .SH NAME
-inoclam \- directory monitor with virus scanning capabilities.
-
-.SH SYNOPSIS
-.B inoclam
-.I [OPTIONS]
-.br
+inoclam.conf \- the \fBinoclam\fP configuration file.
 
 .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.
+The \fI/etc/inoclam.conf\fR file specifies runtime settings for
+\fBinoclam\fP. Each line in the configuration file can be either blank, 
+a comment or a configuration line. Comments begin with the hash symbol 
+(\fB#\fP). Configuration lines are in the form \fBkey = value\fP.
+
+.SH BASE SETTINGS
+.TP
+\fBwatch_dir\fP
+Set this to the directory that inoclam should watch. inoclam will
+recursively watch all of the subdirectories as well. Default: \fI/tmp\fR
+
+.SH VIRUS DETECTION SETTINGS
+.TP
+\fBvirus_removal_enabled\fP
+Allow or deny permission to automatically delete infected files by
+setting this to true or false. Default: \fItrue\fR
 
-.SH OPTIONS
+.SH VIRUS DETECTED E-MAIL NOTIFICATION SETTINGS
 .TP
-\fB\-h\fP, \fB\-\-help\fP
-Display a summary of command line options and exit.
+\fBsmtp_enabled_virus\fP
+Enable or disable e-mail notifications when a virus is detected by
+setting this to true or false. Default: \fItrue\fR
 .TP
-\fB\-f\fP, \fB\-\-foreground\fP
-Instead of running as a background process, run in the foreground. This 
-option is useful for debugging.
+\fBsmtp_subject_virus\fP
+The subject line used for virus found e-mail notifications. Default:
+\fI"[inoclam] Virus Detected"\fP
+
+.SH FILE CREATE/CHANGE E-MAIL NOTIFICATION SETTINGS
 .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.
+\fBsmtp_enabled_file\fP
+Enable or disable e-mail notifications when a file is created or
+changed by setting this to true or false. Default: \fIfalse\fR
 .TP
-\fB\-v\fP, \fB\-\-version\fP
-Display program version information and exit.
+\fBsmtp_subject_file\fP
+The subject line used for file change e-mail notifications. Default:
+\fI"[inoclam]  File Create/Change"\fP
 
-.SH FILES
-.I /etc/inoclam.conf
-.RS
-The \fBinoclam\fP configuration file.
+.SH E-MAIL SYSTEM SETTINGS
+.TP
+\fBsmtp_host\fP
+The hostname of the SMTP server you wish to use for e-mail 
+notifications. Default: \fI"localhost"\fP
+.TP
+\fBsmtp_port\fP
+The TCP port to connect to for e-mail notifications. Default: \fI25\fP
+.TP
+\fBsmtp_to\fP
+The address to send e-mail notifications to.
+Default: \fI"root@localhost"\fP
+.TP
+\fBsmtp_from\fP
+The return address for e-mail notifications.
+Default: \fI"root@localhost"\fP
 
 .SH BUGS
 Please send any comments or bug reports to \fBinoclam-discuss\fP
@@ -84,3 +106,7 @@ 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
+
+.SH "SEE ALSO"
+.PP
+\fBinoclam\fR(8)
-- 
2.11.4.GIT