Add some more default MIME content suffixes.
[mmh] / INSTALL
1 #
2 # INSTALL -- installation instructions
3 #
4
5 --------------
6 Installing nmh
7 --------------
8 Please read all of the following instructions before you begin
9 building nmh.
10
11 You should check the MACHINES file to see if there are any specific
12 build instructions for your operating system.  To build nmh, you will
13 need an ANSI C compiler such as gcc.
14
15 0) If you have obtained nmh by checking it out of the git repository,
16    you will need to run the GNU autotools to regenerate some files.
17    (If your directory already contains a file 'config.h.in' then this
18    has already been done and you do not need to do it.)  You can
19    regenerate the files by running the command
20
21    ./autogen.sh
22
23    (Note that if you're doing nmh development, you should look at
24    docs/README.developers, since there is other developer-friendly
25    advice there as well.)
26
27    If you have obtained nmh in the form of a tar archive and are
28    trying to unpack it with cpio:  due to an apparent bug in cpio, it
29    might fail with "Malformed number" error messages.  Try another
30    tool to unpack, such as tar or pax.
31
32 1) From the top-level source directory, run the command
33
34    ./configure [options]
35
36    This will check the configuration of your OS, and create the
37    include file config.h, as well as the Makefile.
38
39    The configure script accepts various options.  The options of
40    most interest are listed in a section below.  To see the list
41    of all available options, you can run
42
43    ./configure --help
44
45 2) Look through the user configuration section at the beginning
46    of the generated include file `config.h'. You may
47    want to customize some #defines for your environment, though
48    that is usually unnecessary.  Note the configure options below
49    control some of the #defines.
50
51 3) make
52
53 4) make check
54
55    This takes a bit of time, around one minute on a modern machine,
56    but is highly recommended.
57
58 5) make install
59
60    Note that if you have [n]mh files in your install directories with
61    the same names as the files being installed, the old ones will get
62    overwritten without any warning.  The only directory that isn't
63    true for is the `etc' directory -- in that directory, the previous
64    copy of each <file> will be backed up as <file>.prev if it differs
65    from the newly-installed copy.  Watch for any diff output while
66    make is processing that directory to see if you need to merge
67    changes from *.prev files into the new versions.
68
69 6) Edit the file `mts.conf' (installed in the nmh `etc' directory)
70    and make any necessary changes for the mail transport interface
71    you are using.
72
73    The default `mts.conf' file assumes you retrieve new mail from
74    a local (or NFS mounted) maildrop, and send outgoing mail by
75    injecting the message to a mail transfer agent (such as sendmail)
76    on the local machine via SMTP.
77
78    If, instead, all your mail sending and receiving occurs on a
79    remote POP/SMTP server, you will need to look at the values of the
80    variables "localname", "pophost", and "servers":
81
82     a) "localname" defines the hostname that nmh considers local.
83        If not set, then nmh queries your OS for this value.  You will
84        want to change this if you wish your e-mail to appear as if it
85        originated on the POP server.
86
87     b) "pophost" defines the server that runs the POP daemon, and to
88        which `inc' and `msgchk' will always query for new mail.
89
90     c) "servers" defines the server to which you send outgoing SMTP
91        traffic.  See the discussion of the --with-smtpserver configure
92        option below.
93
94    If you compile with POP support, but don't want to use it exclusively,
95    you can use the `-host' and `-user' options to `inc' and `msgchk'
96    rather than hardcoding pophost in `mts.conf'.
97
98    Check the `mh-tailor' man page for a list of all the available options
99    for this file.
100
101 7) Edit the file `mhn.defaults' (installed in the nmh `etc' directory).
102    This file contains the default profile entries for the nmh command
103    `mhn' and is created by the script `mhn.defaults.sh'.  This script
104    will search a generic path (essentially your $PATH) for programs to
105    handle various content types (for example, xv to display images).
106    You can re-run this script and give it a more tailored path.  You may
107    want to re-run this script later if you install new programs to
108    display content.  An example of this is:
109
110     % cd support/general
111     % ./mhn.defaults.sh /usr/local/bin:/usr/X11/bin:/usr/ucb > mhn.defaults
112
113    and then move `mhn.defaults' into the nmh `etc' directory.
114
115    The `mhn.defaults.sh' script only searches for a simple set of programs.
116    If you have specialized programs to handle various types, you will need
117    to edit the `mhn.defaults' file manually.  The syntax of this file is
118    described in the man page for `mhn', and in section 9.4 of the book
119    "MH & xmh: Email for Users and Programmers", 3rd edition, by Jerry Peek,
120    on the Internet at <http://rand-mh.sourceforge.net/book/mh/confmhn.html>.
121
122 8) Add an optional global mh.profile, if desired.  This profile should be
123    placed in the nmh `etc' directory with the name `mh.profile'.  This
124    file will be used to construct the initial .mh_profile of a new nmh
125    user, but will not be consulted after that.
126
127 -----------------------------------------------
128 Compiler options, or using a different compiler
129 -----------------------------------------------
130
131 By default, configure will use the "gcc" compiler if found.  You can
132 use a different compiler, or add unusual options for compiling or
133 linking that the "configure" script does not know about, by giving
134 "configure" initial values for these on its command line or in its
135 environment.  For example,
136
137     ./configure CC=c89 CFLAGS=-O2 LIBS=-lposix
138
139 If you wish to add options that are only used at compile time instead of
140 link time, you can use the CPPFLAGS variable:
141
142    ./configure CPPFLAGS='-Wextra -Wno-sign-compare'
143
144 If you want to add to both compile and link flags at build time
145 without putting them in the configuration, you can use the AM_CFLAGS
146 Makefile macro:
147
148     make AM_CFLAGS=--coverage
149
150 ----------------------------------------
151 Building nmh on additional architectures
152 ----------------------------------------
153 To build nmh on additional architectures, you can do a "make distclean".
154 This should restore the nmh source distribution back to its original
155 state.  You can then configure nmh as above on other architectures in
156 which you wish to build nmh.  Or alternatively, you can use a different
157 build directory for each architecture.
158
159 ---------------------------------
160 Using a different build directory
161 ---------------------------------
162 You can compile the nmh in a different directory from the one containing
163 the source code.  Doing so allows you to compile it on more than one
164 architecture at the same time.  To do this, you must use a version of
165 "make" that supports the "VPATH" variable, such as GNU "make".  "cd" to
166 the directory where you want the object files and executables to go and
167 run the "configure" script.  "configure" automatically checks for the
168 source code in the directory that "configure" is in.  For example,
169
170     cd /usr/local/solaris/nmh
171     /usr/local/src/nmh-1.5/configure
172     make
173
174 ---------------------
175 Options for configure
176 ---------------------
177 --prefix=DIR     (DEFAULT is /usr/local/nmh)
178      This will change the base prefix for the installation location
179      for the various parts of nmh.  Unless overridden, nmh is installed
180      in ${prefix}/bin, ${prefix}/etc, ${prefix}/lib, ${prefix}/man.
181
182 --bindir=DIR     (DEFAULT is ${prefix}/bin)
183      nmh's binaries (show, inc, comp, ...) are installed here.
184
185 --libdir=DIR     (DEFAULT is ${prefix}/lib)
186      nmh's support binaries (post, slocal, mhl, ...) are installed here.
187
188 --sysconfdir=DIR     (DEFAULT is ${prefix}/etc)
189      nmh's config files (mts.conf, mhn.defaults, ...) are installed here.
190
191 --mandir=DIR     (DEFAULT is ${prefix}/man)
192      nmh's man pages are installed here.
193
194 --enable-debug
195      Enable debugging support.
196
197 --enable-pop
198      Enable client-side support for pop.
199
200 --enable-apop
201      Enable client-side support for apop (Authenticated POP).
202
203 --with-editor=EDITOR  (DEFAULT is vi)
204      specify the full path of the default editor to use.  If this
205      option is not given, then the configuration process will search
206      for the `vi' command and use it as the default.  If you wish to
207      specify an interface which is compatible with MH, then use the
208      nmh command `prompter'.  If you specify `prompter', then you don't
209      need to give the full pathname.
210
211 --with-hesiod=PREFIX
212      Specify the location of Hesiod.
213
214 --with-krb4=PREFIX
215      Specify the location of Kerberos V4 for KPOP support. After
216      running configure, you will need to change the POPSERVICE #define in
217      config.h if you want to use KPOP exclusively (rather than being able
218      to switch between KPOP and normal POP3).  See the comments inside
219      config.h for details.
220
221 --with-locking=LOCKTYPE    (DEFAULT is dot)
222      Specify the locking mechanism when attempting to "inc" or
223      "msgchk" a local mail spool. Valid options are "dot",
224      "fcntl", "flock", and "lockf". Of the four, dot-locking
225      requires no special kernel or filesystem support, and simply
226      creates a file called "FILE.lock" to indicate that "FILE" is
227      locked.
228
229      In order to be effective, you should contact the site
230      administrator to find out what locking mechanisms other
231      mail delivery and user programs respect. The most common
232      reason not to use dot-locking is if the mail spool directory
233      is not world- or user-writeable, and thus a lock file cannot
234      be created.
235
236 --with-mts=MTS   (DEFAULT is smtp)
237      Specify the default mail transport system you want to use.  The two
238      acceptable options are "smtp" (which is the default), and
239      "sendmail".  This value will be put into the mts.conf file.  You
240      may find it convenient to specify a value at configure-time,
241      however, so that each time nmh is reinstalled, the right value will
242      be there.
243
244      If you use "smtp", this will enable a direct SMTP (simple mail
245      transport protocol) interface in nmh.  When sending mail, instead
246      of passing the message to the mail transport agent, `post' will
247      open a socket connection to the mail port on the machine specified
248      in the `mts.conf' file (default is localhost), and speak SMTP
249      directly.
250
251      If you use "sendmail", then `post' will send messages by forking a
252      local copy of sendmail.  Currently it will still speak SMTP with
253      this local copy of sendmail.
254
255      If you wish to use a transport agent other than sendmail, you will
256      need to use a `sendmail wrapper'.
257
258 --with-ndbm=LIB    (DEFAULT is to autodetect)
259 --with-ndbmheader=HEADER     (DEFAULT is to autodetect)
260      Specify the header file (eg ndbm.h) and library (eg ndbm) to use
261      to compile against the ndbm database library. By default, configure
262      will try various possibilities until it finds one that works; this
263      option only needs to be specified if the autodetection fails or
264      makes the wrong choice.
265
266      If either of these options is given then the other must also be
267      specified.
268
269 --with-pager=PAGER    (DEFAULT is more)
270      Specify the default pager (file lister) to use.  If this option
271      is not given, then the configuration process will search for the
272      command `more' and use it as the default.
273
274 --with-smtpservers='SMTPSERVER1[ SMTPSERVER2...]'    (DEFAULT is localhost)
275      If this option is not specified, the mts.conf file will contain
276      the line "servers: localhost", which may be manually edited later.
277      You may find it convenient to specify a value at configure-time,
278      however, so that each time nmh is reinstalled, the right value will be
279      there.
280
281      See the mh-tailor(5) man page for full documentation of "servers:".
282
283 --
284 The nmh team
285 nmh-workers@nongnu.org