X-Git-Url: https://diplodocus.org/git/nmh/blobdiff_plain/484a9acf0e463a588cc050229aabf1cb453b89c4..3bebe0e894828d80183926d4fc19fc01cd3c274e:/INSTALL diff --git a/INSTALL b/INSTALL index a2e2d618..251ba7b0 100644 --- a/INSTALL +++ b/INSTALL @@ -2,9 +2,18 @@ # 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. @@ -50,7 +59,12 @@ need an ANSI C compiler such as gcc. 3) make -4) make install +4) make check + + This takes a bit of time, around one minute on a modern machine, + but is highly recommended. + +5) 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 @@ -61,7 +75,7 @@ need an ANSI C compiler such as gcc. 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) +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. @@ -86,16 +100,13 @@ need an ANSI C compiler such as gcc. 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. -6) Edit the file `mhn.defaults' (installed in the nmh `etc' directory). +7) 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 @@ -116,13 +127,6 @@ need an ANSI C compiler such as gcc. "MH & xmh: Email for Users and Programmers", 3rd edition, by Jerry Peek, on the Internet at . -7) make check - - This takes a bit of time, around one minute on a modern machine, - but is highly recommended. If you're going to run it, it must be - run after installation. If you want to run the nmh test suite - prior to installation, use "make distcheck". - 8) 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 @@ -198,25 +202,6 @@ Options for configure --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 @@ -225,16 +210,6 @@ Options for configure 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",