git.marmaro.de Git - mmh/blob - INSTALL

   1 #
   2 # INSTALL -- installation instructions
   3 #
   4 # $Id$
   5 #
   6
   7 --------------
   8 Installing nmh
   9 --------------
  10 Please read all of the following instructions before you begin
  11 building nmh.
  12
  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.
  16
  17 1) Run the command
  18
  19    sh configure [options]
  20
  21    This will check the configuration of your OS, and create
  22    the include file config.h, as well as the various Makefiles.
  23
  24    The configure script accepts various options.  The options of
  25    most interest are listed below.  To see the list of all available
  26    options, you can run
  27
  28    sh configure --help
  29
  30 2) Look through the user configuration section at the beginning
  31    of the generated include file `config.h'.  All system-specific
  32    definitions should be sensed automatically now, but you may
  33    want to customize some #defines for your environment.
  34
  35 3) make
  36
  37 4) make install
  38
  39 5) Edit the file `mts.conf' (installed in the nmh `etc' directory)
  40    and make any necessary changes for the mail transport interface
  41    you are using.
  42
  43    The default `mts.conf' file assumes you retrieve new mail from
  44    a local (or NFS mounted) maildrop, and send outgoing mail by
  45    injecting the message to a mail transfer agent (such as sendmail)
  46    on the local machine via SMTP.
  47
  48    If, instead, all your mail sending and receiving occurs on a
  49    remote POP/SMTP server, you will need to look at the values of the
  50    variables "localname", "pophost", and "servers":
  51
  52     a) "localname" defines the hostname that nmh considers local.
  53        If not set, then nmh queries your OS for this value.  You will
  54        want to change this if you wish your e-mail to appear as if it
  55        originated on the POP server.
  56
  57     b) "pophost" defines the server that runs the POP daemon, and to
  58        which `inc' and `msgchk' will always query for new mail.
  59
  60     c) "servers" defines the server to which you send outgoing SMTP
  61        traffic.
  62
  63    If you compile with POP support, but don't want to use it exclusively,
  64    you can use the `-host' and `-user' options to `inc' and `msgchk'
  65    rather than hardcoding pophost in `mts.conf'.
  66
  67    Check the `mh-tailor' man page for a list of all the available options
  68    for this file ("masquerade" may be of particular interest).
  69
  70 6) If you have enabled POP support, make sure that `pop3' (or more
  71    precisely the value of the define POPSERVICE in config.h) is defined
  72    in the /etc/services file (or its NIS/NIS+ equivalent) on the client
  73    machine.  It should be something equivalent to "110/tcp".  This might
  74    have already been done when the POP daemon was installed.
  75
  76 7) Edit the file `mhn.defaults' (installed in the nmh `etc' directory).
  77    This file contains the default profile entries for the nmh command
  78    `mhn' and is created by the script `mhn.defaults.sh'.  This script
  79    will search a generic path (essentially your $PATH) for programs to
  80    handle various content types (for example, xv to display images).
  81    You can re-run this script and give it a more tailored path.  You may
  82    want to re-run this script later if you install new programs to
  83    display content.  An example of this is:
  84
  85     % cd support/general
  86     % ./mhn.defaults.sh /usr/local/bin:/usr/X11/bin:/usr/ucb > mhn.defaults
  87
  88    and then move `mhn.defaults' into the nmh `etc' directory.
  89
  90    The `mhn.defaults.sh' script only searches for a simple set of programs.
  91    If you have specialized programs to handle various types, you will need
  92    to edit the `mhn.defaults' file manually.  The syntax of this file is
  93    described in the man page for `mhn', and in section 9.4 of the book
  94    "MH & xmh: Email for Users and Programmers", 3rd edition, by Jerry Peek,
  95    on the Internet at <http://www.ics.uci.edu/~mh/book/mh/confmhn.htm>.
  96
  97 9) Add an optional global mh.profile, if desired.  This profile should be
  98    placed in the nmh `etc' directory with the name `mh.profile'.  This
  99    file will be used to construct the initial .mh_profile of a new nmh
 100    user, but will not be consulted after that.
 101
 102 -----------------------------------------------
 103 Compiler options, or using a different compiler
 104 -----------------------------------------------
 105 By default, configure will use the "gcc" compiler if found.  You can use a
 106 different compiler, or add unusual options for compiling or linking that
 107 the "configure" script does not know about, by either editing the user
 108 configuration section of the top level Makefile (after running configure)
 109 or giving "configure" initial values for these variables by setting them
 110 in the environment.  Using a Bourne-compatible shell (such as sh,ksh,zsh),
 111
 112 you can do that on the command line like this:
 113     CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure
 114
 115 Or on systems that have the "env" program, you can do it like this:
 116     env CPPFLAGS=-I/usr/local/include LDFLAGS=-s ./configure
 117
 118 ----------------------------------------
 119 Building nmh on additional architectures
 120 ----------------------------------------
 121 To build nmh on additional architectures, you can do a "make distclean".
 122 This should restore the nmh source distribution back to its original
 123 state.  You can then configure nmh as above on other architectures in
 124 which you wish to build nmh.  Or alternatively, you can use a different
 125 build directory for each architecture.
 126
 127 ---------------------------------
 128 Using a different build directory
 129 ---------------------------------
 130 You can compile the nmh in a different directory from the one containing
 131 the source code.  Doing so allows you to compile it on more than one
 132 architecture at the same time.  To do this, you must use a version of
 133 "make" that supports the "VPATH" variable, such as GNU "make".  "cd" to
 134 the directory where you want the object files and executables to go and
 135 run the "configure" script.  "configure" automatically checks for the
 136 source code in the directory that "configure" is in.  For example,
 137
 138     cd /usr/local/solaris/nmh
 139     /usr/local/src/nmh-1.0/configure
 140     make
 141
 142 ---------------------
 143 Options for configure
 144 ---------------------
 145 --prefix=DIR     (DEFAULT is /usr/local/nmh)
 146      This will change the base prefix for the installation location
 147      for the various parts of nmh.  Unless overridden, nmh is installed
 148      in ${prefix}/bin, ${prefix}/etc, ${prefix}/lib, ${prefix}/man.
 149
 150 --bindir=DIR     (DEFAULT is ${prefix}/bin)
 151      nmh's binaries (show, inc, comp, ...) are installed here.
 152
 153 --libdir=DIR     (DEFAULT is ${prefix}/lib)
 154      nmh's support binaries (post, slocal, mhl, ...) are installed here.
 155
 156 --sysconfdir=DIR     (DEFAULT is ${prefix}/etc)
 157      nmh's config files (mts.conf, mhn.defaults, ...) are installed here.
 158
 159 --mandir=DIR     (DEFAULT is ${prefix}/man)
 160      nmh's man pages are installed here.
 161
 162 --with-mts=MTS   (DEFAULT is smtp)
 163      specify the mail transport system you want to use.  The two
 164      acceptable options are "smtp" (which is the default), and
 165      "sendmail".
 166
 167      If you use "smtp", this will enable a direct SMTP (simple
 168      mail transport protocol) interface in nmh.  When sending
 169      mail, instead of passing the message to the mail transport
 170      agent, `post' will open a socket connection to the mail
 171      port on the machine specified in the `mts.conf' file
 172      (default is localhost), and speak SMTP directly.
 173
 174      If you use "sendmail", then `post' will send messages by
 175      passing forking a local copy of sendmail.  Currently it
 176      will still speak SMTP with this local copy of sendmail.
 177
 178      If you wish to use a transport agent other than sendmail, you will
 179      need to use a `sendmail wrapper'.
 180
 181 --with-editor=EDITOR  (DEFAULT is vi)
 182      specify the full path of the default editor to use.  If this
 183      option is not given, then the configuration process will search
 184      for the `vi' command and use it as the default.  If you wish to
 185      specify an interface which is compatible with MH, then use the
 186      nmh command `prompter'.  If you specify `prompter', then you don't
 187      need to give the full pathname.
 188
 189 --with-pager=PAGER    (DEFAULT is more)
 190      specify the default pager (file lister) to use.  If this option
 191      is not given, then the configuration process will search for the
 192      command `more' and use it as the default.
 193
 194 --enable-nmh-mhe    (DEFAULT)
 195      Add support for the Emacs front-end `mhe'.
 196
 197 --enable-nmh-pop
 198     Enable client-side support for pop.
 199
 200 --with-krb4=PREFIX
 201     Specify the location of Kerberos V4 for KPOP support.  You will also need to
 202     specify the option `--enable-nmh-pop'.  After running configure, you will
 203     need to change the POPSERVICE #define in config.h if you want to use KPOP
 204     exclusively (rather than being able to switch between KPOP and normal POP3).
 205     See the comments inside config.h for details.
 206
 207 --with-hesiod=PREFIX
 208     Specify the location of Hesiod.
 209
 210 --enable-nmh-debug
 211     Enable debugging support.
 212
 213 --
 214 The nmh team
 215 nmh-workers@mhost.com