inoclam.conf.5

   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.CONF 5 "v1.2.0 (Zoidberg)" "December 11, 2007"
  21
  22 .SH NAME
  23 inoclam.conf \- the \fBinoclam\fP configuration file.
  24
  25 .SH DESCRIPTION
  26 The \fI/etc/inoclam.conf\fR file specifies runtime settings for
  27 \fBinoclam\fP. Each line in the configuration file can be either blank,
  28 a comment or a configuration line. Comments begin with the hash symbol
  29 (\fB#\fP). Configuration lines are in the form \fBkey = value\fP.
  30
  31 .SH BASE SETTINGS
  32 .TP
  33 \fBwatch_dir\fP
  34 Set this to the directory that inoclam should watch. inoclam will
  35 recursively watch all of the subdirectories as well. Default: \fI/tmp\fR
  36
  37 .SH VIRUS DETECTION SETTINGS
  38 .TP
  39 \fBvirus_removal_enabled\fP
  40 Allow or deny permission to automatically delete infected files by
  41 setting this to true or false. Default: \fItrue\fR
  42
  43 .SH VIRUS DETECTED E-MAIL NOTIFICATION SETTINGS
  44 .TP
  45 \fBsmtp_enabled_virus\fP
  46 Enable or disable e-mail notifications when a virus is detected by
  47 setting this to true or false. Default: \fItrue\fR
  48 .TP
  49 \fBsmtp_subject_virus\fP
  50 The subject line used for virus found e-mail notifications. Default:
  51 \fI"[inoclam] Virus Detected"\fP
  52
  53 .SH FILE CREATE/CHANGE E-MAIL NOTIFICATION SETTINGS
  54 .TP
  55 \fBsmtp_enabled_file\fP
  56 Enable or disable e-mail notifications when a file is created or
  57 changed by setting this to true or false. Default: \fIfalse\fR
  58 .TP
  59 \fBsmtp_subject_file\fP
  60 The subject line used for file change e-mail notifications. Default:
  61 \fI"[inoclam]  File Create/Change"\fP
  62
  63 .SH E-MAIL SYSTEM SETTINGS
  64 .TP
  65 \fBsmtp_host\fP
  66 The hostname of the SMTP server you wish to use for e-mail
  67 notifications. Default: \fI"localhost"\fP
  68 .TP
  69 \fBsmtp_port\fP
  70 The TCP port to connect to for e-mail notifications. Default: \fI25\fP
  71 .TP
  72 \fBsmtp_to\fP
  73 The address to send e-mail notifications to.
  74 Default: \fI"root@localhost"\fP
  75 .TP
  76 \fBsmtp_from\fP
  77 The return address for e-mail notifications.
  78 Default: \fI"root@localhost"\fP
  79
  80 .SH BUGS
  81 Please send any comments or bug reports to \fBinoclam-discuss\fP
  82 mailing list. To subscribe, visit the mailman web interface at
  83 https://lists.sourceforge.net/lists/listinfo/inoclam-discuss
  84
  85 .SH HOMEPAGE
  86 http://www.inoclam.org/
  87
  88 .SH AUTHORS
  89 Tom Cort <tom.cort@state.vt.us>
  90 .br
  91 Matt Gagne <matt.gagne@state.vt.us>
  92
  93 .SH COPYRIGHT
  94 Copyright \(co 2007 Vermont Department of Taxes
  95
  96 This program is free software; you can redistribute it and/or modify
  97 it under the terms of the GNU General Public License as published by
  98 the Free Software Foundation; either version 2 of the License, or
  99 (at your option) any later version.
 100
 101 This program is distributed in the hope that it will be useful,
 102 but WITHOUT ANY WARRANTY; without even the implied warranty of
 103 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 104 GNU General Public License for more details.
 105
 106 You should have received a copy of the GNU General Public License
 107 along with this program; if not, write to the Free Software
 108 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
 109
 110 .SH "SEE ALSO"
 111 .PP
 112 \fBinoclam\fR(8)