From 0af41ea47efc982377e2a9afb503c2b0bce2e853 Mon Sep 17 00:00:00 2001 From: David Levine Date: Wed, 8 Feb 2012 22:29:59 -0600 Subject: [PATCH] Updated INSTALL and MACHINES documentation a bit. --- INSTALL | 48 +++++++++++++++++++++++++++----------------- MACHINES | 14 +++++++++---- docs/pending-release-notes | 1 + 3 files changed, 41 insertions(+), 22 deletions(-) diff --git a/INSTALL b/INSTALL index feea184..b1dca8c 100644 --- a/INSTALL +++ b/INSTALL @@ -12,11 +12,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 +34,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 @@ -44,11 +44,20 @@ need an ANSI C compiler such as gcc. 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. + want to customize some #defines for your environment, though + that is usually unnecessary. Note the configure options below + control some of the #defines. 3) make -4) make install +4) make test + + 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. + +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 @@ -59,7 +68,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. @@ -81,16 +90,19 @@ 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'. 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 ("masquerade" may be of particular interest, though its + default value allows the most flexibility. See the discussion of the + --enable-masquerade configure option below). -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 @@ -111,7 +123,7 @@ 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) Add an optional global mh.profile, if desired. This profile should be +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 user, but will not be consulted after that. @@ -196,18 +208,18 @@ Options for configure 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. 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. + 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. diff --git a/MACHINES b/MACHINES index 60741ef..686e740 100644 --- a/MACHINES +++ b/MACHINES @@ -6,11 +6,11 @@ nmh is known to compile on the following platforms (save the exceptions noted below), using an ANSI C compiler, such as gcc. AIX 4.1.5.0.01 -Cygwin, setup version 2.763 +Cygwin, setup version 2.763 (though it does not run correctly, see below) FreeBSD IRIX 6.5 -Linux 2.2, 2.3, 2.4 (glibc 2.1, glibc 2.2) -Mac OS X Public Beta +Linux 2.2 to current (glibc 2.1 to current) +Mac OS X NetBSD 1.4.2 OpenBSD Solaris 7 and 8 (sparc,x86) @@ -45,6 +45,10 @@ Cygwin: Be sure to install Cygwin package libncurses-devel, in the Devel or Libs category. And libncurses10 or later in the Lib category. +Which nmh builds on Cygwin, not all of its programs operate. If +you're willing to help fix them, please contact the nmh maintainters +at nmh-workers@nongnu.org. + -------------------------------------- HPUX: @@ -101,4 +105,6 @@ it isn't ANSI C. But nmh builds just fine with gcc. With --enable-debug you will see a lot of warnings. -------------------------------------- - +-- +The nmh team +nmh-workers@nongnu.org diff --git a/docs/pending-release-notes b/docs/pending-release-notes index c48e5df..601d0b9 100644 --- a/docs/pending-release-notes +++ b/docs/pending-release-notes @@ -21,3 +21,4 @@ Things to add to the release notes for the next full release: program inside of repl (the idea is that it will be used by repl). See mhl(1), specifically the "format" keyword and "formatproc" in mh-profile(5). +- The test suite has been integrated into the Makefile via "make test". -- 1.7.10.4