Format with `%#x' instead of `0x%x' if difference matters not.

[nmh] / INSTALL

diff --git a/INSTALL b/INSTALL
index eb2971d30ce111d8e2b8debb031d5c004f1920d2..5f1b88aaddf3d95598f64c2f4f0f4d4771ea878d 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -5,10 +5,9 @@
 --------------------------------
 Installing nmh, guided by script
 --------------------------------
 --------------------------------
 Installing nmh, guided by script
 --------------------------------

-For routine installation on popular platforms, the shell script in
-docs/contrib/build_nmh can be used to guide you through configuration.
-It will then build and optionally (with -i) install in the configured
-location.
+For routine installation on popular platforms, the build_nmh shell
+script can be used to guide you through configuration.  It will then
+build and optionally (with -i) install in the configured location.

 
 
 ------------------------
 
 
 ------------------------


@@ -136,7 +135,7 @@ linking that the "configure" script does not know about, by giving
 "configure" initial values for these on its command line or in its
 environment.  For example,
 
 "configure" initial values for these on its command line or in its
 environment.  For example,
 

-    ./configure CC=c89 CFLAGS=-O2 LIBS=-lposix
+    ./configure CC=c99 CFLAGS=-O2 LIBS=-lposix

 
 If you wish to add options that are only used at compile time instead of
 link time, you can use the CPPFLAGS variable:
 
 If you wish to add options that are only used at compile time instead of
 link time, you can use the CPPFLAGS variable:


@@ -184,18 +183,17 @@ Options for configure
 --bindir=DIR     (DEFAULT is ${prefix}/bin)
      nmh's binaries (show, inc, comp, ...) are installed here.
 
 --bindir=DIR     (DEFAULT is ${prefix}/bin)
      nmh's binaries (show, inc, comp, ...) are installed here.
 

---libdir=DIR     (DEFAULT is ${prefix}/lib)
-     nmh's support binaries (post, slocal, mhl, ...) are installed here.
+--libexecdir=DIR     (DEFAULT is ${prefix}/libexec)
+     nmh's support binaries (post, slocal, mhl, ...) are installed
+     in ${libexecdir}/nmh.

 
 --sysconfdir=DIR     (DEFAULT is ${prefix}/etc)
 
 --sysconfdir=DIR     (DEFAULT is ${prefix}/etc)

-     nmh's config files (mts.conf, mhn.defaults, ...) are installed here.
+     nmh's config files (mts.conf, mhn.defaults, ...) are installed
+     in ${sysconfdir}/nmh.

 
 --mandir=DIR     (DEFAULT is ${prefix}/man)
      nmh's man pages are installed here.
 
 
 --mandir=DIR     (DEFAULT is ${prefix}/man)
      nmh's man pages are installed here.
 

---enable-debug
-     Enable debugging support.
-

 --with-editor=EDITOR  (DEFAULT is vi)
      specify the full path of the default editor to use.  If this
      option is not given, then the configuration process will search
 --with-editor=EDITOR  (DEFAULT is vi)
      specify the full path of the default editor to use.  If this
      option is not given, then the configuration process will search


@@ -204,7 +202,7 @@ Options for configure
      nmh command `prompter'.  If you specify `prompter', then you don't
      need to give the full pathname.
 
      nmh command `prompter'.  If you specify `prompter', then you don't
      need to give the full pathname.
 

---with-locking=LOCKTYPE    (DEFAULT is dot)
+--with-locking=LOCKTYPE    (DEFAULT is based on operating system)

      Specify the locking mechanism when attempting to "inc" or
      "msgchk" a local mail spool. Valid options are "dot",
      "fcntl", "flock", and "lockf". Of the four, dot-locking
      Specify the locking mechanism when attempting to "inc" or
      "msgchk" a local mail spool. Valid options are "dot",
      "fcntl", "flock", and "lockf". Of the four, dot-locking


@@ -225,12 +223,12 @@ Options for configure
      locked.
 
 --with-mts=MTS   (DEFAULT is smtp)
      locked.
 
 --with-mts=MTS   (DEFAULT is smtp)

-     Specify the default mail transport system you want to use.  The two
-     acceptable options are "smtp" (which is the default), and
-     "sendmail".  This value will be put into the mts.conf file.  You
-     may find it convenient to specify a value at configure-time,
-     however, so that each time nmh is reinstalled, the right value will
-     be there.
+     Specify the default mail transport system you want to use.  The three
+     acceptable options are "smtp" (which is the default),
+     "sendmail/smtp", and "sendmail/pipe".  This value will be put into
+     the mts.conf file.  You may find it convenient to specify a value
+     at configure-time, however, so that each time nmh is reinstalled,
+     the right value will be there.

 
      If you use "smtp", this will enable a direct SMTP (simple mail
      transport protocol) interface in nmh.  When sending mail, instead
 
      If you use "smtp", this will enable a direct SMTP (simple mail
      transport protocol) interface in nmh.  When sending mail, instead


@@ -239,12 +237,14 @@ Options for configure
      in the `mts.conf' file (default is localhost), and speak SMTP
      directly.
 
      in the `mts.conf' file (default is localhost), and speak SMTP
      directly.
 

-     If you use "sendmail", then `post' will send messages by forking a
+     If you use "sendmail/smtp", then `post' will send messages by forking a

      local copy of sendmail.  Currently it will still speak SMTP with
      this local copy of sendmail.
 
      local copy of sendmail.  Currently it will still speak SMTP with
      this local copy of sendmail.
 

-     If you wish to use a transport agent other than sendmail, you will
-     need to use a `sendmail wrapper'.
+     If you use "sendmail/pipe", then `post' will open a pipe to the
+     sendmail program and invoke it with the '-t' and '-i' options
+     and write the message to sendmail's standard input.  Note that
+     some nmh functionality is not available in this mode.

 
 --with-ndbm=LIB    (DEFAULT is to autodetect)
 --with-ndbmheader=HEADER     (DEFAULT is to autodetect)
 
 --with-ndbm=LIB    (DEFAULT is to autodetect)
 --with-ndbmheader=HEADER     (DEFAULT is to autodetect)


@@ -257,12 +257,7 @@ Options for configure
      If either of these options is given then the other must also be
      specified.
 
      If either of these options is given then the other must also be
      specified.
 

---with-pager=PAGER    (DEFAULT is more)
-     Specify the default pager (file lister) to use.  If this option
-     is not given, then the configuration process will search for the
-     command `more' and use it as the default.
-
---with-smtpservers='SMTPSERVER1[ SMTPSERVER2...]'    (DEFAULT is localhost)
+--with-smtpserver='SMTPSERVER'    (DEFAULT is localhost)

      If this option is not specified, the mts.conf file will contain
      the line "servers: localhost", which may be manually edited later.
      You may find it convenient to specify a value at configure-time,
      If this option is not specified, the mts.conf file will contain
      the line "servers: localhost", which may be manually edited later.
      You may find it convenient to specify a value at configure-time,


@@ -271,15 +266,19 @@ Options for configure
 
      See the mh-tailor(5) man page for full documentation of "servers:".
 
 
      See the mh-tailor(5) man page for full documentation of "servers:".
 

---with-cyrus-sasl      (DEFAULT is without)
+--with-cyrus-sasl      (DEFAULT is to autodetect))

      Enable SASL support for SMTP and POP via the Cyrus SASL library.
      This is used for the POP AUTH and SMTP AUTH protocols.  This supports
      a wide variety of security mechanisms, including Kerberos/GSSAPI.
      Session encryption via SASL is supported for both POP and SMTP
      (depending on server-side support and the security mechanism in use).
 
      Enable SASL support for SMTP and POP via the Cyrus SASL library.
      This is used for the POP AUTH and SMTP AUTH protocols.  This supports
      a wide variety of security mechanisms, including Kerberos/GSSAPI.
      Session encryption via SASL is supported for both POP and SMTP
      (depending on server-side support and the security mechanism in use).
 

---with-tls             (DEFAULT is without)
-     Enable TLS session encryption support for SMTP via the STARTTLS command.
+--with-tls             (DEFAULT is to autodetect)
+     Enable TLS session encryption support for SMTP via the STARTTLS command
+     and TLS at connection start for both SMTP and POP.
+
+--with-oauth           (DEFAULT is to enable if curl is installed)
+     Enable OAuth2 authentication for SMTP and POP.

 
 --with-readline                (DEFAULT is to autodetect)
      Enable support for readline functionality (command history/editing) at
 
 --with-readline                (DEFAULT is to autodetect)
      Enable support for readline functionality (command history/editing) at