Rearranged whitespace (and comments) in all the code!
[mmh] / docs / README.developers
index 31a6e46..de32185 100644 (file)
@@ -38,7 +38,7 @@ directory structure
 Following is a list of nmh's directories along with a brief description of the
 purpose of each one.  Meanings are given for the abbreviations, but note that
 these meanings are just informed guesses as to what the MH developers were
-thinking. 
+thinking.
 
 ./
     The top-level directory.  Contains files like README and INSTALL.
@@ -47,7 +47,7 @@ config/
     Contains utility files for the `configure' process.  Ordinarily nothing in
     here needs to be messed with.
 
-doc/
+docs/
     Contains more specialized documentation, such as this file and
     the FAQ.
 
@@ -63,27 +63,11 @@ man/
     Contains all the input files that are processed to generate nmh's manual
     pages.
 
-mts/
-    "mts" stands for "Message Transfer Service".  Source files specific to the
-    different MTSs go in the subdirectories.
-
-mts/mmdf/ (deprecated)
-    "mmdf" stands for "Multichannel Memorandum Distribution Facility".  It is an
-    alternative to sendmail used primarily on SCO UNIX.
-
-mts/sendmail/ (deprecated: handled by mts.conf)
-    When nmh is configured --with-mts=sendmail, the files in this directory are
-    used. 
-
-mts/smtp/
-    When nmh is configured to just talk to an SMTP server over TCP/IP, the
-    source in this directory is compiled.
-
 sbr/
     "sbr" stands for "subroutine(s)".  For the most part, each source file in
     this directory contains a single function with the same name as the source
     file.  These functions are of general use and are called from throughout
-    nmh.  
+    nmh.
 
 uip/
     "uip" stands for "User Interface Programs".  Most nmh commands have a file
@@ -92,32 +76,6 @@ uip/
     <command>sbr.c which contains additional subroutines called from <command>.c
     (which would contain not much else besides main()).
 
-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/ (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/ (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/ (deprecated, now in sbr/)
-    MTS code not specific to any single MTS apparently goes here.
-
-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
-    versions of the key files in h/ and sbr/, and this directory will soon go
-    away completely.
-
 
 ---
 git
@@ -139,7 +97,7 @@ For some system functions whose availability or behavior varies from OS to OS,
 nmh conditionally uses a local definition with the same name as the OS function
 (e.g. snprintf()).  For other functions, developers need to avoid the OS
 versions and always use the nmh-supplied function.  Here is a list of such
-functions: 
+functions:
 
 OS function  nmh-local version to use instead
 ===========  ================================