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

[nmh] / INSTALL

diff --git a/INSTALL b/INSTALL
index 92bffa21250410ef794fdb6d45e5a85bb9c1c29f..5f1b88aaddf3d95598f64c2f4f0f4d4771ea878d 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -1,12 +1,18 @@
 #
 # INSTALL -- installation instructions
 #
 #
 # INSTALL -- installation instructions
 #

-# $Id$
-#

 
 

---------------
-Installing nmh
---------------
+--------------------------------
+Installing nmh, guided by script
+--------------------------------
+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.
+
+
+------------------------
+Installing nmh, manually
+------------------------

 Please read all of the following instructions before you begin
 building nmh.
 
 Please read all of the following instructions before you begin
 building nmh.
 


@@ -14,30 +20,55 @@ You should check the MACHINES file to see if there are any specific
 build instructions for your operating system.  To build nmh, you will
 need an ANSI C compiler such as gcc.
 
 build instructions for your operating system.  To build nmh, you will
 need an ANSI C compiler such as gcc.
 

-1) Run the command
+0) If you have obtained nmh by checking it out of the git repository,
+   you will need to run the GNU autotools to regenerate some files.
+   (If your directory already contains a file 'config.h.in' then this
+   has already been done and you do not need to do it.)  You can
+   regenerate the files by running the command
+
+   ./autogen.sh

 
 

-   sh configure [options]
+   (Note that if you're doing nmh development, you should look at
+   docs/README.developers, since there is other developer-friendly
+   advice there as well.)

 
 

-   This will check the configuration of your OS, and create
-   the include file config.h, as well as the various Makefiles.
+   If you have obtained nmh in the form of a tar archive and are
+   trying to unpack it with cpio:  due to an apparent bug in cpio, it
+   might fail with "Malformed number" error messages.  Try another
+   tool to unpack, such as tar or pax.
+
+1) From the top-level source directory, run the command
+
+   ./configure [options]
+
+   This will check the configuration of your OS, and create the
+   include file config.h, as well as the Makefile.

 
    The configure script accepts various options.  The options of
 
    The configure script accepts various options.  The options of

-   most interest are listed below.  To see the list of all available
-   options, you can run
+   most interest are listed in a section below.  To see the list
+   of all available options, you can run
+
+   ./configure --help

 
 

-   sh configure --help
+2) make

 
 

-2) (IMPORTANT)  Edit the user configuration section at the beginning
-   of the generated include file `config.h'.  Currently, not everything
-   is auto-configured, so some #defines must be set manually.
+3) (Optional) make check

 
 

-3) Edit the user configuration section at the top of the main Makefile.
+   This takes a bit of time, around one minute on a modern machine,
+   but is highly recommended.

 
 

-4) make
+   test/inc/test-deb359167 uses valgrind, which detects use of an
+   uninitialized variable on older Linux distributions such as
+   Mandriva 2007.0 and CentOS 5.4.  That particular failure is
+   beyond the scope of nmh and can be ignored.

 
 

-5) make install
+4) make install

 
 

-6) Edit the file `mts.conf' (installed in the nmh `etc' directory)
+   Note that if you have [n]mh files in your install directories with
+   the same names as the files being installed, the old ones will get
+   overwritten without any warning.
+
+5) Edit the file `mts.conf' (installed in the nmh `etc' directory)

    and make any necessary changes for the mail transport interface
    you are using.
 
    and make any necessary changes for the mail transport interface
    you are using.
 


@@ -46,50 +77,29 @@ need an ANSI C compiler such as gcc.
    injecting the message to a mail transfer agent (such as sendmail)
    on the local machine via SMTP.
 
    injecting the message to a mail transfer agent (such as sendmail)
    on the local machine via SMTP.
 

-   If you have enabled POP support and you want this to be the
-   default method of accessing new mail, you will need to change
-   the values of the variables "servers", "pophost", "localname",
-   and possibly "mmailid".
-
-   a) "servers" defines the server to which you send outgoing SMTP
-      traffic.
-
-   b) "pophost" defines the server that runs the POP daemon, and to
-      which `inc' and `msgchk' will query for new mail.
-
-   c) "localname" defines the hostname that nmh considers local.
-      If not set, then nmh queries your OS for this value.  You may
-      want to change this if you wish your e-mail to appear as if it
-      originated on the POP server.
+   If, instead, all your mail sending and receiving occurs on a
+   remote POP/SMTP server, you will need to look at the values of the
+   variables "localname", "pophost", and "servers":

 
 

-   d) "mmailid" is checked to see if nmh should do username
-      masquerading.  If the value of this field is non-zero, then
-      nmh will check if the pw_gecos field in the password file
-      has the form
+    a) "localname" defines the hostname that nmh considers local.
+       If not set, then nmh queries your OS for this value.  You will
+       want to change this if you wish your e-mail to appear as if it
+       originated on the POP server.

 
 

-          Full Name <fakeusername>
+    b) "pophost" defines the server that runs the POP daemon, and to
+       which `inc' and `msgchk' will always query for new mail.

 
 

-      If the pw_gecos field has this form, then the internal nmh
-      routines that find the username and full name of a user will
-      return "fakeusername" and "Full Name" respectively.  This is
-      useful if you wish messages that you send to appear to come
-      from the username of your POP account, rather than your username
-      on the local machine.
+    c) "servers" defines the server to which you send outgoing SMTP
+       traffic.  See the discussion of the --with-smtpserver configure
+       option below.

 
 

-   If you compile with POP support, but only want to use it occasionally,
-   then you can always use the `-host' and `-user' options to `inc'
-   and `msgchk' instead of changing `mts.conf'.
+   If you don't want to hardcode pophost in `mts.conf', you can use
+   the `-host' and `-user' options to `inc' and `msgchk'.

 
 

-   Check the `mh-tailor' man page for a list of all the available
-   options for this file.
+   Check the `mh-tailor' man page for a list of all the available options
+   for this file.

 
 

-7) If you have enabled POP support, make sure that `pop3' (or more
-   precisely the value of the define POPSERVICE in config.h) is defined
-   in the /etc/services file (or its NIS/NIS+ equivalent) on the client
-   machine.  It should be something equivalent to "110/tcp".  This might
-   have already been done when the pop daemon was installed.
-
-8) Edit the file `mhn.defaults' (installed in the nmh `etc' directory).
+6) Edit the file `mhn.defaults' (installed in the nmh `etc' directory).

    This file contains the default profile entries for the nmh command
    `mhn' and is created by the script `mhn.defaults.sh'.  This script
    will search a generic path (essentially your $PATH) for programs to
    This file contains the default profile entries for the nmh command
    `mhn' and is created by the script `mhn.defaults.sh'.  This script
    will search a generic path (essentially your $PATH) for programs to


@@ -98,8 +108,8 @@ need an ANSI C compiler such as gcc.
    want to re-run this script later if you install new programs to
    display content.  An example of this is:
 
    want to re-run this script later if you install new programs to
    display content.  An example of this is:
 

-   cd support/general
-   ./mhn.defaults.sh /usr/local/bin:/usr/X11/bin:/usr/ucb > mhn.defaults
+    % cd support/general
+    % ./mhn.defaults.sh /usr/local/bin:/usr/X11/bin:/usr/ucb > mhn.defaults

 
    and then move `mhn.defaults' into the nmh `etc' directory.
 
 
    and then move `mhn.defaults' into the nmh `etc' directory.
 


@@ -107,9 +117,10 @@ need an ANSI C compiler such as gcc.
    If you have specialized programs to handle various types, you will need
    to edit the `mhn.defaults' file manually.  The syntax of this file is
    described in the man page for `mhn', and in section 9.4 of the book
    If you have specialized programs to handle various types, you will need
    to edit the `mhn.defaults' file manually.  The syntax of this file is
    described in the man page for `mhn', and in section 9.4 of the book

-   "MH & xmh: Email for Users and Programmers", 3rd edition, by Jerry Peek.
+   "MH & xmh: Email for Users and Programmers", 3rd edition, by Jerry Peek,
+   on the Internet at <http://rand-mh.sourceforge.net/book/mh/confmhn.html>.

 
 

-9) Add an optional global mh.profile, if desired.  This profile should be
+7) Add an optional global mh.profile, if desired.  This profile should be

    placed in the nmh `etc' directory with the name `mh.profile'.  This
    file will be used to construct the initial .mh_profile of a new nmh
    user, but will not be consulted after that.
    placed in the nmh `etc' directory with the name `mh.profile'.  This
    file will be used to construct the initial .mh_profile of a new nmh
    user, but will not be consulted after that.


@@ -117,18 +128,25 @@ need an ANSI C compiler such as gcc.
 -----------------------------------------------
 Compiler options, or using a different compiler
 -----------------------------------------------
 -----------------------------------------------
 Compiler options, or using a different compiler
 -----------------------------------------------

-By default, configure will use the "gcc" compiler if found.  You can use a
-different compiler, or add unusual options for compiling or linking that
-the "configure" script does not know about, by either editing the user
-configuration section of the top level Makefile (after running configure)
-or giving "configure" initial values for these variables by setting them
-in the environment.  Using a Bourne-compatible shell (such as sh,ksh,zsh),
- 
-you can do that on the command line like this:
-    CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure
- 
-Or on systems that have the "env" program, you can do it like this:
-    env CPPFLAGS=-I/usr/local/include LDFLAGS=-s ./configure
+
+By default, configure will use the "gcc" compiler if found.  You can
+use a different compiler, or add unusual options for compiling or
+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 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:
+
+   ./configure CPPFLAGS='-Wextra -Wno-sign-compare'
+
+If you want to add to both compile and link flags at build time
+without putting them in the configuration, you can use the AM_CFLAGS
+Makefile macro:
+
+    make AM_CFLAGS=--coverage

 
 ----------------------------------------
 Building nmh on additional architectures
 
 ----------------------------------------
 Building nmh on additional architectures


@@ -138,7 +156,7 @@ This should restore the nmh source distribution back to its original
 state.  You can then configure nmh as above on other architectures in
 which you wish to build nmh.  Or alternatively, you can use a different
 build directory for each architecture.
 state.  You can then configure nmh as above on other architectures in
 which you wish to build nmh.  Or alternatively, you can use a different
 build directory for each architecture.

- 
+

 ---------------------------------
 Using a different build directory
 ---------------------------------
 ---------------------------------
 Using a different build directory
 ---------------------------------


@@ -149,9 +167,9 @@ architecture at the same time.  To do this, you must use a version of
 the directory where you want the object files and executables to go and
 run the "configure" script.  "configure" automatically checks for the
 source code in the directory that "configure" is in.  For example,
 the directory where you want the object files and executables to go and
 run the "configure" script.  "configure" automatically checks for the
 source code in the directory that "configure" is in.  For example,

- 
+

     cd /usr/local/solaris/nmh
     cd /usr/local/solaris/nmh

-    /usr/local/src/nmh-1.0/configure
+    /usr/local/src/nmh-1.5/configure

     make
 
 ---------------------
     make
 
 ---------------------


@@ -165,34 +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.
 

---with-mts=MTS   (DEFAULT is smtp)
-     specify the mail transport system you want to use.  The two
-     acceptable options are "smtp" (which is the default), and
-     "sendmail".
-
-     If you use "smtp", this will enable a direct SMTP (simple
-     mail transport protocol) interface in nmh.  When sending
-     mail, instead of passing the message to the mail transport
-     agent, `post' will open a socket connection to the mail
-     port on the machine specified in the `mts.conf' file
-     (default is localhost), and speak SMTP directly.
-
-     If you use "sendmail", then `post' will send messages by
-     passing forking a 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'.
-

 --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


@@ -201,29 +202,88 @@ 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-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.
-
---enable-nmh-mhe    (DEFAULT)
-     Add support for the Emacs front-end `mhe'.
-
---enable-nmh-pop
-    Enable client-side support for pop.
+--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
+     requires no special kernel or filesystem support, and simply
+     creates a file called "FILE.lock" to indicate that "FILE" is
+     locked.
+
+     In order to be effective, you should contact the site
+     administrator to find out what locking mechanisms other
+     mail delivery and user programs respect. The most common
+     reason not to use dot-locking is if the mail spool directory
+     is not world- or user-writeable, and thus a lock file cannot
+     be created.
+
+--enable-lockdir=DIR   (DEFAULT is disabled)
+     If dot locking is being used, store all dot-lock files in "DIR".
+     The default is to store them in the directory of the file being
+     locked.

 
 

---with-krb4=PREFIX
-    Specify the location of Kerberos V4 for KPOP support.  You will
-    also need to specify the option `--enable-nmh-pop'.  After running
-    configure, you will probably need to change the POPSERVICE define
-    in config.h.  See the comments inside config.h for details.
-
---with-hesiod=PREFIX
-    Specify the location of Hesiod.
-
---enable-nmh-debug
-    Enable debugging support.
+--with-mts=MTS   (DEFAULT is smtp)
+     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
+     of passing the message to the mail transport agent, `post' will
+     open a socket connection to the mail port on the machine specified
+     in the `mts.conf' file (default is localhost), and speak SMTP
+     directly.
+
+     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.
+
+     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)
+     Specify the header file (eg ndbm.h) and library (eg ndbm) to use
+     to compile against the ndbm database library. By default, configure
+     will try various possibilities until it finds one that works; this
+     option only needs to be specified if the autodetection fails or
+     makes the wrong choice.
+
+     If either of these options is given then the other must also be
+     specified.
+
+--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,
+     however, so that each time nmh is reinstalled, the right value will be
+     there.
+
+     See the mh-tailor(5) man page for full documentation of "servers:".
+
+--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).
+
+--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
+     the WhatNow? prompt.

 
 --
 
 --

-Richard Coleman
-coleman@math.gatech.edu
+The nmh team
+nmh-workers@nongnu.org