#
# 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]
4) make install
- 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. The only directory that isn't true for is the `etc' directory
- -- in that directory, the previous copy of each <file> will be backed up as
- <file>.prev if it differs from the newly-installed copy. Watch for any diff
- output while make is processing that directory to see if you need to merge
+ 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. The only directory that isn't
+ true for is the `etc' directory -- in that directory, the previous
+ copy of each <file> will be backed up as <file>.prev if it differs
+ from the newly-installed copy. Watch for any diff output while
+ make is processing that directory to see if you need to merge
changes from *.prev files into the new versions.
5) Edit the file `mts.conf' (installed in the nmh `etc' directory)
Enable debugging support.
--enable-masquerade[='draft_from mmailid username_extension']
- If this option is not specified, 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.
+ 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. By default, it is enabled.
- The above usage shows all three masquerade options being specified, but any
- subset of the three may be specified. If you do want to enable all three,
- you can simply use `configure --enable-masquerade' as a shortcut.
+ The above usage shows the default, with all three masquerade
+ options being specified. Any subset of the three may be
+ specified.
See the mh-tailor(5) man page for full documentation of "masquerade:".
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",
+ "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.
+
--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
If you wish to use a transport agent other than sendmail, you will
need to use a `sendmail wrapper'.
+--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-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
--
The nmh team
-nmh-workers@mhost.com
+nmh-workers@nongnu.org