mk-conf.sh, mk-mk.in: use variables for *all* utilities
[s-mailx.git] / README
blob6aca8e4e321cd734adc398bbac03b8eac58c2e00
1 W e l c o m e  t o  S - n a i l
2 ===============================
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.
11 S-nail has a git(1) repository [1] (browsable [2]) and regulary produces
12 release tarballs [3].  There is a project overview page [4], but more
13 information is available through the S-nail entry on my private webpage
14 [5] -- there also exists the possibility to read the manual of the
15 current release online [6].  S-nail now has its own mailing list [7;
16 listinfo: 8], which doesn't require subscription, but moderator approval
17 may hold your message back: please be patient, thank you.
18 And GMANE.org added s-nail-users@ to their archive [9] -- thank you!
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://sourceforge.net/projects/s-nail/>
24   [5] <http://sdaoden.users.sourceforge.net/code.html#s-nail>
25   [6] <http://sdaoden.users.sourceforge.net/code-nail.html>
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>
30 See the file INSTALL for installation notes and NEWS for release update
31 information.  The S-nail(1) git(1) repository consists of four branches:
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.
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.
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.
47 - heirloom: a full git(1) cvsimport of the Heirloom mailx(1) cvs(1)
48   repository.
50 To clone only the [master] branch, which is what a normal user most
51 likely is interested in, can be accomplished like that:
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
60 The S-nail(1) heraldic animal `snailmail.jpg' has been found at
61 <http://cdn.whatculture.com/wp-content/uploads/2009/06/snailmail.jpg>.
62 Thank you!
64 AUTHORS (file content)
65 ======================
67 Berkeley Mail was (according to def.h) developed by Kurt Shoens, dated
68 March 25, 1978. I very much regret that it seems impossible to include
69 the people that contributed within the around fifteen years of history
70 of BSD Mail. If you know more about this, contact me.
72 After the 4.4BSD release in 1993, Mail was not further developed
73 officially.  The code that Heirloom mailx is based on contains
74 numerous patches from OpenBSD, NetBSD, RedHat and Debian. Namely
75 the NetBSD developer Christos Zoulas wrote much of it.
77 The maintainer and primary developer of Heirloom mailx is
78 Gunnar Ritter. Its development started under the name "nail" in
79 February 2000 and added especially the MIME code, network protocol
80 support, and POSIX conformance improvements. In March 2006, the
81 program has been integrated into the Heirloom project.
83 In 2012 the stale Heirloom mailx(1) was adapted as S-nail(1) by
84 Steffen "Daode" Nurpmeso.
86 vim:set fenc=utf-8:s-ts-mode