Mercurial > sm-archive
annotate xml/sm-archive.in @ 19:b24369330483 stable-1-0-7
Fedora 9 compile and const correctness.
| author | Carl Byington <carl@five-ten-sg.com> |
|---|---|
| date | Thu, 12 Jun 2008 18:17:33 -0700 |
| parents | 8ebecad6530f |
| children | 9298f8b00db2 |
| 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> | |
|
17
8ebecad6530f
Add src/daemon* missing from source control.
Carl Byington <carl@five-ten-sg.com>
parents:
14
diff
changeset
|
22 <date>2008-03-21</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> | |
| 76 </variablelist> | |
| 77 </refsect1> | |
| 78 | |
| 79 <refsect1 id='usage.1'> | |
| 80 <title>Usage</title> | |
| 81 <para><command>@PACKAGE@</command> -c</para> | |
| 4 | 82 <para><command>@PACKAGE@</command> -d 10 -p local:sm-archive.sock</para> |
| 0 | 83 </refsect1> |
| 84 | |
| 85 <refsect1 id='installation.1'> | |
| 86 <title>Installation</title> | |
| 87 <para> | |
| 88 This is now a standard GNU autoconf/automake installation, so the normal | |
| 89 "./configure; make; su; make install" works. "make chkconfig" will | |
| 90 setup the init.d runlevel scripts. Alternatively, you can use the | |
| 91 source or binary RPMs at <ulink | |
| 92 url="http://www.five-ten-sg.com/@PACKAGE@/packages">http://www.five-ten-sg.com/@PACKAGE@/packages</ulink>. | |
| 93 </para> | |
| 94 <para> | |
| 95 Note that this has ONLY been tested on Linux, specifically RedHat Linux. | |
| 96 You will need at a minimum a C++ compiler with a | |
| 97 minimally thread safe STL implementation. The distribution includes a | |
| 98 test.cpp program. If it fails this milter won't work. If it passes, | |
| 99 this milter might work. | |
| 100 </para> | |
| 101 <para> | |
| 102 Modify your sendmail.mc by adding | |
| 103 the following line in your sendmail.mc and rebuild the .cf file | |
| 104 </para> | |
| 105 <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> | |
| 106 <para> | |
| 107 Modify the default <citerefentry> | |
| 108 <refentrytitle>@PACKAGE@.conf</refentrytitle> <manvolnum>5</manvolnum> | |
| 109 </citerefentry> configuration. | |
| 110 </para> | |
| 111 </refsect1> | |
| 112 | |
| 113 <refsect1 id='configuration.1'> | |
| 114 <title>Configuration</title> | |
| 115 <para> | |
| 116 The configuration file is documented in <citerefentry> | |
| 117 <refentrytitle>@PACKAGE@.conf</refentrytitle> <manvolnum>5</manvolnum> | |
| 118 </citerefentry>. Any change to the config file, or any file included | |
| 119 from that config file, will cause it to be reloaded within three | |
| 120 minutes. | |
| 121 </para> | |
| 122 </refsect1> | |
| 123 | |
| 124 <refsect1 id='introduction.1'> | |
| 125 <title>Introduction</title> | |
| 126 <para> | |
| 127 Consider the problem of archiving all the mail sent to or from particular | |
| 128 email addresses or domains. This milter allows you to configure archive | |
| 129 mailboxes for each address or domain. It will add the address of the archive | |
| 130 mailbox to messages that pass thru this milter. | |
| 131 </para> | |
| 132 <para> | |
| 4 | 133 The archive milter reads a text configuration file (sm-archive.conf) on |
| 0 | 134 startup, and whenever the config file (or any of the referenced include |
| 135 files) is changed. The entire configuration file is case insensitive. | |
| 136 If the configuration cannot be loaded due to a syntax error, the milter | |
| 137 will log the error and quit. If the configuration cannot be reloaded | |
| 138 after being modified, the milter will log the error and send an email to | |
| 139 root from sm-archive@$hostname. You probably want to added sm-archive@$hostname | |
| 140 to your /etc/mail/virtusertable since otherwise sendmail will reject | |
| 141 that message. | |
| 142 </para> | |
| 143 </refsect1> | |
| 144 | |
| 145 <refsect1 id='todo.1'> | |
| 146 <title>TODO</title> | |
| 147 <para> | |
| 148 Placeholder for future ideas. | |
| 149 </para> | |
| 150 </refsect1> | |
| 151 | |
| 152 <refsect1 id='copyright.1'> | |
| 153 <title>Copyright</title> | |
| 154 <para> | |
| 13 | 155 Copyright (C) 2007 by 510 Software Group <carl@five-ten-sg.com> |
| 0 | 156 </para> |
| 157 <para> | |
| 158 This program is free software; you can redistribute it and/or modify it | |
| 159 under the terms of the GNU General Public License as published by the | |
| 13 | 160 Free Software Foundation; either version 3, or (at your option) any |
| 0 | 161 later version. |
| 162 </para> | |
| 163 <para> | |
| 164 You should have received a copy of the GNU General Public License along | |
| 165 with this program; see the file COPYING. If not, please write to the | |
| 166 Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. | |
| 167 </para> | |
| 168 </refsect1> | |
| 169 | |
| 170 <refsect1 id='version.1'> | |
|
17
8ebecad6530f
Add src/daemon* missing from source control.
Carl Byington <carl@five-ten-sg.com>
parents:
14
diff
changeset
|
171 <title>Version</title> |
| 0 | 172 <para> |
|
17
8ebecad6530f
Add src/daemon* missing from source control.
Carl Byington <carl@five-ten-sg.com>
parents:
14
diff
changeset
|
173 @VERSION@ |
| 0 | 174 </para> |
| 175 </refsect1> | |
| 176 </refentry> | |
| 177 | |
| 178 | |
| 179 <refentry id="@PACKAGE@.conf.5"> | |
| 180 <refentryinfo> | |
|
17
8ebecad6530f
Add src/daemon* missing from source control.
Carl Byington <carl@five-ten-sg.com>
parents:
14
diff
changeset
|
181 <date>2008-03-21</date> |
| 0 | 182 </refentryinfo> |
| 183 | |
| 184 <refmeta> | |
| 185 <refentrytitle>@PACKAGE@.conf</refentrytitle> | |
| 186 <manvolnum>5</manvolnum> | |
| 187 <refmiscinfo>@PACKAGE@ @VERSION@</refmiscinfo> | |
| 188 </refmeta> | |
| 189 | |
| 190 <refnamediv id='name.5'> | |
| 191 <refname>@PACKAGE@.conf</refname> | |
| 192 <refpurpose>configuration file for @PACKAGE@ sendmail milter</refpurpose> | |
| 193 </refnamediv> | |
| 194 | |
| 195 <refsynopsisdiv id='synopsis.5'> | |
| 196 <title>Synopsis</title> | |
| 197 <cmdsynopsis> | |
| 198 <command>@PACKAGE@.conf</command> | |
| 199 </cmdsynopsis> | |
| 200 </refsynopsisdiv> | |
| 201 | |
| 202 <refsect1 id='description.5'> | |
| 203 <title>Description</title> | |
| 204 <para>The <command>@PACKAGE@.conf</command> configuration file is | |
| 205 specified by this partial bnf description.</para> | |
| 206 | |
| 207 <literallayout class="monospaced"><![CDATA[ | |
| 208 CONFIG = {ENV-FROM ENV-TO}+ | |
| 209 ENV-FROM = env_from "{" LIST "}" ";" | |
| 210 ENV-TO = rcpt_to "{" LIST "}" ";" | |
| 211 LIST = ELEMENT {LIST}+ | |
| 13 | 212 ELEMENT = ADDRESS TARGET ["remove"] ";" |
| 0 | 213 ADDRESS = (USER@ | DOMAIN | USER@DOMAIN) |
| 14 | 214 TARGET = ("" | USER@DOMAIN)]]></literallayout> |
| 0 | 215 </refsect1> |
| 216 | |
| 217 <refsect1 id='sample.5'> | |
| 218 <title>Sample</title> | |
| 219 <literallayout class="monospaced"><![CDATA[ | |
| 220 env_from { | |
| 221 fred@example.com manager@example.com; | |
| 222 example.com archive@example.com; | |
| 14 | 223 |
| 224 # suppress archiving for joe | |
| 225 joe@example.com ""; | |
| 0 | 226 }; |
| 227 | |
| 228 rcpt_to { | |
| 229 fred@example.com manager@example.com; | |
| 230 | |
| 14 | 231 # sam does not get a copy |
| 232 sam@example.com manager@example.com remove; | |
| 0 | 233 };]]></literallayout> |
| 234 </refsect1> | |
| 235 | |
| 236 <refsect1 id='version.5'> | |
|
17
8ebecad6530f
Add src/daemon* missing from source control.
Carl Byington <carl@five-ten-sg.com>
parents:
14
diff
changeset
|
237 <title>Version</title> |
| 0 | 238 <para> |
|
17
8ebecad6530f
Add src/daemon* missing from source control.
Carl Byington <carl@five-ten-sg.com>
parents:
14
diff
changeset
|
239 @VERSION@ |
| 0 | 240 </para> |
| 241 </refsect1> | |
| 242 | |
| 243 </refentry> | |
| 244 </reference> |