README

   1 W e l c o m e  t o  S - n a i l
   2 ===============================
   3
   4 S-nail is a mail processing system with a command syntax reminiscent of
   5 ed(1) with lines replaced by messages.  It is intended to provide the
   6 functionality of the POSIX mailx(1) command and offers (mostly optional)
   7 extensions for line editing, IDNA, MIME, S/MIME, SMTP and POP3 (and IMAP).
   8 It is usable as a mail batch language.
   9 S-nail is a derivative of Heirloom mailx, formerly known as nail, which
  10 itself is based upon Berkeley Mail that has a history back to the 70s.
  11
  12 Please refer to the file INSTALL for build and installation remarks,
  13 and to NEWS for release update information.  The file THANKS mentions
  14 people who have helped improving S-nail and deserve acknowledgement.
  15
  16 S-nail has git(1) repositories at Sourceforge[1] (browsable[2]) and
  17 GitLab.com[3] (browsable[4]), and regulary produces release tarballs[5],
  18 which can also be addressed directly[6] (e.g., via `curl -v -L').
  19 There is also something visual on the web that includes the latest
  20 version of the manual online[7].
  21 And we have a mailing list[8] with moderated unsubscribed posting
  22 possibilities; subscriptions can be managed via webinterface[9];
  23 GMANE.org added s-nail-users@ to their archive[10] -- thank you!
  24
  25   [1] git.code.sf.net/p/s-nail/code (HTTP / GIT)
  26   [2] http://sourceforge.net/p/s-nail/code/
  27   [3] https://gitlab.com/sdaoden/s-nail.git
  28   [4] https://gitlab.com/sdaoden/s-nail
  29   [5] https://sourceforge.net/projects/s-nail/files/?source=navbar
  30   [6] https://downloads.sourceforge.net/project/s-nail/s-nail-VERSION.tar.xz
  31   [7] http://sdaoden.users.sourceforge.net/code.html#s-nail
  32   [8] mailto:s-nail-users@lists.sourceforge.net
  33   [9] https://lists.sourceforge.net/lists/listinfo/s-nail-users/
  34   [10] news://news.gmane.org/gmane.mail.s-nail.user
  35
  36 The S-nail(1) git(1) repository consists of five branches:
  37
  38 - master: rooted on top of [heirloom], this adapts Heirloom mailx(1) as
  39   S-nail(1).  This is the stable branch that a normal user should track.
  40   It is updated once a release is made, and will otherwise only see
  41   cherry-picked bugfixes or very stable improvements.
  42
  43 - next: rooted on top of [master], this consists of a furious mixture of
  44   commits that eventually end up in [master]; it is a snapshot of the
  45   [crawl] branch, taken once that seems to be quite stable.
  46
  47 - crawl: developer chaos, nothing for normal people.
  48
  49 - timeline: an ongoing effort to collect the complete history of Mail.
  50
  51 - heirloom: a full git(1) cvsimport of the Heirloom mailx(1) cvs(1)
  52   repository.
  53
  54 To clone only the [master] branch, which is what a normal user most
  55 likely is interested in:
  56
  57   $ mkdir s-nail.git
  58   $ cd s-nail.git
  59   $ git init
  60   $ git remote add origin -t master git://git.code.sf.net/p/s-nail/code
  61 alternatively
  62   $ git remote add origin -t master https://gitlab.com/s-nail/s-nail.git
  63   $ git fetch -v
  64   $ git checkout master
  65   $ make CONFIG=MAXIMAL install
  66
  67 The S-nail(1) heraldic animal `snailmail.jpg' has been found at
  68 <http://cdn.whatculture.com/wp-content/uploads/2009/06/snailmail.jpg>.
  69 Thank you!
  70
  71 AUTHORS
  72 =======
  73
  74 Berkeley Mail was (according to def.h) developed by Kurt Shoens, dated
  75 March 25, 1978.  According to the CSRG commit log authors of BSD mail in
  76 the time spam 1980-10-08 to 1995-05-01 were, in order of appearance
  77 (commit count): Kurt Shoens (379), Kirk McKusick (50), Carl Smith (16),
  78 Bill Bush (2), Eric Allman (6), Craig Leres (43), Sam Leffler (51),
  79 Ralph Campbell (21), Serge Granik (28), Edward Wang (253),
  80 Donn Seeley (1), Jay Lepreau (3), Jim Bloom (1), Anne Hughes (2),
  81 Kevin Dunlap (34), Keith Bostic (253), Mike Karels (1), Cael Staelin (6)
  82 and Dave Borman (17).  One commit by Charlie Root, 36 by "dist".
  83
  84 After the 4.4BSD release in 1993, Mail was not further developed
  85 officially.  The code that Heirloom mailx is based on contains
  86 numerous patches from OpenBSD, NetBSD, RedHat and Debian. Namely
  87 the NetBSD developer Christos Zoulas wrote much of it.
  88
  89 The maintainer and primary developer of Heirloom mailx is
  90 Gunnar Ritter. Its development started under the name "nail" in
  91 February 2000 and added especially the MIME code, network protocol
  92 support, and POSIX conformance improvements. In March 2006, the
  93 program has been integrated into the Heirloom project.
  94
  95 In 2012 the stale Heirloom mailx(1) was adapted as S-nail(1) by
  96 Steffen (Daode) Nurpmeso.
  97
  98 # s-ts-mode