Added support for optional Content_Disposition header in mhbuild directive.s
[mmh] / docs / README.developers
index 74c3c07..20b6452 100644 (file)
@@ -17,7 +17,8 @@ autoconf files
 
 If you wish to change the `configure' script or its related files, you'll need
 to first install GNU m4, available from <ftp://ftp.gnu.org/pub/gnu/m4/> and then
-GNU autoconf (<ftp://ftp.gnu.org/pub/gnu/autoconf/>).
+GNU autoconf (<ftp://ftp.gnu.org/pub/gnu/autoconf/>).  Nmh is currently using
+a minimum of autoconf 2.54.
 
 Most of the configure-related files are automatically generated.  The only files
 you should need to manually edit are acconfig.h and configure.in.  Don't, for
@@ -25,40 +26,14 @@ instance, edit config.h.in.  Though it is an input file from the point of view
 of the users (and the configure script) it is an output file from the point of
 view of the developers (and the autoconf script).
 
-If you do change acconfig.h or configure.in and want to `cvs commit' them, be
-sure to regenerate the output files and commit them as well.  The easiest way to
-regenerate the files is to simply run `make' -- it'll do the necessary calls of
-autoconf and autoheader and will do a `./config.status --recheck', which will
-exercise your new configure script.
-
-When you commit the configure-related files, it's very important to commit them
-in the right order.  The timestamps on the files in the CVS archive are based on
-the current time at the moment they were committed -- the timestamps from the
-local files you commit are not copied over.  If you commit the files in the
-wrong order, you'll cause unnecessary calls of `autoconf' to occur when people
-try to `make' their copies of the latest CVS source.  These people may be
-end-users who don't have any interest in changing the configure-related files
-and don't have autoconf installed.  They'll be unable to make without playing
-around with `touch'.
-
-The correct procedure to commit the configure-related files is:
-
-    % cvs commit acconfig.h aclocal.m4 configure.in
-    % autoheader; autoconf; date > stamp-h.in
-    % cvs commit config.h.in configure stamp-h.in
-
-The reason for the three-step commit is that configure.in contains the RCS $Id
-keyword, so when you commit it, a new version is written locally.  Therefore,
-the autoconf regeneration should be held off until after the commit, or your
-local stamp-h.in will become out-of-sync with the CVS version (granted, not that
-big a deal).  For the second step, you're doing the same commands as a 
-`make reset' would do, but using that command would require extra configure runs
-to make Makefile be up-to-date.
-
-If you haven't changed all the files noted above, just commit the ones you have
-changed, in the stated order (for instance, configure.in, then configure and
-stamp-h.in).
+Note that the automatically generated autoconf files (such as config.h.in,
+stamp-h.in, and configure), are NOT kept in CVS.  Thus, when you check out
+a CVS tree, you need to do the following things before you can build
+anything:
 
+       % autoheader
+       % autoconf
+       % date > stamp-h.in
 
 -------------------
 directory structure
@@ -76,6 +51,10 @@ config/
     Contains utility files for the `configure' process.  Ordinarily nothing in
     here needs to be messed with.
 
+doc/
+    Contains more specialized documentation, such as this file and
+    the FAQ.
+
 etc/
     Contains files, file templates, and scripts to generate files that will be
     installed in the ${prefix}/etc directory.  Stuff like replcomps.
@@ -92,11 +71,11 @@ mts/
     "mts" stands for "Message Transfer Service".  Source files specific to the
     different MTSs go in the subdirectories.
 
-mts/mmdf/
+mts/mmdf/ (deprecated)
     "mmdf" stands for "Multichannel Memorandum Distribution Facility".  It is an
     alternative to sendmail used primarily on SCO UNIX.
 
-mts/sendmail/
+mts/sendmail/ (deprecated: handled by mts.conf)
     When nmh is configured --with-mts=sendmail, the files in this directory are
     used. 
 
@@ -117,26 +96,26 @@ uip/
     <command>sbr.c which contains additional subroutines called from <command>.c
     (which would contain not much else besides main()).
 
-zotnet/
+zotnet/ (deprecated)
     Files in this hierarchy were either written by or moved here by UCI
     (University of California, Irvine) after they took over MH from the Rand
     Corporation.  "Zot!" is the sound effect made by the anteater in the "B.C."
     comic strip when its tongue lashes out at ants.  The anteater is UCI's
     official mascot.  Not sure whether UCInet was once called ZotNet...
 
-zotnet/bboards/
+zotnet/bboards/ (deprecated)
     UCI added Bulletin Board functionality to MH with the `bbc' command.  This
     functionality has been removed from nmh but apparently files in this
     directory are still needed for other purposes.
 
-zotnet/mf/
+zotnet/mf/ (deprecated, now in sbr/)
     "mf" stands for "Mail Filter".  The filtering in this case apparently refers
     to translation between different address and mailbox formats.
 
-zotnet/mts/
+zotnet/mts/ (deprecated, now in sbr/)
     MTS code not specific to any single MTS apparently goes here.
 
-zotnet/tws/
+zotnet/tws/ (deprecated, now in sbr/)
     "tws" apparently stands for "time with structure", a rather odd phrase.
     This directory used to be the place for date and time manipulation code, but
     currently nothing in here is compiled.  There are new, more portable
@@ -167,10 +146,12 @@ To make a public release of nmh (we'll use version 1.0.4 and my mhost.com
 account, danh, as examples here):
 
  1. % echo 1.0.4 > VERSION
+    % date +"%e %B %Y" > DATE
+    (DATE should contain something like "30 December 2000")
 
  2. Put a comment like "Released nmh-1.0.4." in the ChangeLog.
 
- 3. % cvs commit ChangeLog VERSION
+ 3. % cvs commit ChangeLog VERSION DATE
 
  4. % cvs tag nmh-1_0_4
     (cvs treats dots specially, so underscores are substituted here.)