2 # INSTALL -- installation instructions
8 Please read all of the following instructions before you begin
11 You should check the MACHINES file to see if there are any specific
12 build instructions for your operating system. To build mmh, you will
13 need an ANSI C compiler such as gcc.
15 0) If you have obtained mmh by checking it out of git, you will
16 need to run the GNU autotools to regenerate some files.
17 (If your directory already contains a file 'config.h.in'
18 then this has already been done and you do not need to do it.)
19 You can regenerate the files by running the command
23 (Note that if you're doing mmh development, you should look at
24 docs/README.developers, since there is other developer-friendly
25 advice there as well.)
27 1) From the top-level source directory, run the command:
31 This will check the configuration of your OS, as well as the various
34 The configure script accepts various options. The options of
35 most interest are listed in a section below. To see the list
36 of all available options, you can run:
44 Note that if you have mmh files in your install directories with
45 the same names as the files being installed, the old ones will get
46 overwritten without any warning. The only directory this isn't
47 true for, is the `etc' directory -- in that directory, the distributed
48 files are installed with a `.dist' suffix if they differ from the
49 existing file. Watch for information messages while make is processing
50 that directory to see if you need to merge changes.
52 4) Edit the file `mhn.defaults' (installed in the mmh `etc' directory).
54 This file contains the default profile entries for the mmh commands
55 mhlist/mhstore/mhshow. The syntax of this file is described in section
56 9.4 of the book "MH & xmh: Email for Users and Programmers", 3rd edition,
57 by Jerry Peek, on the Internet at
58 <http://www.ics.uci.edu/~mh/book/mh/confmhn.htm>.
60 5) Add the bindir to your PATH variable.
62 If you haven't change any paths, then the bindir is `/usr/local/mmh/bin'.
63 Likely, your PATH is set in ~/.profile, ~/.kshrc, ~/.bashrc, or a similar
67 -----------------------------------------------
68 Compiler options, or using a different compiler
69 -----------------------------------------------
70 By default, configure will use the "gcc" compiler if found. You can use a
71 different compiler, or add unusual options for compiling or linking that
72 the "configure" script does not know about, by either editing the user
73 configuration section of the top level Makefile (after running configure)
74 or giving "configure" initial values for these variables by setting them
75 in the environment. Using a Bourne-compatible shell (such as sh,ksh,zsh),
77 you can do that on the command line like this:
78 CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure
80 Or on systems that have the "env" program, you can do it like this:
81 env CPPFLAGS=-I/usr/local/include LDFLAGS=-s ./configure
83 If you want to add to, not replace, compile flags, you can use
84 OURDEFS with env or like this:
85 OURDEFS='-Wextra -Wno-sign-compare' ./configure
87 ----------------------------------------
88 Building mmh on additional architectures
89 ----------------------------------------
90 To build mmh on additional architectures, you can do a "make distclean".
91 This should restore the mmh source distribution back to its original
92 state. You can then configure mmh as above on other architectures in
93 which you wish to build mmh. Or alternatively, you can use a different
94 build directory for each architecture.
96 ---------------------------------
97 Using a different build directory
98 ---------------------------------
99 You can compile the mmh in a different directory from the one containing
100 the source code. Doing so allows you to compile it on more than one
101 architecture at the same time. To do this, you must use a version of
102 "make" that supports the "VPATH" variable, such as GNU "make". "cd" to
103 the directory where you want the object files and executables to go and
104 run the "configure" script. "configure" automatically checks for the
105 source code in the directory that "configure" is in. For example,
107 cd /usr/local/solaris/mmh
108 /usr/local/src/mmh-1.0/configure
111 ---------------------
112 Options for configure
113 ---------------------
114 --prefix=DIR (DEFAULT is /usr/local/mmh)
115 This will change the base prefix for the installation location
116 for the various parts of mmh. Unless overridden, mmh is installed
117 in ${prefix}/bin, ${prefix}/etc, ${prefix}/lib, ${prefix}/man.
119 --bindir=DIR (DEFAULT is ${prefix}/bin)
120 mmh's binaries (show, inc, comp, ...) are installed here.
121 You need to have this directory in your PATH variable.
123 --libdir=DIR (DEFAULT is ${prefix}/lib)
124 mmh's test tools (ap, dp, mhtest, ...) are installed here.
125 They are seldom useful to normal users.
127 --sysconfdir=DIR (DEFAULT is ${prefix}/etc)
128 mmh's config files (mhn.defaults, ...) are installed here.
130 --mandir=DIR (DEFAULT is ${prefix}/man)
131 mmh's man pages are installed here.
134 Enable debugging support.
136 --enable-mhe (DEFAULT)
137 Add support for the Emacs front-end `mhe'.
139 --with-locking=LOCKTYPE (DEFAULT is dot)
140 Specify the locking mechanism when attempting to "inc" or
141 "msgchk" a local mail spool. Valid options are "dot",
142 "fcntl", "flock", and "lockf". Of the four, dot-locking
143 requires no special kernel or filesystem support, and simply
144 creates a file called "FILE.lock" to indicate that "FILE" is
147 In order to be effective, you should contact the site
148 administrator to find out what locking mechanisms other
149 mail delivery and user programs respect. The most common
150 reason not to use dot-locking is if the mail spool directory
151 is not world- or user-writeable, and thus a lock file cannot
156 markus schnalke <meillo@marmaro.de>
157 and the nmh team <nmh-workers@nongnu.org>
projects / mmh / blob