2 # INSTALL -- installation instructions
10 Please read all of the following instructions before you begin
13 You should check the MACHINES file to see if there are any specific
14 build instructions for your operating system. To build nmh, you will
15 need an ANSI C compiler such as gcc.
19 sh configure [options]
21 This will check the configuration of your OS, and create
22 the include file config.h, as well as the various Makefiles.
24 The configure script accepts various options. The options of
25 most interest are listed below. To see the list of all available
30 2) (IMPORTANT) Edit the user configuration section at the beginning
31 of the generated include file `config.h'. Currently, not everything
32 is auto-configured, so some #defines must be set manually.
34 3) Edit the user configuration section at the top of the main Makefile.
40 6) Edit the file `mts.conf' (installed in the nmh `etc' directory)
41 and make any necessary changes for the mail transport interface
44 The default `mts.conf' file assumes you retrieve new mail from
45 a local (or NFS mounted) maildrop, and send outgoing mail by
46 injecting the message to a mail transfer agent (such as sendmail)
47 on the local machine via SMTP.
49 If you have enabled POP support and you want this to be the
50 default method of accessing new mail, you will need to change
51 the values of the variables "servers", "pophost", "localname",
52 and possibly "mmailid".
54 a) "servers" defines the server to which you send outgoing SMTP
57 b) "pophost" defines the server that runs the POP daemon, and to
58 which `inc' and `msgchk' will query for new mail.
60 c) "localname" defines the hostname that nmh considers local.
61 If not set, then nmh queries your OS for this value. You may
62 want to change this if you wish your e-mail to appear as if it
63 originated on the POP server.
65 d) "mmailid" is checked to see if nmh should do username
66 masquerading. If the value of this field is non-zero, then
67 nmh will check if the pw_gecos field in the password file
70 Full Name <fakeusername>
72 If the pw_gecos field has this form, then the internal nmh
73 routines that find the username and full name of a user will
74 return "fakeusername" and "Full Name" respectively. This is
75 useful if you wish messages that you send to appear to come
76 from the username of your POP account, rather than your username
79 If you compile with POP support, but only want to use it occasionally,
80 then you can always use the `-host' and `-user' options to `inc'
81 and `msgchk' instead of changing `mts.conf'.
83 Check the `mh-tailor' man page for a list of all the available
84 options for this file.
86 7) If you have enabled POP support, make sure that `pop3' (or more
87 precisely the value of the define POPSERVICE in config.h) is defined
88 in the /etc/services file (or its NIS/NIS+ equivalent) on the client
89 machine. It should be something equivalent to "110/tcp". This might
90 have already been done when the pop daemon was installed.
92 8) Edit the file `mhn.defaults' (installed in the nmh `etc' directory).
93 This file contains the default profile entries for the nmh command
94 `mhn' and is created by the script `mhn.defaults.sh'. This script
95 will search a generic path (essentially your $PATH) for programs to
96 handle various content types (for example, xv to display images).
97 You can re-run this script and give it a more tailored path. You may
98 want to re-run this script later if you install new programs to
99 display content. An example of this is:
102 ./mhn.defaults.sh /usr/local/bin:/usr/X11/bin:/usr/ucb > mhn.defaults
104 and then move `mhn.defaults' into the nmh `etc' directory.
106 The `mhn.defaults.sh' script only searches for a simple set of programs.
107 If you have specialized programs to handle various types, you will need
108 to edit the `mhn.defaults' file manually. The syntax of this file is
109 described in the man page for `mhn', and in section 9.4 of the book
110 "MH & xmh: Email for Users and Programmers", 3rd edition, by Jerry Peek.
112 9) Add an optional global mh.profile, if desired. This profile should be
113 placed in the nmh `etc' directory with the name `mh.profile'. This
114 file will be used to construct the initial .mh_profile of a new nmh
115 user, but will not be consulted after that.
117 -----------------------------------------------
118 Compiler options, or using a different compiler
119 -----------------------------------------------
120 By default, configure will use the "gcc" compiler if found. You can use a
121 different compiler, or add unusual options for compiling or linking that
122 the "configure" script does not know about, by either editing the user
123 configuration section of the top level Makefile (after running configure)
124 or giving "configure" initial values for these variables by setting them
125 in the environment. Using a Bourne-compatible shell (such as sh,ksh,zsh),
127 you can do that on the command line like this:
128 CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure
130 Or on systems that have the "env" program, you can do it like this:
131 env CPPFLAGS=-I/usr/local/include LDFLAGS=-s ./configure
133 ----------------------------------------
134 Building nmh on additional architectures
135 ----------------------------------------
136 To build nmh on additional architectures, you can do a "make distclean".
137 This should restore the nmh source distribution back to its original
138 state. You can then configure nmh as above on other architectures in
139 which you wish to build nmh. Or alternatively, you can use a different
140 build directory for each architecture.
142 ---------------------------------
143 Using a different build directory
144 ---------------------------------
145 You can compile the nmh in a different directory from the one containing
146 the source code. Doing so allows you to compile it on more than one
147 architecture at the same time. To do this, you must use a version of
148 "make" that supports the "VPATH" variable, such as GNU "make". "cd" to
149 the directory where you want the object files and executables to go and
150 run the "configure" script. "configure" automatically checks for the
151 source code in the directory that "configure" is in. For example,
153 cd /usr/local/solaris/nmh
154 /usr/local/src/nmh-1.0/configure
157 ---------------------
158 Options for configure
159 ---------------------
160 --prefix=DIR (DEFAULT is /usr/local/nmh)
161 This will change the base prefix for the installation location
162 for the various parts of nmh. Unless overridden, nmh is installed
163 in ${prefix}/bin, ${prefix}/etc, ${prefix}/lib, ${prefix}/man.
165 --bindir=DIR (DEFAULT is ${prefix}/bin)
166 nmh's binaries (show, inc, comp, ...) are installed here.
168 --libdir=DIR (DEFAULT is ${prefix}/lib)
169 nmh's support binaries (post, slocal, mhl, ...) are installed here.
171 --sysconfdir=DIR (DEFAULT is ${prefix}/etc)
172 nmh's config files (mts.conf, mhn.defaults, ...) are installed here.
174 --mandir=DIR (DEFAULT is ${prefix}/man)
175 nmh's man pages are installed here.
177 --with-mts=MTS (DEFAULT is smtp)
178 specify the mail transport system you want to use. The two
179 acceptable options are "smtp" (which is the default), and
182 If you use "smtp", this will enable a direct SMTP (simple
183 mail transport protocol) interface in nmh. When sending
184 mail, instead of passing the message to the mail transport
185 agent, `post' will open a socket connection to the mail
186 port on the machine specified in the `mts.conf' file
187 (default is localhost), and speak SMTP directly.
189 If you use "sendmail", then `post' will send messages by
190 passing forking a local copy of sendmail. Currently it
191 will still speak SMTP with this local copy of sendmail.
193 If you wish to use a transport agent other than sendmail, you will
194 need to use a `sendmail wrapper'.
196 --with-editor=EDITOR (DEFAULT is vi)
197 specify the full path of the default editor to use. If this
198 option is not given, then the configuration process will search
199 for the `vi' command and use it as the default. If you wish to
200 specify an interface which is compatible with MH, then use the
201 nmh command `prompter'. If you specify `prompter', then you don't
202 need to give the full pathname.
204 --with-pager=PAGER (DEFAULT is more)
205 specify the default pager (file lister) to use. If this option
206 is not given, then the configuration process will search for the
207 command `more' and use it as the default.
209 --enable-nmh-mhe (DEFAULT)
210 Add support for the Emacs front-end `mhe'.
213 Enable client-side support for pop.
216 Specify the location of Kerberos V4 for KPOP support. You will
217 also need to specify the option `--enable-nmh-pop'. After running
218 configure, you will probably need to change the POPSERVICE define
219 in config.h. See the comments inside config.h for details.
222 Specify the location of Hesiod.
225 Enable debugging support.
229 coleman@math.gatech.edu