README

   1 W e l c o m e  t o  S - n a i l / S - m a i l x
   2 ===============================================
   3
   4 S-nail (later S-mailx) is a mail processing system with a command
   5 syntax reminiscent of ed(1) with lines replaced by messages.
   6 It is intended to provide the functionality of the POSIX mailx(1)
   7 command, but is MIME capable and optionally offers extensions for
   8 line editing, IDNA, MIME, S/MIME, SMTP and POP3.
   9 It is usable as a mail batch language.
  10
  11 Please refer to the file INSTALL for build and installation remarks,
  12 and to NEWS for release update information.  The file THANKS mentions
  13 people who have helped improving and deserve acknowledgement.
  14
  15 This software originates in the codebase of Heirloom mailx, formerly
  16 known as nail, which itself is based upon Berkeley Mail that has
  17 a history back to 1978 and which superseded Unix mail, a program that
  18 already shipped with First Edition Unix from 1971 -- M. Douglas McIlroy
  19 writes in his article "A Research UNIX Reader: Annotated Excerpts from
  20 the Programmer's Manual, 1971-1986":
  21
  22   MAIL (v1 page 21, v7 page 22)
  23     Electronic mail was there from the start. Never satisfied with its
  24     exact behavior, everybody touched it at one time or another: to
  25     assure the safety of simultaneous access, to improve privacy, to
  26     survive crashes, to exploit uucp, to screen out foreign freeloaders,
  27     or whatever. Not until v7 did the interface change (Thompson). [.]
  28
  29 Our latest release can be downloaded at [1], and the fully cross-
  30 referenced manual of which can be viewed online[2].
  31 There are browsable git(1) repositories at sdaoden.eu[3] (use [4] for
  32 cloning purposes), with mirrors at Sourceforge[5] and GitLab.com[6].
  33
  34   [1] https?://www.sdaoden.eu/downloads/s-nail-latest.tar{,.{asc,gz,xz}}
  35   [2] https?://www.sdaoden.eu/code.html#s-mailx
  36   [3] https?://git.sdaoden.eu/cgit/s-nail.git
  37   [4] https?://git.sdaoden.eu/scm/s-nail.git
  38   [5] http://sourceforge.net/projects/s-nail
  39   [6] https://gitlab.com/sdaoden/s-nail
  40
  41 We have a mailing list[7] (later: [8]!) with moderated unsubscribed
  42 posting possibilities; subscriptions can be managed via web interface[9];
  43 Gmane added the ML their NNTP archive[10], and The Mail Archive archives
  44 a browser-accessible and searchable web version[11] -- thank you!
  45 Commits to the [master] branch will be posted to [12], and announcements
  46 will also be posted to [13], both are receive-only mailing-lists.
  47 These and all other mailings-lists at sdaoden.eu are hosted by MLMMJ, so
  48 users can manage their subscriptions by appending keywords to the plain
  49 mailing list address, a +subscribe for subscription, and +unsubscribe
  50 for unsubscription, e.g., s-mailx+subscribe@sdaoden.eu.
  51
  52   [7] s-nail-users@lists.sourceforge.net
  53   [8] s-mailx@sdaoden.eu
  54   [9] https://lists.sourceforge.net/lists/listinfo/s-nail-users/
  55   [10] news.gmane.org/gmane.mail.s-nail.user
  56   [11] www.mail-archive.com/s-nail-users@lists.sourceforge.net/maillist.html
  57   [12] s-mailx-commit@sdaoden.eu
  58   [13] s-announce@sdaoden.eu
  59
  60 The S-nail(1) git(1) repository consists of five branches:
  61
  62 - timeline: the more or less complete release history of Unix mail.
  63   Unix mail data is taken from "The Unix Tree" [100], BSD Mail from
  64   CSRG, then NetBSD, for nail and Heirloom mailx i've used release
  65   balls.
  66
  67   Since v14.8.7 and onwards this branch is (therefore: again) used to
  68   create the release tarballs, meaning that any modifications which are
  69   necessary to create a release from [master] data are performed and
  70   then committed, signed and tagged vVERSION.ar.
  71
  72 - master: rooted on top of [heirloom], this adapts Heirloom mailx(1) as
  73   S-nail(1).  This is the stable branch that a normal user should track.
  74   It is updated once a release is made, and will otherwise only see
  75   cherry-picked bug fixes or stable improvements.
  76
  77   Releases are tagged as vVERSION (s-nailvVERSION from v13 - v13.2,
  78   s-nail-VERSION from v14.0 - v14.4, Heirloom had R12_*) and signed.
  79   This data snapshot is then imported into [timeline] and used as the
  80   base for the release data (tagged vVERSION.ar).
  81
  82 - next: rooted on top of [master], this consists of a furious mixture of
  83   commits that eventually end up in [master]; it is a snapshot of the
  84   [crawl] branch, taken once that seems to be quite stable.
  85
  86 - crawl: developer chaos (distributed horror backup - don't use!).
  87
  88 - heirloom: a full git(1) cvsimport of the Heirloom mailx(1) cvs(1)
  89   repository.
  90
  91   [100] http://minnie.tuhs.org/cgi-bin/utree.pl
  92
  93 To clone only the [master] branch, which is what a normal user most
  94 likely is interested in:
  95
  96   $ git clone --single-branch https://git.sdaoden.eu/scm/s-nail.git
  97   $ cd s-nail
  98   $ make tangerine
  99
 100 when the --single-branch option is available, otherwise the very same
 101 can be achieved via
 102
 103   $ mkdir s-mailx.git
 104   $ cd s-mailx.git
 105   $ git init
 106   $ git remote add origin -t master https://git.sdaoden.eu/scm/s-nail.git
 107   $ git fetch -v
 108   $ git checkout master
 109   $ make tangerine
 110
 111 The release commits and release tags are signed with an OpenPGP key,
 112 please see NEWS for its identity.
 113
 114 Our heraldic animal snailmail.jpg has been found at [+1].
 115 Thank you!
 116
 117   [+1] http://cdn.whatculture.com/wp-content/uploads/2009/06/snailmail.jpg
 118
 119 AUTHORS
 120 =======
 121
 122 Unix mail seems to have been written mostly by Ken Thompson.
 123
 124 Berkeley Mail was (according to def.h) developed by Kurt Shoens, dated
 125 March 25, 1978.  According to the CSRG commit log authors of BSD mail in
 126 the time span 1980-10-08 to 1995-05-01 were, in order of appearance
 127 (commit count): Kurt Shoens (379), Kirk McKusick (50), Carl Smith (16),
 128 Bill Bush (2), Eric Allman (6), Craig Leres (43), Sam Leffler (51),
 129 Ralph Campbell (21), Serge Granik (28), Edward Wang (253),
 130 Donn Seeley (1), Jay Lepreau (3), Jim Bloom (1), Anne Hughes (2),
 131 Kevin Dunlap (34), Keith Bostic (253), Mike Karels (1), Cael Staelin (6)
 132 and Dave Borman (17).  One commit by Charlie Root, 36 by "dist".
 133
 134 Official BSD Mail development ceased in 1995 according to the CSRG
 135 (Berkeley's Computer Systems Research Group) repository.  Mail has then
 136 seen further development in open source BSD variants, noticeably by
 137 Christos Zoulas in NetBSD.
 138
 139 Gunnar Ritter reused that codebase when he started developing nail in
 140 February 2000, and incorporated numerous patches from OpenBSD, NetBSD,
 141 RedHat and Debian.  He added MIME code, network protocol support, and
 142 POSIX conformance improvements. In March 2006, he integrated that
 143 program into the Heirloom project, renaming it to Heirloom mailx, the
 144 development of which ceased in 2008.
 145
 146 In 2012 Steffen (Daode) Nurpmeso adopted the codebase as S-nail.
 147 We try to end up as S-mailx.
 148
 149 # s-ts-mode