#
# $Id$
#

--------------
Installing nmh
--------------
To build nmh, you will need an ANSI C compiler (such as gcc).

1) Run the command

   ./configure [options]

   This will check the configuration of your OS, and create
   the include file config.h, as well as the various Makefiles.
   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

   ./configure --help

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) Edit the user configuration section at the beginning of the
   top level Makefile.

4) make

5) make install

6) Edit the file `mts.conf' (installed in the nmh `etc' directory)
   and make any necessary changes for the mail transport interface
   you are using.

   Normally the default values should be fine, but if you have enabled
   POP support (and you want this to be the default way of accessing
   new mail), you may need to change the values of the variables
   "servers", "pophost", and "localname".

   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
      nmh 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 e-mail to appear as if it originated on
       the POP server.

   If you are using POP, you will need to define these values in mts.conf
   (normally they will all be the same).

   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' 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).
   This file gives the default profile entries for the nmh command `mhn'
   and is created by the script `mhn.defaults.sh'.  This script searches
   a generic path (essentially your $PATH) for programs to handle various
   content types (for example, xv to display images).  You can re-run
   this script and give it a more tailored path.  You also might want
   to re-run this 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

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

   But the `mhn.defaults.sh' script only searches for a simple set of programs.
   If you have specialize 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.

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

----------------------------------------
Building nmh on additional architectures
----------------------------------------
To build nmh on additional architectures, you can do a "make distclean".
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.
 
---------------------------------
Using a different build directory
---------------------------------
You can compile the nmh in a different directory from the one containing
the source code.  Doing so allows you to compile it on more than one
architecture at the same time.  To do this, you must use a version of
"make" that supports the "VPATH" variable, such as GNU "make".  "cd" to
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
    /usr/local/src/nmh-1.0/configure
    make

---------------------
Options for configure
---------------------
--prefix=PREFIX     (DEFAULT is /usr/local/nmh)
     nmh is installed in ${PREFIX}/{bin,etc,lib,man}.  You can also
     change this in the top section of the main Makefile after running
     configure.

--enable-nmh-smtp   (DEFAULT)
     Enable SMTP (simple mail transport protocol) support.  When
     sending mail, instead of passing the message to the mail
     transport agent (typically sendmail), nmh 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.
     This is enabled by default.

--enable-nmh-mhe    (DEFAULT)
     Add support for the Emacs front-end `mhe'.

--enable-nmh-pop
    Enable client-side support for pop.

--enable-nmh-debug
    Enable debugging support.

--
Richard Coleman
coleman@math.gatech.edu
