Bug#651883: The details of dc_eximconfig_configtype in the documentation

[Regid Ichira]

Package:  exim4-config
Version:  4.77-1
Severity: normal
Tags:     patch
Files:    /usr/share/man/man5/update-exim4.conf.conf.5
          /usr/share/doc/exim4/RERADME.Debian.gz
          /usr/share/doc/exim4/RERADME.Debian.html

  1. /usr/share/doc/exim4/RERADME.Debian.gz
  =========================================
  I will mention the samller patch first so that it won't get lost in
the heavier body of this report.  I think the following will be of some
help to beginners.  Without it, for example, the apearence of smarthost
in the title is, in my opinion, somewhat confusing.

--- a/README.Debian     2011-12-12 03:25:19.728941433 +0200
+++ b/README.Debian     2011-12-12 03:24:13.000000000 +0200
@@ -230,7 +230,7 @@ Exim 4 for Debian
      * Outgoing mail will always be delivered to the smarthost configured
        in exim4.

-2.1.1.1.3. mail sent by smarthost; no local mail
+2.1.1.1.3. satelite; mail sent by smarthost; no local mail

    This option is suitable for a client system in a computer pool which is
    not responsible for a local e-mail domain. All locally generated e-mail


  2. /usr/share/man/man5/update-exim4.conf.conf.5
  ===============================================
  The details for dc_eximconfig_configtype are not found in
update-exim4.conf.conf.5.  The following mostly copies those details
from /usr/share/doc/exim4/README.Debian.gz.

--- a/update-exim4.conf.conf.5  2011-12-11 16:27:47.000000000 +0200
+++ b/update-exim4.conf.conf.5  2011-12-12 03:10:17.000000000 +0200
@@ -165,7 +165,58 @@ The octal file mode of the generated fil
 .I dc_eximconfig_configtype
 The main configuration type. One of \(lqinternet\(rq, \(lqsmarthost\(rq,
 \(lqsatellite\(rq, \(lqlocal\(rq, \(lqexim3manual\(rq or \(lqnone\(rq.
-Sets macro DC_eximconfig_configtype.
+Sets macro DC_eximconfig_configtype.
+.br
+.BR \(lqinternet\(rq
+is anticipated to be used by internet
+sites, mail is sent and received directly using SMTP. This option is
+suitable for a standalone system with full internet connectivity, where
+the Exim SMTP daemon will accept messages to local domains, and deliver
+them locally. Outgoing mail will be delivered directly to the mail
+exchange servers of the recipient domain.
+.br
+.BR \(lqsmarthost\(rq
+mail is sent by smarthost. It is received via SMTP or fetchmail. This
+option is suitable for a standalone client system which has restricted
+internet connectivity, for example on a residential connection where an
+SMTP smarthost is used. Some ISPs block outgoing SMTP connections to
+combat the spam problem, thus requiring the use of their smarthosts.
+It is generally a good idea to use the ISPs smart host if one is
+connected with a dynamic IP address since quite a few sites do not
+accept mail directly delivered from a dial-in pool. fetchmail can be
+used to retrieve incoming mail from the ISP's POP3 or IMAP mail
+server and deliver it to Exim via SMTP. The Exim SMTP daemon will
+accept messages to local domains, and deliver them locally. Outgoing
+mail will always be delivered to the smarthost configured in exim4.
+.br
+.BR \(lqsatelite\(rq
+mail sent by a smarthost; no local mail. This option is suitable for a
+client system in a computer pool which is not responsible for a local
+e-mail domain. All locally generated e-mail is sent to the smarthost
+without any local domains.
+.br
+.BR \(lqlocal\(rq
+is meant for local delivery only; not on a network. This
+option is suitable for a standalone system with no networking at all.
+Only messages for configured local domains are accepted and delivered
+locally; messages for all other domains are rejected:
+``Mailing to remote domains not supported''.
+.br
+.BR \(lqexim3manual\(rq
+is used for upgrading from exim3, which was used by old Debian releases.
+.br
+.BR \(lqnone\(rq
+No configuration at this time. This option disables most of Debian's
+automatisms and leaves exim in an unconfigured state.
+update-exim4.conf will still copy /etc/exim4/exim4.conf.template or
+concatenate the files from /etc/exim4/conf.d, and will not generate any
+configuration control macros. Unless you manually edit the
+configuration source, this will leave Exim with a syntactically invalid
+configuration file, thus in a state where the daemon won't even start.
+Only choose this option if you know what you're doing and are prepared
+to create your own Exim configuration. dpkg-conffile handling is still
+in place, and you will be offered updates for configuration snippets,
+as soon as they become available.
 .TP
 .I dc_hide_mailname
 Boolean option that controls whether the local mailname in the headers of