#
# INSTALL -- installation instructions
#
-# $Id$
-#
--------------
-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
+build instructions for your operating system. To build mmh, you will
need an ANSI C compiler such as gcc.
-1) Run the command
-
- sh configure [options]
-
- This will check the configuration of your OS, and create
- the include file config.h, as well as the various Makefiles.
-
- The configure script accepts various options. The options of
- most interest are listed below. To see the list of all available
- options, you can run
-
- sh configure --help
-
-2) (IMPORTANT) Edit the user configuration section at the beginning
- of the generated include file `config.h'. Currently, not everything
- is auto-configured, so some #defines must be set manually.
-
-3) Edit the user configuration section at the top of the main Makefile.
+0) If you have obtained mmh by checking it out of git, 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
-4) make
+ ./autogen.sh
-5) make install
+ (Note that if you're doing mmh development, you should look at
+ docs/README.developers, since there is other developer-friendly
+ advice there as well.)
-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.
+1) From the top-level source directory, run the command
- 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.
+ ./configure [options]
- If you have enabled POP support and you want this to be the
- default method of accessing new mail, you will need to change
- the values of the variables "servers", "pophost", "localname",
- and possibly "mmailid".
+ This will check the configuration of your OS, and create the
+ include file config.h, as well as the various Makefiles.
- a) "servers" defines the server to which you send outgoing SMTP
- traffic.
+ 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
- b) "pophost" defines the server that runs the POP daemon, and to
- which `inc' and `msgchk' will query for new mail.
+ ./configure --help
- c) "localname" defines the hostname that nmh considers local.
- If not set, then nmh queries your OS for this value. You may
- want to change this if you wish your e-mail to appear as if it
- originated on the POP server.
+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.
- d) "mmailid" is checked to see if nmh should do username
- masquerading. If the value of this field is non-zero, then
- nmh will check if the pw_gecos field in the password file
- has the form
+3) make
- Full Name <fakeusername>
+4) make install
- If the pw_gecos field has this form, then the internal nmh
- routines that find the username and full name of a user will
- return "fakeusername" and "Full Name" respectively. This is
- useful if you wish messages that you send to appear to come
- from the username of your POP account, rather than your username
- on the local machine.
+ 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 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.
- If you compile with POP support, but only want to use it occasionally,
- then you can always use the `-host' and `-user' options to `inc'
- and `msgchk' instead of changing `mts.conf'.
+5) Edit the file `mhn.defaults' (installed in the mmh `etc' directory).
+ This file contains the default profile entries for the mmh commands
+ mhlist/mhstore/mhshow 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:
- Check the `mh-tailor' man page for a list of all the available
- options for this file.
+ % cd support/general
+ % ./mhn.defaults.sh /usr/local/bin:/usr/X11/bin:/usr/ucb > mhn.defaults
-7) If you have enabled POP support, make sure that `pop3' (or more
- precisely the value of the define POPSERVICE in config.h) is defined
- in the /etc/services file (or its NIS/NIS+ equivalent) on the client
- machine. It should be something equivalent to "110/tcp". This might
- have already been done when the pop daemon was installed.
-
-8) 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.
+ and then move `mhn.defaults' into the mmh `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.
-
-9) 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.
+ 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://www.ics.uci.edu/~mh/book/mh/confmhn.htm>.
-----------------------------------------------
Compiler options, or using a different compiler
env CPPFLAGS=-I/usr/local/include LDFLAGS=-s ./configure
----------------------------------------
-Building nmh on additional architectures
+Building mmh 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
+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.
---------------------------------
Using a different build directory
---------------------------------
-You can compile the nmh in a different directory from the one containing
+You can compile the 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". "cd" to
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
+ cd /usr/local/solaris/mmh
+ /usr/local/src/mmh-1.0/configure
make
---------------------
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.
--libdir=DIR (DEFAULT is ${prefix}/lib)
- nmh's support binaries (post, slocal, mhl, ...) are installed here.
+ mmh's support binaries (spost, slocal, mhl, ...) are installed here.
--sysconfdir=DIR (DEFAULT is ${prefix}/etc)
- nmh's config files (mts.conf, mhn.defaults, ...) are installed here.
+ mmh's config files (mhn.defaults, ...) are installed here.
--mandir=DIR (DEFAULT is ${prefix}/man)
- nmh's man pages are installed here.
-
---with-mts=MTS (DEFAULT is smtp)
- specify the mail transport system you want to use. The two
- acceptable options are "smtp" (which is the default), and
- "sendmail".
-
- 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
- passing 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-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-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.
-
---enable-nmh-mhe (DEFAULT)
- Add support for the Emacs front-end `mhe'.
+ mmh's man pages are installed here.
+
+--enable-debug
+ Enable debugging support.
---enable-nmh-pop
- Enable client-side support for pop.
+--enable-mhe (DEFAULT)
+ Add support for the Emacs front-end `mhe'.
---with-krb4=PREFIX
- Specify the location of Kerberos V4 for KPOP support. You will
- also need to specify the option `--enable-nmh-pop'. After running
- configure, you will probably need to change the POPSERVICE define
- in config.h. 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.
---with-hesiod=PREFIX
- Specify the location of Hesiod.
+ 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.
---enable-nmh-debug
- Enable debugging support.
--
-Richard Coleman
-coleman@math.gatech.edu
+markus schnalke <meillo@marmaro.de>
+and the nmh team <nmh-workers@nongnu.org>
projects / mmh / blobdiff