Mercurial > sm-archive
annotate xml/sm-archive.in @ 28:946961e534b4 default tip
Added tag stable-1-0-10 for changeset 9298f8b00db2
| author | Carl Byington <carl@five-ten-sg.com> |
|---|---|
| date | Thu, 24 May 2018 10:38:44 -0700 |
| parents | 9298f8b00db2 |
| children |
| rev | line source |
|---|---|
| 0 | 1 <reference> |
| 2 <title>@PACKAGE@ Sendmail milter - Version @VERSION@</title> | |
| 3 <partintro> | |
| 4 <title>Packages</title> | |
|
17
8ebecad6530f
Add src/daemon* missing from source control.
Carl Byington <carl@five-ten-sg.com>
parents:
14
diff
changeset
|
5 |
| 0 | 6 <para>The various source and binary packages are available at <ulink |
| 7 url="http://www.five-ten-sg.com/@PACKAGE@/packages/">http://www.five-ten-sg.com/@PACKAGE@/packages/</ulink> | |
| 8 The most recent documentation is available at <ulink | |
| 9 url="http://www.five-ten-sg.com/@PACKAGE@/">http://www.five-ten-sg.com/@PACKAGE@/</ulink> | |
| 10 </para> | |
| 11 | |
|
17
8ebecad6530f
Add src/daemon* missing from source control.
Carl Byington <carl@five-ten-sg.com>
parents:
14
diff
changeset
|
12 <para>A <ulink |
|
8ebecad6530f
Add src/daemon* missing from source control.
Carl Byington <carl@five-ten-sg.com>
parents:
14
diff
changeset
|
13 url="http://www.selenic.com/mercurial/wiki/">Mercurial</ulink> source |
|
8ebecad6530f
Add src/daemon* missing from source control.
Carl Byington <carl@five-ten-sg.com>
parents:
14
diff
changeset
|
14 code repository for this project is available at <ulink |
|
8ebecad6530f
Add src/daemon* missing from source control.
Carl Byington <carl@five-ten-sg.com>
parents:
14
diff
changeset
|
15 url="http://hg.five-ten-sg.com/@PACKAGE@/">http://hg.five-ten-sg.com/@PACKAGE@/</ulink>. |
|
8ebecad6530f
Add src/daemon* missing from source control.
Carl Byington <carl@five-ten-sg.com>
parents:
14
diff
changeset
|
16 </para> |
|
8ebecad6530f
Add src/daemon* missing from source control.
Carl Byington <carl@five-ten-sg.com>
parents:
14
diff
changeset
|
17 |
| 0 | 18 </partintro> |
| 19 | |
| 20 <refentry id="@PACKAGE@.1"> | |
| 21 <refentryinfo> | |
|
27
9298f8b00db2
patches from Takao Abe add switches for config and pid files
Carl Byington <carl@five-ten-sg.com>
parents:
17
diff
changeset
|
22 <date>2018-05-24</date> |
| 0 | 23 </refentryinfo> |
| 24 | |
| 25 <refmeta> | |
| 26 <refentrytitle>@PACKAGE@</refentrytitle> | |
| 27 <manvolnum>1</manvolnum> | |
| 28 <refmiscinfo>@PACKAGE@ @VERSION@</refmiscinfo> | |
| 29 </refmeta> | |
| 30 | |
| 31 <refnamediv id='name.1'> | |
| 32 <refname>@PACKAGE@</refname> | |
| 33 <refpurpose>a sendmail milter to add recipients to messages</refpurpose> | |
| 34 </refnamediv> | |
| 35 | |
| 36 <refsynopsisdiv id='synopsis.1'> | |
| 37 <title>Synopsis</title> | |
| 38 <cmdsynopsis> | |
| 39 <command>@PACKAGE@</command> | |
| 40 <arg><option>-c</option></arg> | |
| 41 <arg><option>-d <replaceable class="parameter">n</replaceable></option></arg> | |
| 42 <arg><option>-p <replaceable class="parameter">sendmail-socket</replaceable></option></arg> | |
| 43 <arg><option>-t <replaceable class="parameter">timeout</replaceable></option></arg> | |
| 44 </cmdsynopsis> | |
| 45 </refsynopsisdiv> | |
| 46 | |
| 47 <refsect1 id='options.1'> | |
| 48 <title>Options</title> | |
| 49 <variablelist> | |
| 50 <varlistentry> | |
| 51 <term>-c</term> | |
| 52 <listitem><para> | |
| 53 Load the configuration file, print a cannonical form | |
| 54 of the configuration on stdout, and exit. | |
| 55 </para></listitem> | |
| 56 </varlistentry> | |
| 57 <varlistentry> | |
| 58 <term>-d <replaceable class="parameter">n</replaceable></term> | |
| 59 <listitem><para> | |
| 60 Set the debug level to <replaceable class="parameter">n</replaceable>. | |
| 61 </para></listitem> | |
| 62 </varlistentry> | |
| 63 <varlistentry> | |
| 64 <term>-p <replaceable class="parameter">sendmail-socket</replaceable></term> | |
| 65 <listitem><para> | |
| 66 Set the socket used for the milter connection to sendmail. This is either | |
| 67 "inet:port@ip-address" or "local:local-domain-socket-file-name". | |
| 68 </para></listitem> | |
| 69 </varlistentry> | |
| 70 <varlistentry> | |
| 71 <term>-t <replaceable class="parameter">timeout</replaceable></term> | |
| 72 <listitem><para> | |
| 73 Set the timeout in seconds used for communication with sendmail. | |
| 74 </para></listitem> | |
| 75 </varlistentry> | |
|
27
9298f8b00db2
patches from Takao Abe add switches for config and pid files
Carl Byington <carl@five-ten-sg.com>
parents:
17
diff
changeset
|
76 <varlistentry> |
|
9298f8b00db2
patches from Takao Abe add switches for config and pid files
Carl Byington <carl@five-ten-sg.com>
parents:
17
diff
changeset
|
77 <term>-C <replaceable class="parameter">config-file</replaceable></term> |
|
9298f8b00db2
patches from Takao Abe add switches for config and pid files
Carl Byington <carl@five-ten-sg.com>
parents:
17
diff
changeset
|
78 <listitem><para> |
|
9298f8b00db2
patches from Takao Abe add switches for config and pid files
Carl Byington <carl@five-ten-sg.com>
parents:
17
diff
changeset
|
79 Specify the config file, defaults to sm-archive.conf in the current directory. |
|
9298f8b00db2
patches from Takao Abe add switches for config and pid files
Carl Byington <carl@five-ten-sg.com>
parents:
17
diff
changeset
|
80 </para></listitem> |
|
9298f8b00db2
patches from Takao Abe add switches for config and pid files
Carl Byington <carl@five-ten-sg.com>
parents:
17
diff
changeset
|
81 </varlistentry> |
|
9298f8b00db2
patches from Takao Abe add switches for config and pid files
Carl Byington <carl@five-ten-sg.com>
parents:
17
diff
changeset
|
82 <varlistentry> |
|
9298f8b00db2
patches from Takao Abe add switches for config and pid files
Carl Byington <carl@five-ten-sg.com>
parents:
17
diff
changeset
|
83 <term>-P <replaceable class="parameter">pid-file</replaceable></term> |
|
9298f8b00db2
patches from Takao Abe add switches for config and pid files
Carl Byington <carl@five-ten-sg.com>
parents:
17
diff
changeset
|
84 <listitem><para> |
|
9298f8b00db2
patches from Takao Abe add switches for config and pid files
Carl Byington <carl@five-ten-sg.com>
parents:
17
diff
changeset
|
85 Specify the pid file, defaults to /var/run/sm-archive.pid |
|
9298f8b00db2
patches from Takao Abe add switches for config and pid files
Carl Byington <carl@five-ten-sg.com>
parents:
17
diff
changeset
|
86 </para></listitem> |
|
9298f8b00db2
patches from Takao Abe add switches for config and pid files
Carl Byington <carl@five-ten-sg.com>
parents:
17
diff
changeset
|
87 </varlistentry> |
| 0 | 88 </variablelist> |
| 89 </refsect1> | |
| 90 | |
| 91 <refsect1 id='usage.1'> | |
| 92 <title>Usage</title> | |
| 93 <para><command>@PACKAGE@</command> -c</para> | |
| 4 | 94 <para><command>@PACKAGE@</command> -d 10 -p local:sm-archive.sock</para> |
| 0 | 95 </refsect1> |
| 96 | |
| 97 <refsect1 id='installation.1'> | |
| 98 <title>Installation</title> | |
| 99 <para> | |
| 100 This is now a standard GNU autoconf/automake installation, so the normal | |
| 101 "./configure; make; su; make install" works. "make chkconfig" will | |
| 102 setup the init.d runlevel scripts. Alternatively, you can use the | |
| 103 source or binary RPMs at <ulink | |
| 104 url="http://www.five-ten-sg.com/@PACKAGE@/packages">http://www.five-ten-sg.com/@PACKAGE@/packages</ulink>. | |
| 105 </para> | |
| 106 <para> | |
| 107 Note that this has ONLY been tested on Linux, specifically RedHat Linux. | |
| 108 You will need at a minimum a C++ compiler with a | |
| 109 minimally thread safe STL implementation. The distribution includes a | |
| 110 test.cpp program. If it fails this milter won't work. If it passes, | |
| 111 this milter might work. | |
| 112 </para> | |
| 113 <para> | |
| 114 Modify your sendmail.mc by adding | |
| 115 the following line in your sendmail.mc and rebuild the .cf file | |
| 116 </para> | |
| 117 <para><screen>INPUT_MAIL_FILTER(`sm-archive', `S=local:/var/run/sm-archive/sm-archive.sock, F=T, T=C:30s;S:5m;R:5m;E:5m')</screen></para> | |
| 118 <para> | |
| 119 Modify the default <citerefentry> | |
| 120 <refentrytitle>@PACKAGE@.conf</refentrytitle> <manvolnum>5</manvolnum> | |
| 121 </citerefentry> configuration. | |
| 122 </para> | |
| 123 </refsect1> | |
| 124 | |
| 125 <refsect1 id='configuration.1'> | |
| 126 <title>Configuration</title> | |
| 127 <para> | |
| 128 The configuration file is documented in <citerefentry> | |
| 129 <refentrytitle>@PACKAGE@.conf</refentrytitle> <manvolnum>5</manvolnum> | |
| 130 </citerefentry>. Any change to the config file, or any file included | |
| 131 from that config file, will cause it to be reloaded within three | |
| 132 minutes. | |
| 133 </para> | |
| 134 </refsect1> | |
| 135 | |
| 136 <refsect1 id='introduction.1'> | |
| 137 <title>Introduction</title> | |
| 138 <para> | |
| 139 Consider the problem of archiving all the mail sent to or from particular | |
| 140 email addresses or domains. This milter allows you to configure archive | |
| 141 mailboxes for each address or domain. It will add the address of the archive | |
| 142 mailbox to messages that pass thru this milter. | |
| 143 </para> | |
| 144 <para> | |
| 4 | 145 The archive milter reads a text configuration file (sm-archive.conf) on |
| 0 | 146 startup, and whenever the config file (or any of the referenced include |
| 147 files) is changed. The entire configuration file is case insensitive. | |
| 148 If the configuration cannot be loaded due to a syntax error, the milter | |
| 149 will log the error and quit. If the configuration cannot be reloaded | |
| 150 after being modified, the milter will log the error and send an email to | |
| 151 root from sm-archive@$hostname. You probably want to added sm-archive@$hostname | |
| 152 to your /etc/mail/virtusertable since otherwise sendmail will reject | |
| 153 that message. | |
| 154 </para> | |
| 155 </refsect1> | |
| 156 | |
| 157 <refsect1 id='todo.1'> | |
| 158 <title>TODO</title> | |
| 159 <para> | |
| 160 Placeholder for future ideas. | |
| 161 </para> | |
| 162 </refsect1> | |
| 163 | |
| 164 <refsect1 id='copyright.1'> | |
| 165 <title>Copyright</title> | |
| 166 <para> | |
| 13 | 167 Copyright (C) 2007 by 510 Software Group <carl@five-ten-sg.com> |
| 0 | 168 </para> |
| 169 <para> | |
| 170 This program is free software; you can redistribute it and/or modify it | |
| 171 under the terms of the GNU General Public License as published by the | |
| 13 | 172 Free Software Foundation; either version 3, or (at your option) any |
| 0 | 173 later version. |
| 174 </para> | |
| 175 <para> | |
| 176 You should have received a copy of the GNU General Public License along | |
| 177 with this program; see the file COPYING. If not, please write to the | |
| 178 Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. | |
| 179 </para> | |
| 180 </refsect1> | |
| 181 | |
| 182 <refsect1 id='version.1'> | |
|
17
8ebecad6530f
Add src/daemon* missing from source control.
Carl Byington <carl@five-ten-sg.com>
parents:
14
diff
changeset
|
183 <title>Version</title> |
| 0 | 184 <para> |
|
17
8ebecad6530f
Add src/daemon* missing from source control.
Carl Byington <carl@five-ten-sg.com>
parents:
14
diff
changeset
|
185 @VERSION@ |
| 0 | 186 </para> |
| 187 </refsect1> | |
| 188 </refentry> | |
| 189 | |
| 190 | |
| 191 <refentry id="@PACKAGE@.conf.5"> | |
| 192 <refentryinfo> | |
|
27
9298f8b00db2
patches from Takao Abe add switches for config and pid files
Carl Byington <carl@five-ten-sg.com>
parents:
17
diff
changeset
|
193 <date>2018-05-24</date> |
| 0 | 194 </refentryinfo> |
| 195 | |
| 196 <refmeta> | |
| 197 <refentrytitle>@PACKAGE@.conf</refentrytitle> | |
| 198 <manvolnum>5</manvolnum> | |
| 199 <refmiscinfo>@PACKAGE@ @VERSION@</refmiscinfo> | |
| 200 </refmeta> | |
| 201 | |
| 202 <refnamediv id='name.5'> | |
| 203 <refname>@PACKAGE@.conf</refname> | |
| 204 <refpurpose>configuration file for @PACKAGE@ sendmail milter</refpurpose> | |
| 205 </refnamediv> | |
| 206 | |
| 207 <refsynopsisdiv id='synopsis.5'> | |
| 208 <title>Synopsis</title> | |
| 209 <cmdsynopsis> | |
| 210 <command>@PACKAGE@.conf</command> | |
| 211 </cmdsynopsis> | |
| 212 </refsynopsisdiv> | |
| 213 | |
| 214 <refsect1 id='description.5'> | |
| 215 <title>Description</title> | |
| 216 <para>The <command>@PACKAGE@.conf</command> configuration file is | |
| 217 specified by this partial bnf description.</para> | |
| 218 | |
| 219 <literallayout class="monospaced"><![CDATA[ | |
| 220 CONFIG = {ENV-FROM ENV-TO}+ | |
| 221 ENV-FROM = env_from "{" LIST "}" ";" | |
| 222 ENV-TO = rcpt_to "{" LIST "}" ";" | |
| 223 LIST = ELEMENT {LIST}+ | |
| 13 | 224 ELEMENT = ADDRESS TARGET ["remove"] ";" |
| 0 | 225 ADDRESS = (USER@ | DOMAIN | USER@DOMAIN) |
| 14 | 226 TARGET = ("" | USER@DOMAIN)]]></literallayout> |
| 0 | 227 </refsect1> |
| 228 | |
| 229 <refsect1 id='sample.5'> | |
| 230 <title>Sample</title> | |
| 231 <literallayout class="monospaced"><![CDATA[ | |
| 232 env_from { | |
| 233 fred@example.com manager@example.com; | |
| 234 example.com archive@example.com; | |
| 14 | 235 |
| 236 # suppress archiving for joe | |
| 237 joe@example.com ""; | |
| 0 | 238 }; |
| 239 | |
| 240 rcpt_to { | |
| 241 fred@example.com manager@example.com; | |
| 242 | |
| 14 | 243 # sam does not get a copy |
| 244 sam@example.com manager@example.com remove; | |
| 0 | 245 };]]></literallayout> |
| 246 </refsect1> | |
| 247 | |
| 248 <refsect1 id='version.5'> | |
|
17
8ebecad6530f
Add src/daemon* missing from source control.
Carl Byington <carl@five-ten-sg.com>
parents:
14
diff
changeset
|
249 <title>Version</title> |
| 0 | 250 <para> |
|
17
8ebecad6530f
Add src/daemon* missing from source control.
Carl Byington <carl@five-ten-sg.com>
parents:
14
diff
changeset
|
251 @VERSION@ |
| 0 | 252 </para> |
| 253 </refsect1> | |
| 254 | |
| 255 </refentry> | |
| 256 </reference> |