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