Added support for optional Content_Disposition header in mhbuild directive.s
[mmh] / INSTALL
diff --git a/INSTALL b/INSTALL
index 28ccfea..37a38e5 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -14,9 +14,9 @@ You should check the MACHINES file to see if there are any specific
 build instructions for your operating system.  To build nmh, you will
 need an ANSI C compiler such as gcc.
 
 build instructions for your operating system.  To build nmh, you will
 need an ANSI C compiler such as gcc.
 
-1) Run the command
+1) From the top-level source directory, run the command
 
 
-   sh configure [options]
+   ./configure [options]
 
    This will check the configuration of your OS, and create the 
    include file config.h, as well as the various Makefiles.
 
    This will check the configuration of your OS, and create the 
    include file config.h, as well as the various Makefiles.
@@ -25,17 +25,25 @@ need an ANSI C compiler such as gcc.
    most interest are listed in a section below.  To see the list 
    of all available options, you can run
 
    most interest are listed in a section below.  To see the list 
    of all available options, you can run
 
-   sh configure --help
+   ./configure --help
 
 2) Look through the user configuration section at the beginning
 
 2) Look through the user configuration section at the beginning
-   of the generated include file `config.h'.  All system-specific
-   definitions should be sensed automatically now, but you may
+   of the generated include file `config.h'. You may
    want to customize some #defines for your environment.
 
 3) make
 
 4) make install
 
    want to customize some #defines for your environment.
 
 3) make
 
 4) make install
 
+   Note that if you have [n]mh files in your install directories with
+   the same names as the files being installed, the old ones will get
+   overwritten without any warning.  The only directory that isn't
+   true for is the `etc' directory -- in that directory, the previous
+   copy of each <file> will be backed up as <file>.prev if it differs
+   from the newly-installed copy.  Watch for any diff output while
+   make is processing that directory to see if you need to merge
+   changes from *.prev files into the new versions.
+
 5) Edit the file `mts.conf' (installed in the nmh `etc' directory)
    and make any necessary changes for the mail transport interface
    you are using.
 5) Edit the file `mts.conf' (installed in the nmh `etc' directory)
    and make any necessary changes for the mail transport interface
    you are using.
@@ -162,14 +170,15 @@ Options for configure
 --enable-debug
      Enable debugging support.
 
 --enable-debug
      Enable debugging support.
 
---enable-masquerade[='draft_from[ mmailid[ username_extension]]']    
+--enable-masquerade[='draft_from mmailid username_extension']    
      If this option is not specified, the mts.conf file will contain the line
      "masquerade: " (with no value), which may be manually edited later.  You
      may find it convenient to specify a value at configure-time, however, so
      that each time nmh is reinstalled, the right value will be there.
 
      If this option is not specified, the mts.conf file will contain the line
      "masquerade: " (with no value), which may be manually edited later.  You
      may find it convenient to specify a value at configure-time, however, so
      that each time nmh is reinstalled, the right value will be there.
 
-     Any subset of "draft_from mmailid username_extension" may be given.  As a
-     shortcut, simply doing `configure --enable-masquerade' will enable all 3.
+     The above usage shows all three masquerade options being specified, but any
+     subset of the three may be specified.  If you do want to enable all three,
+     you can simply use `configure --enable-masquerade' as a shortcut.
 
      See the mh-tailor(5) man page for full documentation of "masquerade:".
 
 
      See the mh-tailor(5) man page for full documentation of "masquerade:".
 
@@ -179,6 +188,9 @@ Options for configure
 --enable-pop
      Enable client-side support for pop.
 
 --enable-pop
      Enable client-side support for pop.
 
+--enable-apop
+     Enable client-side support for apop (Authenticated POP).
+
 --with-editor=EDITOR  (DEFAULT is vi)
      specify the full path of the default editor to use.  If this
      option is not given, then the configuration process will search
 --with-editor=EDITOR  (DEFAULT is vi)
      specify the full path of the default editor to use.  If this
      option is not given, then the configuration process will search
@@ -191,44 +203,74 @@ Options for configure
      Specify the location of Hesiod.
 
 --with-krb4=PREFIX
      Specify the location of Hesiod.
 
 --with-krb4=PREFIX
-     Specify the location of Kerberos V4 for KPOP support.  You will also need
-     to specify the option `--enable-pop'.  After running configure, you will
-     need to change the POPSERVICE #define in config.h if you want to use KPOP
-     exclusively (rather than being able to switch between KPOP and normal
-     POP3).  See the comments inside config.h for details.
+     Specify the location of Kerberos V4 for KPOP support. After
+     running configure, you will need to change the POPSERVICE #define in
+     config.h if you want to use KPOP exclusively (rather than being able
+     to switch between KPOP and normal POP3).  See the comments inside
+     config.h for details.
+
+--with-locking=LOCKTYPE    (DEFAULT is dot)
+     Specify the locking mechanism when attempting to "inc" or
+     "msgchk" a local mail spool. Valid options are "dot",
+     "fcntl", "flock", and "lockf". Of the four, dot-locking
+     requires no special kernel or filesystem support, and simply
+     creates a file called "FILE.lock" to indicate that "FILE" is
+     locked.
+
+     In order to be effective, you should contact the site
+     administrator to find out what locking mechanisms other
+     mail delivery and user programs respect. The most common
+     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.
 
 --with-mts=MTS   (DEFAULT is smtp)
 
 --with-mts=MTS   (DEFAULT is smtp)
-     Specify the mail transport system you want to use.  The two
+     Specify the default mail transport system you want to use.  The two
      acceptable options are "smtp" (which is the default), and
      acceptable options are "smtp" (which is the default), and
-     "sendmail".
-
-     If you use "smtp", this will enable a direct SMTP (simple
-     mail transport protocol) interface in nmh.  When sending
-     mail, instead of passing the message to the mail transport
-     agent, `post' will open a socket connection to the mail
-     port on the machine specified in the `mts.conf' file
-     (default is localhost), and speak SMTP directly.
-
-     If you use "sendmail", then `post' will send messages by
-     passing forking a local copy of sendmail.  Currently it
-     will still speak SMTP with this local copy of sendmail.
+     "sendmail".  This value will be put into the mts.conf file.  You
+     may find it convenient to specify a value at configure-time,
+     however, so that each time nmh is reinstalled, the right value will
+     be there.
+
+     If you use "smtp", this will enable a direct SMTP (simple mail
+     transport protocol) interface in nmh.  When sending mail, instead
+     of passing the message to the mail transport agent, `post' will
+     open a socket connection to the mail port on the machine specified
+     in the `mts.conf' file (default is localhost), and speak SMTP
+     directly.
+
+     If you use "sendmail", then `post' will send messages by forking a
+     local copy of sendmail.  Currently it will still speak SMTP with
+     this local copy of sendmail.
 
      If you wish to use a transport agent other than sendmail, you will
      need to use a `sendmail wrapper'.
 
 
      If you wish to use a transport agent other than sendmail, you will
      need to use a `sendmail wrapper'.
 
+--with-ndbm=LIB    (DEFAULT is to autodetect)
+--with-ndbmheader=HEADER     (DEFAULT is to autodetect)
+     Specify the header file (eg ndbm.h) and library (eg ndbm) to use
+     to compile against the ndbm database library. By default, configure
+     will try various possibilities until it finds one that works; this
+     option only needs to be specified if the autodetection fails or
+     makes the wrong choice.
+
+     If either of these options is given then the other must also be
+     specified.
+
 --with-pager=PAGER    (DEFAULT is more)
      Specify the default pager (file lister) to use.  If this option
      is not given, then the configuration process will search for the
      command `more' and use it as the default.
 
 --with-smtpservers='SMTPSERVER1[ SMTPSERVER2...]'    (DEFAULT is localhost)
 --with-pager=PAGER    (DEFAULT is more)
      Specify the default pager (file lister) to use.  If this option
      is not given, then the configuration process will search for the
      command `more' and use it as the default.
 
 --with-smtpservers='SMTPSERVER1[ SMTPSERVER2...]'    (DEFAULT is localhost)
-     If this option is not specified, the mts.conf file will contain the line
-     "servers: localhost", which may be manually edited later.  You may find it
-     convenient to specify a value at configure-time, however, so that each time
-     nmh is reinstalled, the right value will be there.
+     If this option is not specified, the mts.conf file will contain
+     the line "servers: localhost", which may be manually edited later.
+     You may find it convenient to specify a value at configure-time,
+     however, so that each time nmh is reinstalled, the right value will be
+     there.
 
      See the mh-tailor(5) man page for full documentation of "servers:".
 
 --
 The nmh team
 
      See the mh-tailor(5) man page for full documentation of "servers:".
 
 --
 The nmh team
-nmh-workers@mhost.com
+nmh-workers@nongnu.org