#
# INSTALL -- installation instructions
#
-# $Id$
-#
--------------
Installing nmh
build instructions for your operating system. To build nmh, you will
need an ANSI C compiler such as gcc.
+0) If you have obtained nmh by checking it out of CVS, 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
+
+ (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.)
+
1) From the top-level source directory, run the command
./configure [options]
on the local machine via SMTP.
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":
+ remote SMTP server, you will need to look at the values of the
+ variables "localname" and "servers":
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.
+ If not set, then nmh queries your OS for this value.
- b) "pophost" defines the server that runs the POP daemon, and to
- which `inc' and `msgchk' will always query for new mail.
-
- c) "servers" defines the server to which you send outgoing SMTP
+ b) "servers" defines the server to which you send outgoing SMTP
traffic.
- If you compile with POP support, but don't want to use it exclusively,
- you can use the `-host' and `-user' options to `inc' and `msgchk'
- rather than hardcoding pophost in `mts.conf'.
-
Check the `mh-tailor' man page for a list of all the available options
for this file ("masquerade" may be of particular interest).
-6) 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.
-
-7) 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
"MH & xmh: Email for Users and Programmers", 3rd edition, by Jerry Peek,
on the Internet at <http://www.ics.uci.edu/~mh/book/mh/confmhn.htm>.
-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.
--enable-mhe (DEFAULT)
Add support for the Emacs front-end `mhe'.
---enable-pop
- Enable client-side support for pop.
-
---enable-apop
- Enable client-side support for apop (Authenticated POP).
-
--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
nmh command `prompter'. If you specify `prompter', then you don't
need to give the full pathname.
---with-hesiod=PREFIX
- Specify the location of Hesiod.
-
---with-krb4=PREFIX
- Specify the location of Kerberos V4 for KPOP support. After
- running configure, you will need to change the POPSERVICE #define in
- config.h if you want to use KPOP exclusively (rather than being able
- to switch between KPOP and normal POP3). See the comments inside
- config.h for details.
-
--with-locking=LOCKTYPE (DEFAULT is dot)
Specify the locking mechanism when attempting to "inc" or
"msgchk" a local mail spool. Valid options are "dot",
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)
- 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:".
-
--
The nmh team
nmh-workers@nongnu.org