update manpage and homepage
[undersmtpd.git] / _smtpd.html
diff --git a/_smtpd.html b/_smtpd.html
new file mode 100644 (file)
index 0000000..858dee8
--- /dev/null
@@ -0,0 +1,113 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+<head>
+<title>_smtpd - UnderSMTPD, the underscore SMTP daemon</title>
+<link rev="made" href="mailto:root@localhost" />
+</head>
+
+<body style="background-color: white">
+
+<p><a name="__index__"></a></p>
+<!-- INDEX BEGIN -->
+
+<ul>
+
+       <li><a href="#name">NAME</a></li>
+       <li><a href="#synopsis">SYNOPSIS</a></li>
+       <li><a href="#description">DESCRIPTION</a></li>
+       <li><a href="#options">OPTIONS</a></li>
+       <li><a href="#aliases_format">ALIASES FORMAT</a></li>
+       <li><a href="#rt_aliases_example">RT ALIASES EXAMPLE</a></li>
+       <li><a href="#bugs">BUGS</a></li>
+       <li><a href="#author">AUTHOR</a></li>
+       <li><a href="#see_also">SEE ALSO</a></li>
+</ul>
+<!-- INDEX END -->
+
+<hr />
+<p>
+</p>
+<h1><a name="name">NAME</a></h1>
+<p>_smtpd - UnderSMTPD, the underscore SMTP daemon</p>
+<p>
+</p>
+<hr />
+<h1><a name="synopsis">SYNOPSIS</a></h1>
+<pre>
+  #make some aliases
+  echo 'username: &quot;|someprogram and args&quot; &gt; /etc/aliases</pre>
+<pre>
+  #inetd setup
+  echo &quot;smtp stream tcp nowait mail /usr/local/bin/_smtpd&quot; &gt;&gt;/etc/inetd.conf
+  echo &quot;_smtpd: my.mail.server.ip&quot;                         &gt;&gt;/etc/hosts.allow
+  echo &quot;_smtpd: ALL&quot;                                       &gt;&gt;/etc/hosts.deny</pre>
+<pre>
+  #or add an smtp file to /etc/xinetd.d/
+  service smtp
+  {
+        socket_type = stream
+        protocol    = tcp
+        wait        = no
+        user        = mail
+        server      = /usr/local/bin/_smtpd
+  }</pre>
+<p>
+</p>
+<hr />
+<h1><a name="description">DESCRIPTION</a></h1>
+<p>This is a minimal SMTP server which only forwards mail to pipe destinations
+in /etc/aliases.  It does nothing else.  Its intended function is on an
+internal mail server that forwards mail to other programs on a per address
+basis.</p>
+<p>UnderSMTPD reads /etc/aliases for usernames; if a match is identified
+the message is piped to the given program.  Any problems executing the program
+will cause a temporary SMTP error to be returned to the connecting client.</p>
+<p>Other kinds of aliases are not recognized and cause a perminant SMTP error
+to be returned to the connecting client, as do usernames not found in
+/etc/aliases</p>
+<p>UnderSMTP was originally written to be used with the Request Tracker ticketing
+system.</p>
+<p>UnderSMTP uses Net::SMTP::Mail to do all the hard work.</p>
+<p>
+</p>
+<hr />
+<h1><a name="options">OPTIONS</a></h1>
+<dl>
+<dt><strong><a name="item__2da_filename_3a_alternate_aliases_file">-a filename: Alternate aliases file</a></strong><br />
+</dt>
+</dl>
+<p>
+</p>
+<hr />
+<h1><a name="aliases_format">ALIASES FORMAT</a></h1>
+<pre>
+  username: |program and args
+  username: &quot;|program and args&quot;</pre>
+<p>Quotes are not necessary around the pipe symbol, program and arguments but are
+stripped if present.  Line continuations are not supported.</p>
+<p>
+</p>
+<hr />
+<h1><a name="rt_aliases_example">RT ALIASES EXAMPLE</a></h1>
+<pre>
+  support: |/opt/rt3/bin/rt-mailgate --queue support --action correspond --url <a href="http://rt.example.com/">http://rt.example.com/</a>
+  billing: |/opt/rt3/bin/rt-mailgate --queue billing --action correspond --url <a href="http://rt.example.com/">http://rt.example.com/</a></pre>
+<p>
+</p>
+<hr />
+<h1><a name="bugs">BUGS</a></h1>
+<p>Yes.</p>
+<p>
+</p>
+<hr />
+<h1><a name="author">AUTHOR</a></h1>
+<p>Ivan Kohler &lt;<a href="mailto:ivan-undersmtpd@420.am">ivan-undersmtpd@420.am</a>&gt;</p>
+<p>
+</p>
+<hr />
+<h1><a name="see_also">SEE ALSO</a></h1>
+<p><a href="/Net/SMTP/Mail.html">the Net::SMTP::Mail manpage</a></p>
+
+</body>
+
+</html>