File: MailScanner.xml

package info (click to toggle)
mailscanner 4.79.11-2.2
  • links: PTS
  • area: main
  • in suites: squeeze
  • size: 5,820 kB
  • ctags: 1,309
  • sloc: perl: 25,655; sh: 2,666; xml: 624; makefile: 242
file content (258 lines) | stat: -rw-r--r-- 7,808 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
<?xml version='1.0' encoding='ISO-8859-1'?>
<?xml-stylesheet type="text/xsl"
	href="http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
	"http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [

  <!-- Fill in your name for FIRSTNAME and SURNAME. -->
  <!ENTITY dhfirstname "<firstname>Simon</firstname>">
  <!ENTITY dhsurname   "<surname>Walter</surname>">
  <!-- Please adjust the date whenever revising the manpage. -->
  <!ENTITY dhdate      "<date>09.12.2006</date>">
  <!-- SECTION should be 1-8, maybe w/ subsection other parameters are
       allowed: see man(7), man(1). -->
  <!ENTITY dhsection   "<manvolnum>8</manvolnum>">
  <!ENTITY dhemail     "<email>simon.walter@hp-factory.de</email>">
  <!ENTITY dhusername  "Simon Walter">
  <!ENTITY dhucpackage "<refentrytitle>MailScanner</refentrytitle>">
  <!ENTITY dhpackage   "MailScanner">

  <!ENTITY debian      "<productname>Debian</productname>">
  <!ENTITY gnu         "<acronym>GNU</acronym>">
  <!ENTITY gpl         "&gnu; <acronym>GPL</acronym>">
]>

<refentry>
  <refentryinfo>
    <address>
      &dhemail;
    </address>
    <author>
      &dhfirstname;
      &dhsurname;
    </author>
    <copyright>
      <year>2006</year>
      <holder>&dhusername;</holder>
    </copyright>
    &dhdate;
  </refentryinfo>
  <refmeta>
    &dhucpackage;

    &dhsection;
  </refmeta>
  <refnamediv>
    <refname>&dhpackage;</refname>

    <refpurpose> a email virus scanner and spam tagger.</refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <cmdsynopsis>
      <command>&dhpackage;</command>
      <arg><replaceable>options</replaceable></arg>
			<!-- arg>-value=<replaceable>optionname</replaceable>
				<group>
					<arg>-from=<replaceable>from-address</replaceable></arg><sbr/>
					<arg rep="repeat">-to=<replaceable>to-address</replaceable></arg><sbr/>
					<arg>-ip=<replaceable>ip-address</replaceable></arg>
					<arg>-virus=<replaceable>virus-name</replaceable></arg>
					</group>
			</arg -->
			<arg><replaceable>configfile</replaceable></arg>

    </cmdsynopsis>
  </refsynopsisdiv>
  <refsect1>
    <title>DESCRIPTION</title>

    <para>This manual page documents briefly the
      <command>&dhpackage;</command> options.</para>

    <para>This manual page was written for the &debian; distribution
      because the original program does not have a manual page.</para>

    <para><command>&dhpackage;</command> is a freely distributable
    E-Mail gateway virus scanner and spam detector. It uses sendmail
    or Exim as its basis, and a choice of free/commercial virus
    scanning engines to do the actual virus scanning. It can decode
    and scan attachments intended solely for Microsoft Outlook users
    (MS-TNEF). If possible, it will disinfect infected documents and
    deliver them automatically. It also has features which protect it
    against Denial Of Service attacks.</para>

  </refsect1>
  <refsect1>
    <title>OPTIONS</title>

    <para>A summary of options is included below.</para>

    <variablelist>
      <varlistentry>
	<term>
					<option>-h</option>
					<option>-H</option>
					<option>-help</option>
	</term>
	<listitem>
	  <para>Show summary of options.</para>
	</listitem>
      </varlistentry>
      <varlistentry>
	<term>
					<option>-v</option>
					<option>-V</option>
					<option>-version</option>
					<option>-Version</option>
	</term>
	<listitem>
	  <para>Show version of program and the perl libraries used.</para>
	</listitem>
      </varlistentry>
      <varlistentry>
	<term><option>-lint</option>
	</term>
	<listitem>
	  <para>Test the configuration and report errors.</para>
	</listitem>
      </varlistentry>
      <varlistentry>
	<term>
					<option>-c</option>
					<option>-C</option>
					<option>-changed</option>
	</term>
	<listitem>
					<para>Show all values in the configuration which differ
					from the hardcoded defaults.</para>
	</listitem>
      </varlistentry>
      <varlistentry>
	<term>
					<option>-debug</option>
	</term>
	<listitem>
	  <para>Run MailScanner in debug-mode. In debug-mode
	  MailScanner doesn't spawn childrens and produce a lot of
	  output. Can be compined with -debug-sa.</para>
	</listitem>
      </varlistentry>
      <varlistentry>
	<term>
					<option>-debug-sa</option>
	</term>
	<listitem>
	  <para>Run the spamassassine module inside MailScanner in
	  debug-mode. Warning: This option doesn't stop MailScanner
	  from spawning childrens! Can be compined with -debug.</para>
	</listitem>
      </varlistentry>
      <varlistentry>
	<term>
					<option>-value=optionname</option>
	</term>
	<listitem>
	  <para>Name of the option/rule against which the values of
	  -to, -from, -ip or/and -virus are tested.</para>
	</listitem>
      </varlistentry>
      <varlistentry>
	<term>
					<option>-from=from-address</option>
	</term>
	<listitem>
	  <para>From-address to test the option/rule specified by
	  -value. Can be any part of a mailaddress.</para>
	</listitem>
      </varlistentry>
      <varlistentry>
	<term>
					<option>-to=to-address</option>
	</term>
	<listitem>
	  <para>To-address to test the option/rule specified by
	  -value. Can be used multiple times.</para>
	</listitem>
      </varlistentry>
      <varlistentry>
	<term>
					<option>-ip=ip-address</option>
	</term>
	<listitem>
	  <para>IP-address to test the option/rule specified by
	  -value.</para>
	</listitem>
      </varlistentry>
      <varlistentry>
	<term>
					<option>-virus=virus-name</option>
	</term>
	<listitem>
	  <para>Name of the virus to test the option/rule specified by
	  -value.</para>
	</listitem>
      </varlistentry>

    </variablelist>
  </refsect1>
	<refsect1>
		<title>EXAMPLES</title>

		<variablelist>
			<varlistentry>
				<term><command>&dhpackage; -debug -debug-sa</command></term>
				<listitem><para>Starts MailScanner in full debug-mode.</para></listitem>
			</varlistentry>
			<varlistentry>
				<term><command>&dhpackage; -value=&quot;Is Definitely Not Spam&quot; --from=foo@bar.org</command></term>
				<listitem>
					<para>Test if mails from foo@bar.org are matched by
						the rule for the option &quot;Is Definitely Not Spam.&quot;
						(aka. whitelist). Output:</para>
					<screen>
Looked up internal option name &quot;spamwhitelist&quot;
With sender = foo@bar.org
Client IP =
Virus =
Result is &quot;1&quot;

0=No 1=Yes
					</screen>
				</listitem>
			</varlistentry>
		</variablelist>

	</refsect1>
  <refsect1>
    <title>SEE ALSO</title>

    <variablelist>
      <varlistentry>
				<term>
					<citerefentry><refentrytitle>df2mbox</refentrytitle><manvolnum>8</manvolnum></citerefentry>
					<citerefentry><refentrytitle>d2mbox</refentrytitle><manvolnum>8</manvolnum></citerefentry>
					<citerefentry><refentrytitle>update_phising_sites</refentrytitle><manvolnum>8</manvolnum></citerefentry>
					<citerefentry><refentrytitle>update_virus_scanners</refentrytitle><manvolnum>8</manvolnum></citerefentry>
					<citerefentry><refentrytitle>upgrade_MailScanner_conf</refentrytitle><manvolnum>8</manvolnum></citerefentry>
					<filename>/usr/share/doc/mailscanner/html/MailScanner.conf.index.html</filename>
				</term>
			</varlistentry>
		</variablelist>

  </refsect1>
  <refsect1>
    <title>AUTHOR</title>

    <para>This manual page was written by &dhusername; &dhemail; for
      the &debian; system (but may be used by others).  Permission is
      granted to copy, distribute and/or modify this document under
      the terms of the &gnu; General Public License, Version 2 any
	  later version published by the Free Software Foundation.
    </para>
	<para>
	  On Debian systems, the complete text of the GNU General Public
	  License can be found in /usr/share/common-licenses/GPL.
	</para>

  </refsect1>
</refentry>