IMAP: fix and tweak previous [830f948]
[s-mailx.git] / README
blob98df0977f3596510435d66dbd8dc3f9bbeb153df
1 W e l c o m e  t o  S - n a i l / S - m a i l x
2 ===============================================
4 S-nail (later S-mailx) is a mail processing system with a command
5 syntax reminiscent of ed(1) with lines replaced by messages.
6 It is intended to provide the functionality of the POSIX mailx(1)
7 command, but is MIME capable and optionally offers extensions for
8 line editing, IDNA, MIME, S/MIME, SMTP and POP3 (and IMAP).
9 It is usable as a mail batch language.
11 Please refer to the file INSTALL for build and installation remarks,
12 and to NEWS for release update information.  The file THANKS mentions
13 people who have helped improving and deserve acknowledgement.
15 This software originates in the codebase of Heirloom mailx, formerly
16 known as nail, which itself is based upon Berkeley Mail that has
17 a history back to 1978 and which superseded Unix mail, a program that
18 already shipped with First Edition Unix from 1971 -- M. Douglas McIlroy
19 writes in his article "A Research UNIX Reader: Annotated Excerpts from
20 the Programmer's Manual, 1971-1986":
22   MAIL (v1 page 21, v7 page 22)
23     Electronic mail was there from the start. Never satisfied with its
24     exact behavior, everybody touched it at one time or another: to
25     assure the safety of simultaneous access, to improve privacy, to
26     survive crashes, to exploit uucp, to screen out foreign freeloaders,
27     or whatever. Not until v7 did the interface change (Thompson). [.]
29 1. Where?
30 2. Repository layout
31 3. Authors
33 1. Where?
34 ---------
36 Our latest release can be downloaded at [1], and the fully cross-
37 referenced manual can also be viewed as HTML online[2].
38 There are browsable git(1) repositories at sdaoden.eu[3] (use [4] for
39 cloning purposes), with mirrors at Sourceforge[5] and GitLab.com[6].
41   [1] https?://www.sdaoden.eu/downloads/s-nail-latest.tar{,.{asc,gz,xz}}
42   [2] https?://www.sdaoden.eu/code.html#s-mailx
43   [3] https?://git.sdaoden.eu/cgit/s-nail.git
44   [4] https?://git.sdaoden.eu/scm/s-nail.git
45   [5] http://sourceforge.net/projects/s-nail
46   [6] https://gitlab.com/sdaoden/s-nail
48 We have a mailing list[7] (later: [8]!) with moderated unsubscribed
49 posting possibilities; subscriptions can be managed via web interface[9];
50 Gmane added the ML their NNTP archive[10], and The Mail Archive archives
51 a browser-accessible and searchable web version[11] -- thank you!
52 Commits to the [stable/*] and [master] branches will be posted to [12],
53 and announcements will also be posted to [13], both are receive-only
54 mailing-lists.
56   [7] s-nail-users@lists.sourceforge.net
57   [8] s-mailx@sdaoden.eu
58   [9] https://lists.sourceforge.net/lists/listinfo/s-nail-users/
59   [10] news.gmane.org/gmane.mail.s-nail.user
60   [11] www.mail-archive.com/s-nail-users@lists.sourceforge.net/maillist.html
61   [12] s-mailx-commit@sdaoden.eu
62   [13] s-announce@sdaoden.eu
64 These and all other mailings-lists at sdaoden.eu are hosted by MLMMJ, so
65 users can manage their subscriptions by appending keywords to the plain
66 mailing list address, a +subscribe for subscription, and +unsubscribe
67 for unsubscription, e.g., s-mailx+subscribe@sdaoden.eu.
68 Our heraldic animal snailmail.jpg has been found at [+1].
69 Thank you!
71   [+1] http://cdn.whatculture.com/wp-content/uploads/2009/06/snailmail.jpg
73 2. Repository layout
74 --------------------
76 - [release/*]
77     A new branch within release/ is created for every release, e.g.,
78     [release/v14.8.10].  History won't be rewritten.
80     These branches consist of one commit, and that commit is signed with
81     an OpenPGP key and used for the signed release tag,
82     vMAJOR.MINOR.UPDATE.ar (.ar for "archive").  The commit as such
83     covers the data modifications that make up a release, i.e., release
84     date fixation, manual preprocessing, removal of data which doesn't
85     make sense in release tarballs, etc.
87     (Whereas all this is not true for older releases, the new repository
88     layout was introduced after v14.8.10, and used [timeline] as
89     a source for most references, therefore the signed tag v14.8.7.ar
90     protects all elder references within [release/]:
92       $ git describe --contains heads/release/v1.3.0
93       v14.8.7.ar~113
95 - [release/latest] and [release/stable]
96     "Symbolic links" to the latest (stable) release branches.
98 - [stable/*]
99     A new branch within stable/ will be created for each new minor
100     version, e.g., [stable/v14.8].  History won't be rewritten.
102     These are de-facto the [master] branches for their respective minor
103     release, which extend for the full lifetime of that, e.g., the
104     branch [stable/v14.7] has been created once the v14.7.0 release was
105     made, and it extends until the release of v14.7.11, the last v14.7
106     update release made.
108     Once the time for a new release has come, the head of such a stable
109     branch will gain a signed commit and a signed stable tag,
110     vMAJOR.MINOR.UPDATE, and then be used as the source for a new branch
111     in release/.
113 - [stable/latest] and [stable/stable]
114     "Symbolic links" to the latest (stable) stable branches.
116     These are possibly what users should track which want to have the
117     newest non-release bugfixes and stable, backward-compatible commits.
119 - [master]
120     Rooted on top of [heirloom].  It gains only stable, but possibly
121     backward-incompatible changes (those are usually mentioned on the
122     mailing-list), and will be used to create new entries in [stable/].
123     History won't be rewritten.
125 - [next]
126     Rooted on top of [master], this consists of a furious mixture of
127     commits that eventually end up in [master].  Daring users may give
128     this branch a try, but bugs and temporary nonstarters have to be
129     dealt with, then.
131 - [crawl]
132     Developer chaos (distributed horror backup - don't use!).
134 - [timeline]
135     A sketchy effort to collect the complete history of Unix mail and
136     its successor, BSD Mail.  Anything from the pre-Gunnar Ritter area
137     is taken from CSRG and other archives, for nail and Heirloom mailx
138     i've used release balls.
140 - [heirloom]
141     A full git(1) cvsimport of the Heirloom mailx(1) cvs(1) repository.
143 To create a full clone of the repository, with all the data and history:
144   $ git clone https://git.sdaoden.eu/scm/s-nail.git
146 With a newer git(1), and only tracking the latest stable branch:
147   $ git clone --single-branch --branch='stable/latest' \
148       https://git.sdaoden.eu/scm/s-nail.git
150 Or, selectively:
151   $ mkdir s-nail.git
152   $ cd s-nail.git
153   $ git init
154   $ git remote add origin -t 'release/*' -t 'stable/stable' -t master \
155       https://git.sdaoden.eu/scm/s-nail.git
156   $ git fetch -v
158 And then, assuming the last had been done:
160   $ # Show all releases
161   $ git log --no-walk --decorate --oneline --branches='release/*' --
162   $ # Check out the latest release, and verify the signature
163   $ git checkout release/latest
164   $ git log --oneline --show-signature --max-count=1 HEAD
165   $ make all && sudo make install
167 3. Authors
168 ----------
170 Unix mail seems to have been written mostly by Ken Thompson.
172 Berkeley Mail was (according to def.h) developed by Kurt Shoens, dated
173 March 25, 1978.  According to the CSRG commit log authors of BSD mail in
174 the time span 1980-10-08 to 1995-05-01 were, in order of appearance
175 (commit count): Kurt Shoens (379), Kirk McKusick (50), Carl Smith (16),
176 Bill Bush (2), Eric Allman (6), Craig Leres (43), Sam Leffler (51),
177 Ralph Campbell (21), Serge Granik (28), Edward Wang (253),
178 Donn Seeley (1), Jay Lepreau (3), Jim Bloom (1), Anne Hughes (2),
179 Kevin Dunlap (34), Keith Bostic (253), Mike Karels (1), Cael Staelin (6)
180 and Dave Borman (17).  One commit by Charlie Root, 36 by "dist".
182 Official BSD Mail development ceased in 1995 according to the CSRG
183 (Berkeley's Computer Systems Research Group) repository.  Mail has then
184 seen further development in open source BSD variants, noticeably by
185 Christos Zoulas in NetBSD.
187 Gunnar Ritter reused that codebase when he started developing nail in
188 February 2000, and incorporated numerous patches from OpenBSD, NetBSD,
189 RedHat and Debian.  He added MIME code, network protocol support, and
190 POSIX conformance improvements. In March 2006, he integrated that
191 program into the Heirloom project, renaming it to Heirloom mailx, the
192 development of which ceased in 2008.
194 In 2012 Steffen (Daode) Nurpmeso adopted the codebase as S-nail.
195 We try to end up as S-mailx.
197 # s-ts-mode