X-Git-Url: https://diplodocus.org/git/nmh/blobdiff_plain/dbc14a2e9087e21b58f062055a7a797d8aae3198..fc5bc39368b0c7e05bb5c62a84c44e3bdcbbb1c2:/INSTALL?ds=inline diff --git a/INSTALL b/INSTALL index 4a4b868d..724a255d 100644 --- a/INSTALL +++ b/INSTALL @@ -1,10 +1,17 @@ -# # INSTALL -- installation instructions # --------------- -Installing nmh --------------- +-------------------------------- +Installing nmh, guided by script +-------------------------------- +For routine installation on popular platforms, the build_nmh shell +script 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. @@ -12,11 +19,11 @@ You should check the MACHINES file to see if there are any specific 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 +0) If you have obtained nmh by checking it out of the git repository, + 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 @@ -34,7 +41,7 @@ need an ANSI C compiler such as gcc. ./configure [options] This will check the configuration of your OS, and create the - include file config.h, as well as the various Makefiles. + include file config.h, as well as the Makefile. The configure script accepts various options. The options of most interest are listed in a section below. To see the list @@ -42,22 +49,23 @@ need an ANSI C compiler such as gcc. ./configure --help -2) Look through the user configuration section at the beginning - of the generated include file `config.h'. You may - want to customize some #defines for your environment. +2) make -3) make +3) (Optional) make check + + This takes a bit of time, around one minute on a modern machine, + but is highly recommended. + + test/inc/test-deb359167 uses valgrind, which detects use of an + uninitialized variable on older Linux distributions such as + Mandriva 2007.0 and CentOS 5.4. That particular failure is + beyond the scope of nmh and can be ignored. 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 will be backed up as .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. + overwritten without any warning. 5) Edit the file `mts.conf' (installed in the nmh `etc' directory) and make any necessary changes for the mail transport interface @@ -81,14 +89,14 @@ need an ANSI C compiler such as gcc. which `inc' and `msgchk' will always query for new mail. c) "servers" defines the server to which you send outgoing SMTP - traffic. + 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). + for this file. 6) Edit the file `mhn.defaults' (installed in the nmh `etc' directory). This file contains the default profile entries for the nmh command @@ -109,7 +117,7 @@ need an ANSI C compiler such as gcc. 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, - on the Internet at . + on the Internet at . 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 @@ -119,22 +127,25 @@ need an ANSI C compiler such as gcc. ----------------------------------------------- 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 +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 giving +"configure" initial values for these on its command line or in its +environment. For example, + + ./configure CC=c99 CFLAGS=-O2 LIBS=-lposix -Or on systems that have the "env" program, you can do it like this: - env CPPFLAGS=-I/usr/local/include LDFLAGS=-s ./configure +If you wish to add options that are only used at compile time instead of +link time, you can use the CPPFLAGS variable: -If you want to add to, not replace, compile flags, you can use -OURDEFS with env or like this: - OURDEFS='-Wextra -Wno-sign-compare' ./configure + ./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 the AM_CFLAGS +Makefile macro: + + make AM_CFLAGS=--coverage ---------------------------------------- Building nmh on additional architectures @@ -157,7 +168,7 @@ 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 + /usr/local/src/nmh-1.5/configure make --------------------- @@ -171,37 +182,17 @@ Options for configure --bindir=DIR (DEFAULT is ${prefix}/bin) nmh's binaries (show, inc, comp, ...) are installed here. ---libdir=DIR (DEFAULT is ${prefix}/lib) - nmh's support binaries (post, slocal, mhl, ...) are installed here. +--libexecdir=DIR (DEFAULT is ${prefix}/libexec) + nmh's support binaries (post, slocal, mhl, ...) are installed + in ${libexecdir}/nmh. --sysconfdir=DIR (DEFAULT is ${prefix}/etc) - nmh's config files (mts.conf, mhn.defaults, ...) are installed here. + nmh's config files (mts.conf, mhn.defaults, ...) are installed + in ${sysconfdir}/nmh. --mandir=DIR (DEFAULT is ${prefix}/man) nmh's man pages are installed here. ---enable-debug - Enable debugging support. - ---enable-masquerade[='draft_from mmailid username_extension'] - 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 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:". - ---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 @@ -210,17 +201,7 @@ 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) +--with-locking=LOCKTYPE (DEFAULT is based on operating system) 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 @@ -235,13 +216,18 @@ Options for configure is not world- or user-writeable, and thus a lock file cannot be created. +--enable-lockdir=DIR (DEFAULT is disabled) + If dot locking is being used, store all dot-lock files in "DIR". + The default is to store them in the directory of the file being + locked. + --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 - "sendmail". This value will be put into the mts.conf file. 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. + Specify the default mail transport system you want to use. The three + acceptable options are "smtp" (which is the default), + "sendmail/smtp", and "sendmail/pipe". This value will be put into + the mts.conf file. 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 you use "smtp", this will enable a direct SMTP (simple mail transport protocol) interface in nmh. When sending mail, instead @@ -250,12 +236,14 @@ Options for configure in the `mts.conf' file (default is localhost), and speak SMTP directly. - If you use "sendmail", then `post' will send messages by forking a + If you use "sendmail/smtp", then `post' will send messages by forking a local copy of sendmail. Currently it will still speak SMTP with this local copy of sendmail. - If you wish to use a transport agent other than sendmail, you will - need to use a `sendmail wrapper'. + If you use "sendmail/pipe", then `post' will open a pipe to the + sendmail program and invoke it with the '-t' and '-i' options + and write the message to sendmail's standard input. Note that + some nmh functionality is not available in this mode. --with-ndbm=LIB (DEFAULT is to autodetect) --with-ndbmheader=HEADER (DEFAULT is to autodetect) @@ -268,19 +256,32 @@ Options for configure 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 - command `more' and use it as the default. - ---with-smtpservers='SMTPSERVER1[ SMTPSERVER2...]' (DEFAULT is localhost) +--with-smtpserver='SMTPSERVER' (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:". + See mh-tailor(5) for full documentation of "servers:". + +--with-cyrus-sasl (DEFAULT is to autodetect)) + Enable SASL support for SMTP and POP via the Cyrus SASL library. + This is used for the POP AUTH and SMTP AUTH protocols. This supports + a wide variety of security mechanisms, including Kerberos/GSSAPI. + Session encryption via SASL is supported for both POP and SMTP + (depending on server-side support and the security mechanism in use). + +--with-tls (DEFAULT is to autodetect) + Enable TLS session encryption support for SMTP via the STARTTLS command + and TLS at connection start for both SMTP and POP. + +--with-oauth (DEFAULT is to enable if curl is installed) + Enable OAuth2 authentication for SMTP and POP. + +--with-readline (DEFAULT is to autodetect) + Enable support for readline functionality (command history/editing) at + the WhatNow? prompt. -- The nmh team