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