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

   1 #
   2 # INSTALL -- installation instructions
   3 #
   4
   5 --------------
   6 Installing mmh
   7 --------------
   8 Please read all of the following instructions before you begin
   9 building mmh.
  10
  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.
  14
  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
  20
  21    ./autogen.sh
  22
  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.)
  26
  27 1) From the top-level source directory, run the command:
  28
  29        ./configure [options]
  30
  31    This will check the configuration of your OS, as well as the various
  32    Makefiles.
  33
  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:
  37
  38        ./configure --help
  39
  40 2) make
  41
  42 3) make install
  43
  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.
  51
  52 4) Edit the file `mhn.defaults' (installed in the mmh `etc' directory).
  53
  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>.
  59
  60 5) Add the bindir to your PATH variable.
  61
  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
  64    file.
  65
  66
  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),
  76
  77 you can do that on the command line like this:
  78     CC=c89 CFLAGS=-O2 LIBS=-lposix ./configure
  79
  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
  82
  83 ----------------------------------------
  84 Building mmh on additional architectures
  85 ----------------------------------------
  86 To build mmh on additional architectures, you can do a "make distclean".
  87 This should restore the mmh source distribution back to its original
  88 state.  You can then configure mmh as above on other architectures in
  89 which you wish to build mmh.  Or alternatively, you can use a different
  90 build directory for each architecture.
  91
  92 ---------------------------------
  93 Using a different build directory
  94 ---------------------------------
  95 You can compile the mmh in a different directory from the one containing
  96 the source code.  Doing so allows you to compile it on more than one
  97 architecture at the same time.  To do this, you must use a version of
  98 "make" that supports the "VPATH" variable, such as GNU "make".  "cd" to
  99 the directory where you want the object files and executables to go and
 100 run the "configure" script.  "configure" automatically checks for the
 101 source code in the directory that "configure" is in.  For example,
 102
 103     cd /usr/local/solaris/mmh
 104     /usr/local/src/mmh-1.0/configure
 105     make
 106
 107 ---------------------
 108 Options for configure
 109 ---------------------
 110 --prefix=DIR     (DEFAULT is /usr/local/mmh)
 111      This will change the base prefix for the installation location
 112      for the various parts of mmh.  Unless overridden, mmh is installed
 113      in ${prefix}/bin, ${prefix}/etc, ${prefix}/lib, ${prefix}/man.
 114
 115 --bindir=DIR     (DEFAULT is ${prefix}/bin)
 116      mmh's binaries (show, inc, comp, ...) are installed here.
 117      You need to have this directory in your PATH variable.
 118
 119 --libdir=DIR     (DEFAULT is ${prefix}/lib)
 120      mmh's test tools (ap, dp, mhtest, ...) are installed here.
 121      They are seldom useful to normal users.
 122
 123 --sysconfdir=DIR     (DEFAULT is ${prefix}/etc)
 124      mmh's config files (mhn.defaults, ...) are installed here.
 125
 126 --mandir=DIR     (DEFAULT is ${prefix}/man)
 127      mmh's man pages are installed here.
 128
 129 --enable-debug
 130      Enable debugging support.
 131
 132 --enable-mhe    (DEFAULT)
 133      Add support for the Emacs front-end `mhe'.
 134
 135 --with-locking=LOCKTYPE    (DEFAULT is dot)
 136      Specify the locking mechanism when attempting to "inc" or
 137      "msgchk" a local mail spool. Valid options are "dot",
 138      "fcntl", "flock", and "lockf". Of the four, dot-locking
 139      requires no special kernel or filesystem support, and simply
 140      creates a file called "FILE.lock" to indicate that "FILE" is
 141      locked.
 142
 143      In order to be effective, you should contact the site
 144      administrator to find out what locking mechanisms other
 145      mail delivery and user programs respect. The most common
 146      reason not to use dot-locking is if the mail spool directory
 147      is not world- or user-writeable, and thus a lock file cannot
 148      be created.
 149
 150
 151 --
 152 markus schnalke <meillo@marmaro.de>
 153 and the nmh team <nmh-workers@nongnu.org>