Updated the installation instructions in INSTALL.
authormarkus schnalke <meillo@marmaro.de>
Fri, 7 Dec 2012 22:02:20 +0000 (23:02 +0100)
committermarkus schnalke <meillo@marmaro.de>
Fri, 7 Dec 2012 22:02:20 +0000 (23:02 +0100)
INSTALL

diff --git a/INSTALL b/INSTALL
index 8f3b7d3..cde8cc3 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -8,21 +8,20 @@ Installing mmh
 Please read all of the following instructions before you begin
 building mmh.
 
-You should check the MACHINES file to see if there are any specific
-build instructions for your operating system.  To build mmh, you will
-need an ANSI C compiler such as gcc.
+You should check the docs/MACHINES file to see if there are any
+specific build instructions for your operating system. To build mmh,
+you will need an ANSI C compiler such as gcc.
 
-0) If you have obtained mmh by checking it out of git, you will
-   need to run the GNU autotools to regenerate some files.
-   (If your directory already contains a file 'config.h.in'
+0) If you have obtained mmh by checking it out of the version control
+   system, you will need to run the GNU autotools to regenerate some
+   files. (If your directory already contains a file 'config.h.in'
    then this has already been done and you do not need to do it.)
    You can regenerate the files by running the command
 
    ./autogen.sh
 
    (Note that if you're doing mmh development, you should look at
-   docs/README.developers, since there is other developer-friendly
-   advice there as well.)
+   docs/README.developers for related information.)
 
 1) From the top-level source directory, run the command:
 
@@ -31,8 +30,8 @@ need an ANSI C compiler such as gcc.
    This will check the configuration of your OS, as well as the various
    Makefiles.
 
-   The configure script accepts various options.  The options of
-   most interest are listed in a section below.  To see the list
+   The configure script accepts various options. The options of
+   most interest are listed in a section below. To see the list
    of all available options, you can run:
 
        ./configure --help
@@ -41,33 +40,35 @@ need an ANSI C compiler such as gcc.
 
 3) make install
 
-   Note that if you have mmh files in your install directories with
+   Note that if you have mmh files in the target directories with
    the same names as the files being installed, the old ones will get
-   overwritten without any warning.  The only directory this isn't
+   overwritten without any warning. The only directory this isn't
    true for, is the `etc' directory -- in that directory, the distributed
    files are installed with a `.dist' suffix if they differ from the
-   existing file.  Watch for information messages while make is processing
+   existing file. Watch for information messages while make is processing
    that directory to see if you need to merge changes.
 
-4) Edit the file `mhn.defaults' (installed in the mmh `etc' directory).
+4) You may edit the file `mhn.defaults' in the mmh `etc' directory.
 
    This file contains the default profile entries for the mmh commands
    mhlist/mhstore/show.  The syntax of this file is described in section
    9.4 of the book "MH & xmh: Email for Users and Programmers", 3rd edition,
    by Jerry Peek, on the Internet at
    <http://rand-mh.sourceforge.net/book/mh/confmhn.html>.
+   In most cases you can skip this step.
 
 5) Add the bindir to your PATH variable.
 
    If you haven't change any paths, then the bindir is `/usr/local/mmh/bin'.
    Likely, your PATH is set in ~/.profile, ~/.kshrc, ~/.bashrc, or a similar
-   file.
+   file. Have a look at mmhwrap(1), which allows you to access mmh tools
+   conveniently without changing the PATH variable.
 
 
 -----------------------------------------------
 Compiler options, or using a different compiler
 -----------------------------------------------
-By default, configure will use the "gcc" compiler if found.  You can use a
+By default, configure will use the "gcc" compiler if found. You can use a
 different compiler, or add unusual options for compiling or linking that
 the "configure" script does not know about, by either editing the user
 configuration section of the top level Makefile (after running configure)
@@ -87,23 +88,23 @@ Building mmh on additional architectures
 ----------------------------------------
 To build mmh on additional architectures, you can do a "make distclean".
 This should restore the mmh source distribution back to its original
-state.  You can then configure mmh as above on other architectures in
-which you wish to build mmh.  Or alternatively, you can use a different
+state. You can then configure mmh as above on other architectures in
+which you wish to build mmh. Or alternatively, you can use a different
 build directory for each architecture.
 
 ---------------------------------
 Using a different build directory
 ---------------------------------
-You can compile the mmh in a different directory from the one containing
-the source code.  Doing so allows you to compile it on more than one
-architecture at the same time.  To do this, you must use a version of
-"make" that supports the "VPATH" variable, such as GNU "make".  "cd" to
-the directory where you want the object files and executables to go and
-run the "configure" script.  "configure" automatically checks for the
-source code in the directory that "configure" is in.  For example,
+You can compile mmh in a different directory from the one containing
+the source code. Doing so allows you to compile it on more than one
+architecture at the same time. To do this, you must use a version of
+"make" that supports the "VPATH" variable, such as GNU "make". Change
+to the directory where you want the object files and executables to go
+and run the "configure" script. "configure" automatically checks for
+the source code in the directory that "configure" is in. For example,
 
     cd /usr/local/solaris/mmh
-    /usr/local/src/mmh-1.0/configure
+    /usr/local/src/mmh-0.1/configure
     make
 
 ---------------------
@@ -111,7 +112,7 @@ Options for configure
 ---------------------
 --prefix=DIR     (DEFAULT is /usr/local/mmh)
      This will change the base prefix for the installation location
-     for the various parts of mmh.  Unless overridden, mmh is installed
+     for the various parts of mmh. Unless overridden, mmh is installed
      in ${prefix}/bin, ${prefix}/etc, ${prefix}/lib, ${prefix}/man.
 
 --bindir=DIR     (DEFAULT is ${prefix}/bin)
@@ -144,8 +145,3 @@ Options for configure
      reason not to use dot-locking is if the mail spool directory
      is not world- or user-writeable, and thus a lock file cannot
      be created.
-
-
---
-markus schnalke <meillo@marmaro.de>
-and the nmh team <nmh-workers@nongnu.org>