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, 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.
  10
  11 S-nail has a git(1) repository [1] (browsable [2]) and regulary produces
  12 release tarballs [3], which can be addressed directly (e.g., via `curl
  13 -v -L') [4].  There is a project overview page [5], but more information,
  14 inclusive an online version of the manual, is available through the
  15 S-nail entry on my private webpage [6].  S-nail now has its own mailing
  16 list [7; listinfo: 8], which doesn't require subscription, but moderator
  17 approval may hold your message back: please be patient, thank you.
  18 And GMANE.org added s-nail-users@ to their archive [9] -- thank you!
  19
  20   [1] <git.code.sf.net/p/s-nail/code> (HTTP / GIT)
  21   [2] <http://sourceforge.net/p/s-nail/code/>
  22   [3] <https://sourceforge.net/projects/s-nail/files/?source=navbar>
  23   [4] <https://downloads.sourceforge.net/project/s-nail/s-nail-MAJ_MIN_SUB.tar.?z>
  24   [5] <https://sourceforge.net/projects/s-nail/>
  25   [6] <http://sdaoden.users.sourceforge.net/code.html#s-nail>
  26   [7] <s-nail-users@lists.sourceforge.net>
  27   [8] <https://lists.sourceforge.net/lists/listinfo/s-nail-users/>
  28   [9] <news://news.gmane.org/gmane.mail.s-nail.user>
  29
  30 See the file INSTALL for installation notes and NEWS for release update
  31 information.  The S-nail(1) git(1) repository consists of five branches:
  32
  33 - master: rooted on top of *heirloom*, this adapts Heirloom mailx(1) as
  34   S-nail(1).  This is the stable branch that a normal user should track.
  35   It is updated once a release is made, and will otherwise only see
  36   cherry-picked bugfixes.
  37
  38 - next: rooted on top of *master*, this consists of a furious mixture of
  39   commits that eventually end up in *master*; it is a snapshot of the
  40   *crawl* branch, taken once that seemed to be quite stable.
  41
  42 - crawl: because of my brain-damaged way of working this is what *next*
  43   ought to be, but since people are using *next* i needed to isolate my
  44   grazy-grazy-grazy fixup-cross-your-fingers-now-that commits somewhere
  45   else.
  46
  47 - heirloom: a full git(1) cvsimport of the Heirloom mailx(1) cvs(1)
  48   repository.
  49
  50 - patches: this branch only contains the official bugfix patches.
  51   Official in that they have been sent to the ML and have been uploaded
  52   to the download area.
  53   This branch was added after the release of S-nail v14.5.2.
  54
  55 To clone only the [master] branch, which is what a normal user most
  56 likely is interested in, can be accomplished like that:
  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   $ git fetch -v
  63   $ git checkout master
  64
  65 The S-nail(1) heraldic animal `snailmail.jpg' has been found at
  66 <http://cdn.whatculture.com/wp-content/uploads/2009/06/snailmail.jpg>.
  67 Thank you!
  68
  69 AUTHORS (file content)
  70 ======================
  71
  72 Berkeley Mail was (according to def.h) developed by Kurt Shoens, dated
  73 March 25, 1978. I very much regret that it seems impossible to include
  74 the people that contributed within the around fifteen years of history
  75 of BSD Mail. If you know more about this, contact me.
  76
  77 After the 4.4BSD release in 1993, Mail was not further developed
  78 officially.  The code that Heirloom mailx is based on contains
  79 numerous patches from OpenBSD, NetBSD, RedHat and Debian. Namely
  80 the NetBSD developer Christos Zoulas wrote much of it.
  81
  82 The maintainer and primary developer of Heirloom mailx is
  83 Gunnar Ritter. Its development started under the name "nail" in
  84 February 2000 and added especially the MIME code, network protocol
  85 support, and POSIX conformance improvements. In March 2006, the
  86 program has been integrated into the Heirloom project.
  87
  88 In 2012 the stale Heirloom mailx(1) was adapted as S-nail(1) by
  89 Steffen (Daode) Nurpmeso.
  90
  91 vim:set fenc=utf-8:s-ts-mode