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 a git(1) repository [1] (browsable [2]) and regulary produces
  17 release tarballs [3], which can be addressed directly (e.g., via `curl
  18 -v -L') [4].  There is also something visual on the web that includes
  19 the online version of the manual [5].  A mailing list exists [6;
  20 listinfo: 7] which doesn't require subscription (moderator approves),
  21 and GMANE.org added s-nail-users@ to their archive [8] -- thank you!
  22
  23   [1] <git.code.sf.net/p/s-nail/code> (HTTP / GIT)
  24   [2] <http://sourceforge.net/p/s-nail/code/>
  25   [3] <https://sourceforge.net/projects/s-nail/files/?source=navbar>
  26   [4] <https://downloads.sourceforge.net/project/s-nail/s-nail-VERSION.tar.xz>
  27   [5] <http://sdaoden.users.sourceforge.net/code.html#s-nail>
  28   [6] <mailto:s-nail-users@lists.sourceforge.net>
  29   [7] <https://lists.sourceforge.net/lists/listinfo/s-nail-users/>
  30   [8] <news://news.gmane.org/gmane.mail.s-nail.user>
  31
  32 The S-nail(1) git(1) repository consists of five branches:
  33
  34 - master: rooted on top of [heirloom], this adapts Heirloom mailx(1) as
  35   S-nail(1).  This is the stable branch that a normal user should track.
  36   It is updated once a release is made, and will otherwise only see
  37   cherry-picked bugfixes or very stable improvements.
  38
  39 - next: rooted on top of [master], this consists of a furious mixture of
  40   commits that eventually end up in [master]; it is a snapshot of the
  41   [crawl] branch, taken once that seems to be quite stable.
  42
  43 - crawl: developer chaos, nothing for normal people.
  44
  45 - timeline: an ongoing effort to collect the complete history of Mail.
  46
  47 - heirloom: a full git(1) cvsimport of the Heirloom mailx(1) cvs(1)
  48   repository.
  49
  50 To clone only the [master] branch, which is what a normal user most
  51 likely is interested in, can be accomplished like that:
  52
  53   $ mkdir s-nail.git
  54   $ cd s-nail.git
  55   $ git init
  56   $ git remote add origin -t master git://git.code.sf.net/p/s-nail/code
  57   $ git fetch -v
  58   $ git checkout master
  59   $ make CONFIG=MAXIMAL install
  60
  61 The S-nail(1) heraldic animal `snailmail.jpg' has been found at
  62 <http://cdn.whatculture.com/wp-content/uploads/2009/06/snailmail.jpg>.
  63 Thank you!
  64
  65 AUTHORS
  66 =======
  67
  68 Berkeley Mail was (according to def.h) developed by Kurt Shoens, dated
  69 March 25, 1978. I very much regret that it seems impossible to include
  70 the people that contributed within the around fifteen years of history
  71 of BSD Mail. If you know more about this, contact me.
  72
  73 After the 4.4BSD release in 1993, Mail was not further developed
  74 officially.  The code that Heirloom mailx is based on contains
  75 numerous patches from OpenBSD, NetBSD, RedHat and Debian. Namely
  76 the NetBSD developer Christos Zoulas wrote much of it.
  77
  78 The maintainer and primary developer of Heirloom mailx is
  79 Gunnar Ritter. Its development started under the name "nail" in
  80 February 2000 and added especially the MIME code, network protocol
  81 support, and POSIX conformance improvements. In March 2006, the
  82 program has been integrated into the Heirloom project.
  83
  84 In 2012 the stale Heirloom mailx(1) was adapted as S-nail(1) by
  85 Steffen (Daode) Nurpmeso.
  86
  87 # s-ts-mode