source: server/mail/sendmail.xml@ b40beacc

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
   "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;

<!ENTITY sendmail-download-ftp "ftp://ftp.sendmail.org/pub/sendmail/sendmail.&sendmail-version;.tar.gz">
<!ENTITY sendmail-download-http "http://www.sendmail.org/ftp/sendmail.&sendmail-version;.tar.gz">
<!ENTITY sendmail-size "2.0 MB">
<!ENTITY sendmail-buildsize "18 MB">
<!ENTITY sendmail-time "0.43 SBU">

]>

<sect1 id="sendmail" xreflabel="Sendmail-&sendmail-version;">
<?dbhtml filename="sendmail.html"?>
<title>Sendmail-&sendmail-version;</title>

<sect2>
<title>Introduction to <application>Sendmail</application></title>

<para>The <application>Sendmail</application> package contains a Mail 
Transport Agent (<acronym>MTA</acronym>).</para>

<sect3><title>Package information</title>
<itemizedlist spacing='compact'>
<listitem><para>Download (HTTP): <ulink url="&sendmail-download-http;"/></para></listitem>
<listitem><para>Download (FTP): <ulink url="&sendmail-download-ftp;"/></para></listitem>
<listitem><para>Download size: &sendmail-size;</para></listitem>
<listitem><para>Estimated Disk space required: &sendmail-buildsize;</para></listitem>
<listitem><para>Estimated build time: &sendmail-time;</para></listitem></itemizedlist>
</sect3>

<sect3><title><application>Sendmail</application> dependencies</title>

<sect4><title>Required</title>
<para><xref linkend="db"/> and <xref linkend="procmail"/>
</para></sect4>

<sect4><title>Optional</title>
<para><xref linkend="openssl"/>, <xref linkend="openldap"/>, 
<xref linkend="tcpwrappers"/>, <xref linkend="pcre"/>, 
<ulink url="http://www-dev.cites.uiuc.edu/ph/nph/">nph</ulink>, 
<ulink url="http://asg.web.cmu.edu/sasl/">Cyrus SASL</ulink> and 
<xref linkend="gs"/> (for creating <acronym>PDF</acronym> documentation)
</para></sect4>
</sect3>

</sect2>

<sect2>
<title>Installation of <application>Sendmail</application></title>

<para>Before building <application>Sendmail</application>, create the users, 
groups and directories that <application>Sendmail</application> requires 
with the following commands:</para>

<screen><userinput><command>groupadd smmsp &amp;&amp;
groupadd mail &amp;&amp;
useradd -g smmsp -G mail smmsp &amp;&amp;
chmod 1777 /tmp &amp;&amp;
chmod 1777 /var/mail &amp;&amp;
mkdir /var/spool/mqueue</command></userinput></screen>

<para>Install <application>Sendmail</application> with the following 
commands:</para>

<screen><userinput><command>cat &gt; devtools/Site/site.config.m4 &lt;&lt; "EOF"
define(`confMANGRP',`root')
define(`confMANOWN',`root')
define(`confSBINGRP',`root')
define(`confUBINGRP',`root')
define(`confUBINOWN',`root')
EOF
cd sendmail &amp;&amp;
sh Build &amp;&amp;
cd ../cf/cf &amp;&amp;
cp generic-linux.mc sendmail.mc &amp;&amp;
mkdir /etc/mail &amp;&amp;
sh Build sendmail.cf &amp;&amp;
sh Build install-cf &amp;&amp;
cd ../../ &amp;&amp;
sh Build install &amp;&amp;
for manpage in sendmail editmap mailstats makemap praliases smrsh 
do
install -o root -g root -m444 $manpage/$manpage.8   /usr/share/man/man8
done &amp;&amp;
install -o root -g root -m444 sendmail/aliases.5    /usr/share/man/man5 &amp;&amp;
install -o root -g root -m444 sendmail/mailq.1      /usr/share/man/man1 &amp;&amp;
install -o root -g root -m444 sendmail/newaliases.1 /usr/share/man/man1 &amp;&amp;
install -o root -g root -m444 vacation/vacation.1   /usr/share/man/man1</command></userinput></screen>

<para><emphasis>Note:</emphasis> See the source tree 
<filename>sendmail/README</filename> file for information on linking optional 
packages into the build.</para>

<para>Install the <application>Sendmail</application> Installation and
Operations Guide with the following commands:</para>

<screen><userinput><command>cd doc/op &amp;&amp;
sed -i -e 's/groff/GROFF_NO_SGR=1 groff/' Makefile &amp;&amp;
make op.txt op.pdf &amp;&amp;
install -d -m 755 /usr/share/doc/sendmail/&sendmail-version; &amp;&amp;
install -m 644 op.ps op.txt op.pdf /usr/share/doc/sendmail/&sendmail-version; &amp;&amp;
cd ../../</command></userinput></screen>

<para><emphasis>Note:</emphasis> remove <filename>op.pdf</filename> from the
<command>make</command> and <command>install</command> commands if you don't
have <application>Ghostscript</application> installed.</para>

</sect2>

<sect2>
<title>Command explanations</title>

<para><command>cat &gt; devtools/Site/site.config.m4 &lt;&lt; "EOF"</command>: 
This creates a configuration file changing some of the default settings.</para>

<screen><userinput><command>sh Build
sh Build sendmail.cf
sh Build install-cf
sh Build install</command></userinput></screen>

<para><application>Sendmail</application> uses an <application>m4</application> 
based build script to create the various <filename>Makefile</filename>'s. These 
commands build and install the package.</para>

<screen><userinput><command>for manpage in...;do...;done:
install ...
install ...</command></userinput></screen>

<para> The man pages are installed already formatted and <command>man</command> 
displays them somewhat garbled. These commands replace the formatted pages with
pages <command>man</command> can display properly.</para>

</sect2>

<sect2>
<title>Configuring <application>Sendmail</application></title>

<sect3><title>Config files</title>
<para><filename>/etc/mail/*</filename></para>
</sect3>

<sect3><title>Configuration Commands</title>

<screen><userinput><command>echo `hostname` > /etc/mail/local-host-names
cat &gt; /etc/mail/aliases &lt;&lt; "EOF"
postmaster: root
MAILER-DAEMON: root
EOF
cp -R cf/* /etc/mail &amp;&amp;
cp cf/cf/{submit,sendmail}.mc /etc/mail &amp;&amp;
newaliases -v</command></userinput></screen>

<para><application>Sendmail</application>'s primary configuration file, 
<filename>/etc/mail/sendmail.cf</filename>, is complex and not meant to be 
directly edited. The recommended method to make changes is to modify 
<filename>/etc/mail/sendmail.mc</filename>, and various
<application>m4</application> files, then run the <command>m4</command> 
macro processor from within <filename class='directory'>/etc/mail</filename> 
as follows:</para>

<screen><userinput><command>m4 m4/cf.m4 sendmail.mc > sendmail.cf</command></userinput></screen>

<para>A full explanation of the files to modify, and the available parameters 
can be found in <filename>/etc/mail/README</filename>.</para>

<para>To automate the running of <application>Sendmail</application> at 
startup, install the <filename>/etc/rc.d/init.d/sendmail</filename>
init script included in the 
<xref linkend="intro-important-bootscripts"/> package.</para>

<screen><userinput><command>make install-sendmail</command></userinput></screen>

<note><para>The -qNm option to <command>sendmail</command>, where N is number 
of minutes, controls how often <application>Sendmail</application> will process 
the mail queue. A default of 5 minutes is used in the init script. Individual 
workstation users may want to set this as low as 1 minute, large installations 
handling more mail may want to set it higher.</para></note>

</sect3>
</sect2>

<sect2>
<title>Contents</title>

<para>The <application>Sendmail</application> package contains
<command>hoststat</command>,
<command>purgestat</command>,
<command>smrsh</command>,
<command>editmap</command>,
<command>makemap</command>,
<command>mailq</command>,
<command>newaliases</command>,
<command>sendmail</command>,
<command>vacation</command>,
<command>praliases</command> and
<command>mailstats</command>.
</para>
</sect2>

<sect2><title>Description</title>

<sect3><title>hoststat</title>
<para><command>hoststat</command> prints <application>Sendmail</application>'s 
persistent host status.</para></sect3>

<sect3><title>purgestat</title>
<para><command>purgestat</command> causes <application>Sendmail</application> 
to clear (purge) all its host-status information.</para></sect3>

<sect3><title>smrsh</title>
<para><command>smrsh</command> is a restricted shell for 
<application>Sendmail</application>.</para></sect3>

<sect3><title>editmap</title>
<para><command>editmap</command> queries and edits 
<application>Sendmail</application> map files.</para></sect3>

<sect3><title>makemap</title>
<para><command>makemap</command> creates 
<application>Sendmail</application> map files.</para></sect3>

<sect3><title>mailq</title>
<para><command>mailq</command> prints a summary of outbound mail messages 
waiting for delivery.</para></sect3>

<sect3><title>newaliases</title>
<para><command>newaliases</command> rebuilds 
<filename>/etc/mail/aliases.db</filename>.</para></sect3>

<sect3><title>sendmail</title>
<para><command>sendmail</command> is the <application>Sendmail</application> 
mail transport agent.</para></sect3>

<sect3><title>vacation</title>
<para><command>vacation</command> is an email auto responder.</para></sect3>

<sect3><title>praliases</title>
<para><command>praliases</command> displays current 
<application>Sendmail</application> aliases.</para></sect3>

<sect3><title>mailstats</title>
<para><command>mailstats</command> displays 
<application>Sendmail</application> statistics.</para></sect3>

</sect2>

</sect1>