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 (and IMAP).
   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 Where?
  30 ------
  31
  32 Our latest release can be downloaded at [1], and the fully cross-
  33 referenced manual can also be viewed as HTML online[2].
  34 There are browsable git(1) repositories at sdaoden.eu[3] (use [4] for
  35 cloning purposes), with mirrors at Sourceforge[5] and GitLab.com[6].
  36
  37   [1] https?://www.sdaoden.eu/downloads/s-nail-latest.tar{,.{asc,gz,xz}}
  38   [2] https?://www.sdaoden.eu/code.html#s-mailx
  39   [3] https?://git.sdaoden.eu/cgit/s-nail.git
  40   [4] https?://git.sdaoden.eu/scm/s-nail.git
  41   [5] http://sourceforge.net/projects/s-nail
  42   [6] https://gitlab.com/sdaoden/s-nail
  43
  44 We have a mailing list[7] (later: [8]!) with moderated unsubscribed
  45 posting possibilities; subscriptions can be managed via web interface[9];
  46 Gmane added the ML their NNTP archive[10], and The Mail Archive archives
  47 a browser-accessible and searchable web version[11] -- thank you!
  48 Commits to the [stable/*] and [master] branches will be posted to [12],
  49 and announcements will also be posted to [13], both are receive-only
  50 mailing-lists.
  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 These and all other mailings-lists at sdaoden.eu are hosted by MLMMJ, so
  61 users can manage their subscriptions by appending keywords to the plain
  62 mailing list address, a +subscribe for subscription, and +unsubscribe
  63 for unsubscription, e.g., s-mailx+subscribe@sdaoden.eu.
  64 Our heraldic animal snailmail.jpg has been found at [+1].
  65 Thank you!
  66
  67   [+1] http://cdn.whatculture.com/wp-content/uploads/2009/06/snailmail.jpg
  68
  69 Repository layout
  70 -----------------
  71
  72 - [release/*]
  73     A new branch within release/ is created for every release, e.g.,
  74     [release/v14.8.10].  History won't be rewritten.
  75
  76     These branches consist of one commit, and that commit is signed with
  77     an OpenPGP key and used for the signed release tag,
  78     vMAJOR.MINOR.UPDATE.ar (.ar for "archive").  The commit as such
  79     covers the data modifications that make up a release, i.e., release
  80     date fixation, manual preprocessing, removal of data which doesn't
  81     make sense in release tarballs, etc.
  82
  83     (Whereas all this is not true for older releases, the new repository
  84     layout was introduced after v14.8.10, and used [timeline] as
  85     a source for most references, therefore the signed tag v14.8.7.ar
  86     protects all elder references within [release/]:
  87
  88       $ git describe --contains heads/release/v1.3.0
  89       v14.8.7.ar~113
  90
  91 - [release/latest] and [release/stable]
  92     "Symbolic links" to the latest (stable) release branches.
  93
  94 - [stable/*]
  95     A new branch within stable/ will be created for each new minor
  96     version, e.g., [stable/v14.8].  History won't be rewritten.
  97
  98     These are de-facto the [master] branches for their respective minor
  99     release, which extend for the full lifetime of that, e.g., the
 100     branch [stable/v14.7] has been created once the v14.7.0 release was
 101     made, and it extends until the release of v14.7.11, the last v14.7
 102     update release made.
 103
 104     Once the time for a new release has come, the head of such a stable
 105     branch will gain a signed commit and a signed stable tag,
 106     vMAJOR.MINOR.UPDATE, and then be used as the source for a new branch
 107     in release/.
 108
 109 - [stable/latest] and [stable/stable]
 110     "Symbolic links" to the latest (stable) stable branches.
 111
 112     These are possibly what users should track which want to have the
 113     newest non-release bugfixes and stable, backward-compatible commits.
 114
 115 - [master]
 116     Rooted on top of [heirloom].  It gains only stable, but possibly
 117     backward-incompatible changes (those are usually mentioned on the
 118     mailing-list), and will be used to create new entries in [stable/].
 119     History won't be rewritten.
 120
 121 - [next]
 122     Rooted on top of [master], this consists of a furious mixture of
 123     commits that eventually end up in [master].  Daring users may give
 124     this branch a try, but bugs and temporary nonstarters have to be
 125     dealt with, then.
 126
 127 - [crawl]
 128     Developer chaos (distributed horror backup - don't use!).
 129
 130 - [timeline]
 131     A sketchy effort to collect the complete history of Unix mail and
 132     its successor, BSD Mail.  Anything from the pre-Gunnar Ritter area
 133     is taken from CSRG and other archives, for nail and Heirloom mailx
 134     i've used release balls.
 135
 136 - [heirloom]
 137     A full git(1) cvsimport of the Heirloom mailx(1) cvs(1) repository.
 138
 139 To create a full clone of the repository, with all the data and history:
 140   $ git clone https://git.sdaoden.eu/scm/s-nail.git
 141
 142 With a newer git(1), and only tracking the latest stable branch:
 143   $ git clone --single-branch --branch='stable/latest' \
 144       https://git.sdaoden.eu/scm/s-nail.git
 145
 146 Or, selectively:
 147   $ mkdir s-nail.git
 148   $ cd s-nail.git
 149   $ git init
 150   $ git remote add origin -t 'release/*' -t 'stable/stable' -t master \
 151       https://git.sdaoden.eu/scm/s-nail.git
 152   $ git fetch -v
 153
 154 And then, assuming the last had been done:
 155
 156   $ # Show all releases
 157   $ git log --no-walk --decorate --oneline --branches='release/*' --
 158   $ # Check out the latest release, and verify the signature
 159   $ git checkout release/latest
 160   $ git log --oneline --show-signature --max-count=1 HEAD
 161   $ make all && sudo make install
 162
 163 AUTHORS
 164 -------
 165
 166 Unix mail seems to have been written mostly by Ken Thompson.
 167
 168 Berkeley Mail was (according to def.h) developed by Kurt Shoens, dated
 169 March 25, 1978.  According to the CSRG commit log authors of BSD mail in
 170 the time span 1980-10-08 to 1995-05-01 were, in order of appearance
 171 (commit count): Kurt Shoens (379), Kirk McKusick (50), Carl Smith (16),
 172 Bill Bush (2), Eric Allman (6), Craig Leres (43), Sam Leffler (51),
 173 Ralph Campbell (21), Serge Granik (28), Edward Wang (253),
 174 Donn Seeley (1), Jay Lepreau (3), Jim Bloom (1), Anne Hughes (2),
 175 Kevin Dunlap (34), Keith Bostic (253), Mike Karels (1), Cael Staelin (6)
 176 and Dave Borman (17).  One commit by Charlie Root, 36 by "dist".
 177
 178 Official BSD Mail development ceased in 1995 according to the CSRG
 179 (Berkeley's Computer Systems Research Group) repository.  Mail has then
 180 seen further development in open source BSD variants, noticeably by
 181 Christos Zoulas in NetBSD.
 182
 183 Gunnar Ritter reused that codebase when he started developing nail in
 184 February 2000, and incorporated numerous patches from OpenBSD, NetBSD,
 185 RedHat and Debian.  He added MIME code, network protocol support, and
 186 POSIX conformance improvements. In March 2006, he integrated that
 187 program into the Heirloom project, renaming it to Heirloom mailx, the
 188 development of which ceased in 2008.
 189
 190 In 2012 Steffen (Daode) Nurpmeso adopted the codebase as S-nail.
 191 We try to end up as S-mailx.
 192
 193 # s-ts-mode