# INSTALL -- installation instructions
#
---------------
-Installing nmh
---------------
+--------------------------------
+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.
+
+
+------------------------
+Installing nmh, manually
+------------------------
Please read all of the following instructions before you begin
building nmh.
3) make
-4) make test
+4) make check
- This takes a bit of time (under 2 minutes on a modern machine) but
- is highly recommended. "make test" copies your configuration and
- rebuilds nmh completely in a sandbox, so you can test without
- disturbing an existing nmh installation or any of your nmh folders.
+ This takes a bit of time, around one minute on a modern machine,
+ but is highly recommended.
5) make install
traffic. See the discussion of the --with-smtpserver configure
option below.
- 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'.
+ 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 ("masquerade" may be of particular interest, though its
- default value allows the most flexibility. See the discussion of the
- --enable-masquerade configure option below).
+ for this file.
7) Edit the file `mhn.defaults' (installed in the nmh `etc' directory).
This file contains the default profile entries for the nmh command
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 an otherwise
-unused Makefile macro, like this:
- make AM_CFLAGS=--coverage
-
-That does not include that setting in the configuration, so you will
-have to repeat it if you re-run "make". One example would be if you
-build the test suite as a separate step:
- make test AM_CFLAGS=--coverage
+without putting them in the configuration, you can use the AM_CFLAGS
+Makefile macro:
-Note that the Makefile test target depends on the default target, so
-both be can built in one step with "make test".
+ make AM_CFLAGS=--coverage
----------------------------------------
Building nmh on additional architectures
--enable-debug
Enable debugging support.
---enable-masquerade[='draft_from mmailid username_extension']
- By default, all three masquerade options are enabled.
-
- If this option is disabled, the mts.conf file will contain the
- line "masquerade: " (with no value), 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 "masquerade:".
-
- This option will likely be removed in a future version of nmh.
-
---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",