#
--------------
-Installing nmh
+Installing mmh
--------------
Please read all of the following instructions before you begin
-building nmh.
+building mmh.
-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.
+Mmh can be built and installed on POSIX-compliant systems, using
+an ANSI C compiler. (Check out docs/MACHINES for shortcomings of
+operating systems.)
-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'
+0) If you have obtained mmh by checking it out of the version control
+ system, 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.)
+ (If you're doing mmh development, you should look at
+ docs/README.developers for related information.)
-1) From the top-level source directory, run the command
+1) From the top-level source directory, run the command:
- ./configure [options]
+ ./configure [options]
- This will check the configuration of your OS, and create the
- include file config.h, as well as the various Makefiles.
+ This will check the configuration of your OS, as well as generate
+ the various Makefiles.
- The configure script accepts various options. The options of
- most interest are listed in a section below. To see the list
- of all available options, you can run
+ The configure script accepts various options. The options of
+ most interest are listed in a section below. To see the list
+ of all available options, you can run:
- ./configure --help
+ ./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
+ For less terminal output, use: make -s
-4) make install
+3) make install
- Note that if you have [n]mh files in your install directories with
+ Note that if you have mmh files in the target 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)
- and make any necessary changes for the mail transport interface
- you are using.
-
- The default `mts.conf' file assumes you retrieve new mail from
- a local (or NFS mounted) maildrop, and send outgoing mail by
- injecting the message to a mail transfer agent (such as sendmail)
- on the local machine via SMTP.
-
- If, instead, all your mail sending and receiving occurs on a
- remote SMTP server, you will need to look at the values of the
- variables "localname" and "servers":
-
- a) "localname" defines the hostname that nmh considers local.
- If not set, then nmh queries your OS for this value.
-
- b) "servers" defines the server to which you send outgoing SMTP
- traffic.
-
- Check the `mh-tailor' man page for a list of all the available options
- for this file ("masquerade" may be of particular interest).
-
-6) 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
- handle various content types (for example, xv to display images).
- You can re-run this script and give it a more tailored path. You may
- want to re-run this script later if you install new programs to
- display content. An example of this is:
-
- % cd support/general
- % ./mhn.defaults.sh /usr/local/bin:/usr/X11/bin:/usr/ucb > mhn.defaults
-
- and then move `mhn.defaults' into the nmh `etc' directory.
-
- The `mhn.defaults.sh' script only searches for a simple set of programs.
- If you have specialized programs to handle various types, you will need
- 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 <http://www.ics.uci.edu/~mh/book/mh/confmhn.htm>.
-
-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
- file will be used to construct the initial .mh_profile of a new nmh
- user, but will not be consulted after that.
+ overwritten without any warning. The only directory this isn't
+ true for, is the `etc' directory -- in that directory, the distributed
+ files are installed with a `.dist' suffix if they differ from the
+ existing file. Watch for information messages while make is processing
+ that directory to see if you need to merge changes.
+
+4) You may edit the file `mhn.defaults' in mmh's `etc' directory.
+
+ This file contains the default profile entries for the mmh commands
+ mhlist/mhstore/show. The syntax of this file is described in section
+ 9.4 of the book "MH & xmh: Email for Users and Programmers", 3rd edition,
+ by Jerry Peek, on the Internet at
+ <http://rand-mh.sourceforge.net/book/mh/confmhn.html>.
+ In most cases you can skip this step.
+
+5) Add the bindir to your PATH variable.
+
+ If you haven't changed any paths, then the bindir is
+ `/usr/local/mmh/bin'. Adjust your PATH in ~/.profile, ~/.kshrc,
+ ~/.bashrc, or a similar file.
+
+ Have a look at mmhwrap(1), which allows you to access mmh tools
+ conveniently without changing the PATH variable.
+
-----------------------------------------------
Compiler options, or using a different compiler
-----------------------------------------------
-By default, configure will use the "gcc" compiler if found. You can use a
+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
-
+or giving "configure" initial values for these in its command line or in
+its environment. For example:
+
+ ./configure CC=c89 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
-----------------------------------------
-Building nmh on additional architectures
-----------------------------------------
-To build nmh on additional architectures, you can do a "make distclean".
-This should restore the nmh source distribution back to its original
-state. You can then configure nmh as above on other architectures in
-which you wish to build nmh. Or alternatively, you can use a different
-build directory for each architecture.
-
+If you want to add to, not replace, compile flags, you can use OURDEFS:
+ ./configure OURDEFS='-Wextra -Wno-sign-compare'
+
---------------------------------
Using a different build directory
---------------------------------
-You can compile the nmh in a different directory from the one containing
-the source code. Doing so allows you to compile it on more than one
-architecture at the same time. To do this, you must use a version of
-"make" that supports the "VPATH" variable, such as GNU "make". "cd" to
-the directory where you want the object files and executables to go and
-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
+You can compile mmh in a different directory from the one containing
+the source code. Doing so allows you to compile it on more than one
+architecture at the same time. To do this, you must use a version of
+"make" that supports the "VPATH" variable, such as GNU "make". Change
+to the directory where you want the object files and executables to go
+and run the "configure" script. "configure" automatically checks for
+the source code in the directory that "configure" is in. For example,
+
+ cd /usr/local/src/mmh # source directory
+ make clean
+ cd /usr/local/solaris/mmh # build directory
+ /usr/local/src/mmh/configure
make
+----------------------------------------
+Building mmh on additional architectures
+----------------------------------------
+To build mmh on additional architectures, you can do a "make distclean".
+This should restore the mmh source distribution back to its original
+state. You can then configure mmh as above on other architectures in
+which you wish to build mmh. Or alternatively, you can use a different
+build directory for each architecture.
+
---------------------
Options for configure
---------------------
---prefix=DIR (DEFAULT is /usr/local/nmh)
+--prefix=DIR (DEFAULT is /usr/local/mmh)
This will change the base prefix for the installation location
- for the various parts of nmh. Unless overridden, nmh is installed
+ for the various parts of mmh. Unless overridden, mmh is installed
in ${prefix}/bin, ${prefix}/etc, ${prefix}/lib, ${prefix}/man.
--bindir=DIR (DEFAULT is ${prefix}/bin)
- nmh's binaries (show, inc, comp, ...) are installed here.
+ mmh's binaries (show, inc, comp, ...) are installed here.
+ You need to have this directory in your PATH variable.
--libdir=DIR (DEFAULT is ${prefix}/lib)
- nmh's support binaries (post, slocal, mhl, ...) are installed here.
+ mmh's test tools (ap, dp, mhtest, ...) are installed here.
+ They are seldom useful to normal users.
--sysconfdir=DIR (DEFAULT is ${prefix}/etc)
- nmh's config files (mts.conf, mhn.defaults, ...) are installed here.
+ mmh's global config files (mhn.defaults, ...) are installed here.
--mandir=DIR (DEFAULT is ${prefix}/man)
- nmh's man pages are installed here.
+ mmh'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.
+ Add debugging symbols to the binaries.
- 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:".
+--with-locking=LOCKTYPE (DEFAULT is dot)
+ Specify the locking mechanism when attempting to "inc"
+ a local mail spool. Valid options are "dot", "fcntl", "flock",
+ and "lockf".
---enable-mhe (DEFAULT)
- Add support for the Emacs front-end `mhe'.
+ 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.
+ If LOCKDIR is specified, lock files will be created in that
+ directory. Otherwise, lock files will be created in the
+ directory where the file being locked resides.
---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
- for the `vi' command and use it as the default. If you wish to
- specify an interface which is compatible with MH, then use the
- nmh command `prompter'. If you specify `prompter', then you don't
- need to give the full pathname.
-
---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.
+ To configure nmh for kernel locking, use one of the `flock',
+ `lockf' or `fcntl' values, each using the equally named
+ system call to perform the kernel-level locking.
In order to be effective, you should contact the site
administrator to find out what locking mechanisms other
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
- "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.
-
- If you use "smtp", this will enable a direct SMTP (simple mail
- transport protocol) interface in nmh. When sending mail, instead
- of passing the message to the mail transport agent, `post' will
- open a socket connection to the mail port on the machine specified
- in the `mts.conf' file (default is localhost), and speak SMTP
- directly.
-
- If you use "sendmail", 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'.
-
---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
- command `more' and use it as the default.
-
---with-smtpservers='SMTPSERVER1[ SMTPSERVER2...]' (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:".
-
---
-The nmh team
-nmh-workers@nongnu.org
+--with-lockdir=DIR
+ If you have defined "dot" locking, then the default is to
+ place the lock files in the same directory as the file that
+ is to be locked. Alternately, if you use this option, you can
+ specify that all lock files go in the specified directory.
+ Don't define this unless you know you need it.
+
+ This option is only relevant if "dot" locking is used.
+ In the other cases, it is ignored.
projects / mmh / blobdiff