~ubuntu-branches/ubuntu/precise/topal/precise

« back to all changes in this revision

Viewing changes to README.html

  • Committer: Bazaar Package Importer
  • Author(s): Phil Brooke
  • Date: 2008-07-18 07:57:38 UTC
  • mto: This revision was merged to the branch mainline in revision 3.
  • Revision ID: james.westby@ubuntu.com-20080718075738-i1szqvmxz0evz32p
Tags: upstream-62
ImportĀ upstreamĀ versionĀ 62

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
<HTML>
2
 
<HEAD>
3
 
<TITLE>
4
 
`Topal': GPG/Pine integration
5
 
</TITLE>
6
 
</HEAD>
7
 
<BODY>
8
 
 
9
 
<HR>
10
 
 
11
 
<H1>`Topal': GPG/Pine integration</H1>
12
 
 
13
 
Copyright (C) 2001--2003  Phillip J. Brooke
14
 
 
15
 
<HR>
16
 
 
17
 
<H2>Contents</H2>
18
 
 
19
 
<UL>
20
 
<LI> <A HREF="#introduction">Introduction</A>
21
 
<LI> <A HREF="#features">Features</A>
22
 
<LI> <A HREF="#important-changes">Important Changes from Previous Stable Versions</A>
23
 
<LI> <A HREF="#inst-and-config">Installation and Configuration</A>
24
 
<UL>
25
 
<LI> <A HREF="#comp-and-inst">Compilation and Installation</A>
26
 
<LI> <A HREF="#pine-config">Pine Configuration</A>
27
 
<LI> <A HREF="#mailcap-config">Mailcap Configuration</A>
28
 
<LI> <A HREF="#topal-config">Topal Configuration</A>
29
 
</UL>
30
 
<LI> <A HREF="#topal-usage">Topal Usage</A>
31
 
<UL>
32
 
<LI> <A HREF="#topal-help">Help!</A>
33
 
<LI> <A HREF="#interactive-config">Interactive Configuration</A>
34
 
<LI> <A HREF="#decrypt-verify">Decryption/Verification</A>
35
 
<LI> <A HREF="#sending">Sending</A>
36
 
<LI> <A HREF="#nonpine">Command-line usage</A>
37
 
</UL>
38
 
<LI> <A HREF="#additional-programs">Additional Programs</A>
39
 
<LI> <A HREF="#notes">Notes</A>
40
 
<UL>
41
 
<LI> <A HREF="#pinehack">The Pine hack, and sending other attachments</A>
42
 
<LI> <A HREF="#keyids">Key IDs</A>
43
 
<LI> <A HREF="#errors">Errors</A>
44
 
<LI> <A HREF="#decrypt-attachments">Decrypting attachments</A>
45
 
<LI> <A HREF="#cleaning-cache">Cleaning up the cache</A>
46
 
<LI> <A HREF="#new-releases">New releases</A>
47
 
</UL>
48
 
<LI> <A HREF="#author">Author</A>
49
 
<LI> <A HREF="#license">License</A>
50
 
<LI> <A HREF="#todo">To do</A>
51
 
<LI> <A HREF="#changes">Version History</A>
52
 
<UL>
53
 
<LI> <A HREF="#last-changes">Most recent changes</A>
54
 
</UL>
55
 
</UL>
56
 
 
57
 
<HR>
58
 
 
59
 
<H2><A NAME="introduction">Introduction</A></H2>
60
 
 
61
 
Topal is a `glue' program that links 
62
 
<A HREF="http://www.gnupg.org">GnuPG</A>
 
1
<html xmlns="http://www.w3.org/1999/xhtml">
 
2
<head>
 
3
<title>
 
4
Topal: GPG/GnuPG and Alpine/Pine integration
 
5
</title>
 
6
<style type="text/css">
 
7
body {
 
8
  font-family: Helvetica, Geneva, Arial,
 
9
        SunSans-Regular, sans-serif ;
 
10
  background-color: #fafffa }
 
11
a:link {
 
12
  color: blue }
 
13
a:visited {
 
14
  color: purple }
 
15
.navbar {
 
16
  text-align: center;
 
17
  font-size: x-small }
 
18
img.validator {
 
19
        float: right
 
20
}
 
21
.tail {
 
22
        text-align: center ;
 
23
        font-size: x-small ;
 
24
        float: none ;
 
25
        clear: both
 
26
}
 
27
</style>
 
28
</head>
 
29
<body>
 
30
 
 
31
<hr/>
 
32
 
 
33
<h1>Topal: GPG/GnuPG and Alpine/Pine integration</h1>
 
34
 
 
35
<p>Copyright (C) 2001--2008  Phillip J. Brooke</p>
 
36
 
 
37
<hr/>
 
38
 
 
39
<h2>Contents</h2>
 
40
 
 
41
<ul>
 
42
<li> <a href="#introduction">Introduction</a></li>
 
43
<li> <a href="#features">Features</a></li>
 
44
<li> <a href="#important-changes">Important changes from previous stable versions</a></li>
 
45
<li> <a href="#inst-and-config">Installation and configuration</a>
 
46
<ul>
 
47
<li> <a href="#comp-and-inst">Compilation and installation</a></li>
 
48
<li> <a href="#pine-config">Pine/Alpine configuration</a></li>
 
49
<li> <a href="#mailcap-config">Mailcap configuration</a></li>
 
50
<li> <a href="#topal-config">Topal configuration</a></li>
 
51
</ul></li>
 
52
<li> <a href="#topal-usage">Topal usage</a>
 
53
<ul>
 
54
<li> <a href="#topal-help">Help!</a></li>
 
55
<li> <a href="#interactive-config">Interactive configuration</a></li>
 
56
<li> <a href="#decrypt-verify">Decryption/verification</a></li>
 
57
<li> <a href="#sending">Sending</a></li>
 
58
<li> <a href="#nonpine">Command-line usage</a></li>
 
59
<li> <a href="#remote">Remote and server mode</a></li>
 
60
</ul></li>
 
61
<li> <a href="#fix-multipart">Fixing multipart emails</a></li>
 
62
<li> <a href="#notes">Notes</a>
 
63
<ul>
 
64
<li> <a href="#pinehack">The Pine/Alpine hack, and sending other attachments</a></li>
 
65
<li> <a href="#keyids">Key IDs and keylists</a></li>
 
66
<li> <a href="#errors">Errors</a></li>
 
67
<li> <a href="#decrypt-attachments">Decrypting attachments</a></li>
 
68
<li> <a href="#locale-problems">Locale problems</a></li>
 
69
<li> <a href="#cleaning-cache">Cleaning up the cache</a></li>
 
70
<li> <a href="#remote-notes">Remote and server mode</a></li>
 
71
<li> <a href="#new-releases">New releases</a></li>
 
72
<li> <a href="#release-numbering">Release numbering</a></li>
 
73
</ul></li>
 
74
<li> <a href="#author">Author</a></li>
 
75
<li> <a href="#licence">Licence</a></li>
 
76
<li> <a href="#todo">To do</a></li>
 
77
<li> <a href="#changes">Version history</a>
 
78
<ul>
 
79
<li> <a href="#last-changes">Most recent changes</a></li>
 
80
</ul></li>
 
81
</ul>
 
82
 
 
83
<hr/>
 
84
 
 
85
<h2><a name="introduction">Introduction</a></h2>
 
86
 
 
87
<p>Topal is a `glue' program that links 
 
88
<a href="http://www.gnupg.org">GnuPG</a>
63
89
and 
64
 
<A HREF="http://www.washington.edu/pine/">Pine</A>.  It offers
 
90
<a href="http://www.washington.edu/pine/">Pine</a>/<a href="http://www.washington.edu/alpine/">Alpine</a>.  It offers
65
91
facilities to encrypt, decrypt, sign and verify emails.  See the list
66
 
of <A HREF="#features">features</A> below.
67
 
 
68
 
<HR>
69
 
 
70
 
<H2><A NAME="features">Features</A></H2>
71
 
 
72
 
<!-- Don't remove the next line -- or its counterpart later on! -->
73
 
<!-- FL -->
74
 
 
75
 
<UL>
76
 
<LI> In-place decryption/verification, dealing with multiple blocks
77
 
embedded in text.
78
 
<LI> Caching of output to reduce need for passphrase (at expense of
79
 
storing decrypts and verification output).
80
 
<LI> Receiving of MIME RFC2015 multipart/signed and
81
 
multipart/encrypted messages.  (Top-level multipart items need some help from a script,
82
 
topal-fix-email, invoked by procmail.)  These features are available
83
 
to any program that uses .mailcap files.
84
 
<LI> Sending of MIME RFC2015 multipart/signed and multipart/encrypted
85
 
messages.  (Needs a patch to Pine.)
86
 
<LI> Sending and receiving of the old application/pgp content-type
87
 
(sending requires the same patch as the previous item).
88
 
<LI> Offers user the opportunity to check output before sending it.
89
 
<LI> Rich configuration options.
90
 
<LI> Shortcuts for selecting keys, as well as general key selection
91
 
routines when sending email.
92
 
<LI> Few arbitrary limits.
93
 
</UL>
94
 
 
95
 
<!-- FL -->
96
 
 
97
 
<HR>
98
 
 
99
 
<H2><A NAME="important-changes">Important Changes from Previous Stable Versions</A></H2>
100
 
 
101
 
The previous stable releases were 0.7.2, 0.7.8 and 0.7.9.
102
 
 
103
 
<H3>Important Changes in Version 0.7.10</H3>
104
 
 
105
 
The recommended procmail recipe has been changed.
106
 
 
107
 
<H3>Important Changes in Version 0.7.8</H3>
108
 
 
109
 
topal-fix-email and topal-fix-folder have been replaced by the
110
 
main topal binary.  Change <TT>topal-fix-email</TT> in your .procmailrc to be
111
 
<TT>topal --fix-email</TT>.  (Or add symlinks: the binary checks what it has been called as.)
112
 
 
113
 
<P>
114
 
 
115
 
You <EM>must</EM> clear your cache otherwise the changes made for
 
92
of <a href="#features">features</a> below.
 
93
</p>
 
94
 
 
95
<hr/>
 
96
 
 
97
<h2><a name="features">Features</a></h2>
 
98
 
 
99
<!-- Don't remove the next line - or its counterpart later on! -->
 
100
<!-- FL -->
 
101
 
 
102
<ul>
 
103
<li> In-place decryption/verification, dealing with multiple blocks
 
104
embedded in text.</li>
 
105
<li> Caching of output to reduce need for passphrase (at expense of
 
106
storing decrypts and verification output).</li>
 
107
<li> Receiving of MIME RFC2015/3156 multipart/signed and
 
108
multipart/encrypted messages.  Top-level multipart items need some
 
109
modification: see the README section `fixing multipart emails'.  These features are available
 
110
to any program that uses .mailcap files.</li>
 
111
<li> Sending of MIME RFC2015/3156 multipart/signed and multipart/encrypted
 
112
messages.  (Needs a patch to Pine/Alpine.)</li>
 
113
<li> Sending and receiving of the old application/pgp content-type
 
114
(sending requires the same patch as the previous item).</li>
 
115
<li> Basic support for verifying S/MIME multipart/signed messages.</li>
 
116
<li> Offers user the opportunity to check output before sending
 
117
it.</li>
 
118
<li> Remote sending mode for when reading email on a distant computer via ssh with secret
 
119
keys on the local computer.</li>
 
120
<li> Rich configuration options.</li>
 
121
<li> Shortcuts for selecting keys, as well as general key selection
 
122
routines when sending email.</li>
 
123
<li> Few arbitrary limits.</li>
 
124
</ul>
 
125
 
 
126
<!-- FL -->
 
127
 
 
128
<hr/>
 
129
 
 
130
<h2><a name="important-changes">Important changes from previous stable versions</a></h2>
 
131
 
 
132
<p>The previous stable releases were 0.7.2, 0.7.8, 0.7.9 and 0.7.13.6.
 
133
Release numbering has changed since then. 
 
134
The subsequent stable releases were 55, 56, .... </p>
 
135
 
 
136
<h3>Important changes in release 60</h3>
 
137
 
 
138
<ul>
 
139
<li>MIME sending now requires MIME-tool; mime-construct is no longer
 
140
used.  See <a href="#comp-and-inst">compilation and installation</a>.</li>
 
141
</ul>
 
142
 
 
143
<h3>Important changes in release 58</h3>
 
144
 
 
145
<ul>
 
146
<li>The default configuration no longer uses absolute paths.</li>
 
147
</ul>
 
148
 
 
149
<h3>Important changes in release 55</h3>
 
150
 
 
151
<ul>
 
152
<li>If you use a non-English locale, please check that Topal still
 
153
works as expected (replaced code that fixed some locale
 
154
problems).</li>
 
155
<li>The Alpine patch is based off my old Pine patches, but does a
 
156
little more.  You will need to set the <tt>Enable Topal hack for
 
157
OpenPGP/MIME messages</tt> option in the hidden configuration list. Bug
 
158
reports welcome.</li>
 
159
<li>The <tt>--fix-email</tt> wrapper no longer creates a
 
160
multipart/alternative: it creates a multipart/misc wrapper instead.
 
161
Please check that your procmail recipe includes a suitable backup in
 
162
case this doesn't work for you.</li>
 
163
</ul>
 
164
 
 
165
<h3>Important changes in version 0.7.10</h3>
 
166
 
 
167
<p>The recommended procmail recipe has been changed.</p>
 
168
 
 
169
<h3>Important changes in version 0.7.8</h3>
 
170
 
 
171
<p>topal-fix-email and topal-fix-folder have been replaced by the
 
172
main topal binary.  Change <tt>topal-fix-email</tt> in your .procmailrc to be
 
173
<tt>topal --fix-email</tt>.  (Or add symlinks: the binary checks what it has been called as.)</p>
 
174
 
 
175
<p>You <em>must</em> clear your cache otherwise the changes made for
116
176
inline-separate-output (added in version 0.7.8) will break (this occurs regardless of whether
117
177
the option is on or off).  This new feature shows the GnuPG/Topal
118
178
output separately, then hands back the decrypted or verified output
119
179
without any wrappers.  This makes it more suitable for dealing with
120
 
attachments (but you need to set it manually via <TT>topal
121
 
-config</TT>).
122
 
 
123
 
<P>
124
 
 
 
180
attachments (but you need to set it manually via <tt>topal
 
181
-config</tt>).</p>
 
182
 
 
183
<p>
125
184
Finally, the send menu has a new option: `Pass through unchanged'.
126
 
This does nothing to the message (except for forcing the content-type
127
 
to be text/plain when invoked with -sendmime; this is useful for
128
 
dealing with an obscure bug in Pine 4.44).  Moreover, you can
129
 
always have Topal invoked for sending.
130
 
 
131
 
 
132
 
<HR>
133
 
 
134
 
<H2><A NAME="inst-and-config">Installation and Configuration</A></H2>
135
 
 
136
 
<H3><A NAME="comp-and-inst">Compilation and Installation</A></H3>
137
 
 
138
 
You need a working C compiler and the GNU Ada Compiler (GNAT).  There
139
 
is a makefile: simply type `make'.  Type `make install' to see what
140
 
files need copying (it doesn't actually do the copy).
141
 
 
142
 
 
143
 
<H3><A NAME="pine-config">Pine Configuration</A></H3>
144
 
 
145
 
Assuming that the topal binary is installed in /usr/local/bin, set up
146
 
the Pine sending & display filters as follows:
147
 
<PRE>
148
 
display-filters=_BEGINNING("-----BEGIN PGP ")_ /usr/local/bin/topal -display _TMPFILE_ _RESULTFILE_
149
 
 
150
 
sending-filters=/usr/local/bin/topal -send _TMPFILE_ _RESULTFILE_ _RECIPIENTS_,
151
 
                /usr/local/bin/topal -sendmime _TMPFILE_ _RESULTFILE_ _MIMETYPE_ _RECIPIENTS_
152
 
</PRE>
153
 
You can choose either or both of the sending filters.  The <TT>-sendmime</TT>
 
185
This does nothing to the message so, you can
 
186
always have Topal invoked as a filter for sending.
 
187
</p>
 
188
 
 
189
<hr/>
 
190
 
 
191
<h2><a name="inst-and-config">Installation and configuration</a></h2>
 
192
 
 
193
<h3><a name="comp-and-inst">Compilation and installation</a></h3>
 
194
 
 
195
<p>
 
196
To compile Topal, you need a working C compiler and the GNU Ada
 
197
Compiler (GNAT).  There is a makefile: simply type <tt>make</tt>.
 
198
Type <tt>make install</tt> to actually install.  The default location
 
199
is /usr, so you'll need to be root to install.  Alternatively, use
 
200
<tt>make install INSTALLPATH=/usr/local</tt> to install into
 
201
/usr/local.  (Or use the more specific variables INSTALLPATHBIN,
 
202
INSTALLPATHMAN, INSTALLPATHDOC and INSTALLPATHPATCHES.)
 
203
</p>
 
204
 
 
205
<p>
 
206
MIME sending requires the Topal version of mime-tool (included with
 
207
the Topal sources, and compiled and installed at the same time using
 
208
the Makefile).  MIME viewing can be handled via metamail, run-mailcap,
 
209
or by saving to a file in the <tt>~/.topal</tt> directory and viewed
 
210
with Alpine.
 
211
</p>
 
212
 
 
213
<h3><a name="pine-config">Pine/Alpine configuration</a></h3>
 
214
 
 
215
<p>
 
216
Assuming that the topal binary is installed in /usr/bin, set up
 
217
the Pine/Alpine sending and display filters as follows:
 
218
</p>
 
219
<pre>
 
220
display-filters=_BEGINNING("-----BEGIN PGP ")_ /usr/bin/topal -display _TMPFILE_ _RESULTFILE_
 
221
 
 
222
sending-filters=/usr/bin/topal -send _TMPFILE_ _RESULTFILE_ _RECIPIENTS_,
 
223
                /usr/bin/topal -sendmime _TMPFILE_ _RESULTFILE_ _MIMETYPE_ _RECIPIENTS_
 
224
</pre>
 
225
<p>
 
226
You can choose either or both of the sending filters.  The <tt>-sendmime</tt>
154
227
option allows the user to choose the MIME type of the outbound
155
 
email. (Legacy fixes are in place that make <TT>-decrypt</TT> and <TT>-verify</TT>
156
 
behave the same as <TT>-display</TT>.)
157
 
<P>
158
 
For -sendmime to work, you will need to patch Pine.  There are patches
 
228
email. (Legacy fixes are in place that make <tt>-decrypt</tt> and <tt>-verify</tt>
 
229
behave the same as <tt>-display</tt>.)  Note that
 
230
<tt>_RECIPIENTS_</tt> should be last.
 
231
</p>
 
232
 
 
233
<p>
 
234
For -sendmime to work, you will need to patch Pine/Alpine.  There are patches
159
235
for versions 
160
 
<A HREF="pine-4.44-patch">4.44</A>,
161
 
<A HREF="pine-4.50-patch">4.50</A> 
162
 
and
163
 
<A HREF="pine-4.53-patch">4.53</A>
164
 
of Pine.  (They're all more-or-less the same patch.  It's pretty easy
165
 
to apply them against Pine versions 4.51 and 4.52 if you feel so
166
 
inclined.)
167
 
 
168
 
`<TT>cd</TT>' into the pine4.<I>xx</I> directory and use the command
169
 
`<TT>patch -p1 &lt; wherever/the/patch/is</TT>'.
170
 
 
171
 
<P>
172
 
 
 
236
<a href="pine-4.44.patch">4.44</a>,
 
237
<a href="pine-4.50.patch">4.50</a>,
 
238
<a href="pine-4.53.patch">4.53</a>,
 
239
<a href="pine-4.58.patch">4.58</a>.
 
240
<a href="pine-4.60.patch">4.60</a>
 
241
and
 
242
<a href="pine-4.64.patch">4.64</a>
 
243
of Pine.  (They're all more-or-less the same patch.)
 
244
<tt>cd</tt> into the pine4.<i>xx</i> directory and use the 
 
245
<tt>patch</tt>  command.
 
246
</p>
 
247
 
 
248
<p>
 
249
There are patches for Alpine: versions 
 
250
<a href="alpine-1.00.patch">1.00</a>
 
251
and
 
252
<a href="alpine-1.10.patch">1.10</a>.
 
253
Please note that the Alpine patches also modify Alpine's
 
254
configuration.  There is a hidden preference `enable Topal hack'
 
255
(enable-topal-hack) that you need to switch on.
 
256
</p>
 
257
 
 
258
<p>
173
259
It doesn't seem to have broken anything else....  It seems to work for
174
260
sending via an SMTP server - it might break for sending via
175
261
/usr/lib/sendmail (if it does, please send me a debug trace by
176
 
invoking pine with `<TT>-d 9</TT>').
177
 
 
178
 
<H3><A NAME="mailcap-config">Mailcap Configuration</A></H3>
179
 
 
180
 
To decode MIME RFC2015 multipart/signed and /encrypted messages
 
262
invoking pine with `<tt>-d 9</tt>').
 
263
</p>
 
264
 
 
265
<p>
 
266
You can also add <tt>--read-from _INCLUDEALLHDRS_</tt> before
 
267
<tt>send</tt> and <tt>-sendmime</tt>.  This makes Topal attempt to
 
268
guess a suitable key for signing and self-encryption.  If multiple
 
269
possible keys match, then you'll be offered a menu of the keys.
 
270
</p>
 
271
 
 
272
<h3><a name="mailcap-config">Mailcap configuration</a></h3>
 
273
 
 
274
<p>
 
275
To decode MIME RFC2015/3156 multipart/signed and /encrypted messages
181
276
requires the assistance of metamail.  Add in either the user mailcap
182
 
configuration (<TT>.mailcap</TT>) or the system configuration
183
 
(<TT>/etc/mailcap</TT>) the lines
184
 
<PRE>
185
 
multipart/signed; /usr/local/bin/topal -mime '%s' '%t'; needsterminal
186
 
multipart/encrypted; /usr/local/bin/topal -mime '%s' '%t'; needsterminal
187
 
application/pgp; /usr/local/bin/topal -mimeapgp '%s' '%t'; needsterminal
188
 
</PRE>
189
 
 
190
 
<H3><A NAME="procmail-config">Procmail Configuration</A></H3>
191
 
 
 
277
configuration (<tt>.mailcap</tt>) or the system configuration
 
278
(<tt>/etc/mailcap</tt>) the lines
 
279
</p>
 
280
<pre>
 
281
multipart/signed; /usr/bin/topal -mime '%s' '%t'; needsterminal
 
282
multipart/encrypted; /usr/bin/topal -mime '%s' '%t'; needsterminal
 
283
application/pgp; /usr/bin/topal -mimeapgp '%s' '%t'; needsterminal
 
284
</pre>
 
285
 
 
286
<h3><a name="procmail-config">Procmail configuration</a></h3>
 
287
 
 
288
<p>
192
289
In your procmailrc, add the recipe:
193
 
<PRE>
 
290
</p>
 
291
<pre>
194
292
:0fw
195
 
| /usr/local/bin/topal --fix-email
196
 
</PRE>
197
 
I <EM>strongly</EM> advise that you also use one of the backup
 
293
| /usr/bin/topal --fix-email
 
294
</pre>
 
295
<p>This examines all inbound emails.  Those with top-level
 
296
multipart/signed or multipart/encrypted MIME types are modified to add
 
297
a multipart/misc wrapper so that Pine/Alpine can hand it off to
 
298
Topal.  All other emails are left unchanged.</p>
 
299
<p>
 
300
I <em>strongly</em> advise that you also use one of the backup
198
301
recipes from the procmail manual.  See also the notes in 
199
 
<A HREF="#additional-programs">additional programs</A>.
200
 
 
201
 
<H3><A NAME="topal-config">Topal Configuration</A></H3>
202
 
 
203
 
Create a directory called `${HOME}/.topal'.  This is currently
204
 
hard-coded into Topal.  Create the basic configuration file by running
205
 
topal with the -dump or -default option.  This file should be named `<TT>config</TT>'.
206
 
<P>
 
302
<a href="#fix-multipart">fixing multipart emails</a>.
 
303
</p>
 
304
 
 
305
<h3><a name="topal-config">Topal configuration</a></h3>
 
306
 
 
307
<p>
 
308
Create a directory called `<tt>${HOME}/.topal</tt>'.  This is
 
309
currently hard-coded into Topal.  Create the basic configuration file
 
310
by running topal with the <tt>-dump</tt> or <tt>-default</tt> options.
 
311
This file should be named `<tt>config</tt>'.
 
312
</p>
 
313
 
 
314
<p>
207
315
All .topal files are silently ignored if they cannot be found.
 
316
Comments begin with a # in the first column, and run to the end of a
 
317
line.  They are totally ignored and are not currently preserved.
208
318
Parsing errors cause an exception.
209
 
<P>
 
319
</p>
 
320
 
 
321
<p>
210
322
If you want to include strings with spaces, you'll need to quote them
211
 
with double-quotes (<TT>"</TT>).  Double-quotes themselves can be
212
 
included by `stuffing' (<TT>""</TT>).
213
 
 
214
 
 
215
 
<HR>
216
 
 
217
 
<H2><A NAME="topal-usage">Topal Usage</A></H2>
218
 
 
219
 
<H3><A NAME="topal-help">Help!</A></H3>
220
 
 
221
 
<TT>-help</TT> as the first argument dumps a help message.
222
 
<P>
223
 
The help message is derived from the help.txt file (included at
 
323
with double-quotes (<tt>"</tt>).  Double-quotes themselves can be
 
324
included by `stuffing' (<tt>""</tt>).
 
325
</p>
 
326
 
 
327
<hr/>
 
328
 
 
329
<h2><a name="topal-usage">Topal usage</a></h2>
 
330
 
 
331
<h3><a name="topal-help">Help!</a></h3>
 
332
 
 
333
<p>
 
334
<tt>-help</tt> as the first argument dumps a help message.
 
335
</p>
 
336
 
 
337
<p>
 
338
The help message is derived from the <tt>help.txt</tt> file (included at
224
339
compile time).
225
 
<P>
226
 
See help.txt for information on <A HREF="#nonpine">non-Pine use of Topal</A>.
227
 
<P>
228
 
Send <A HREF="#author">email to me</A> if you're really stuck.
229
 
 
230
 
<H3><A NAME="interactive-config">Interactive Configuration</A></H3>
231
 
 
232
 
<TT>-config</TT> as the first argument brings up the configuration menu.
233
 
<P>
 
340
</p>
 
341
 
 
342
<p>
 
343
See <tt>help.txt</tt> for information on <a href="#nonpine">non-Pine use of Topal</a>.
 
344
</p>
 
345
 
 
346
<p>
 
347
Send <a href="#author">email to me</a> if you're really stuck.
 
348
</p>
 
349
 
 
350
<h3><a name="interactive-config">Interactive configuration</a></h3>
 
351
 
 
352
<p>
 
353
<tt>-config</tt> as the first argument brings up the configuration menu.
 
354
</p>
 
355
 
 
356
<p>
234
357
This menu is also available when sending (so that the signing key can
235
358
be changed).
236
 
 
237
 
 
238
 
<H3><A NAME="decrypt-verify">Decryption/Verification</A></H3>
239
 
 
 
359
</p>
 
360
 
 
361
<h3><a name="decrypt-verify">Decryption/verification</a></h3>
 
362
 
 
363
<p>
240
364
Depending on configuration, Topal will either ignore the file
241
365
altogether, ask you what you want to do with it, or proceed to
242
366
process the file automatically.
243
 
<P>
 
367
</p>
 
368
 
 
369
<p>
244
370
GPG will ask you for your passphrase when it needs it.
245
 
<P>
 
371
</p>
 
372
 
 
373
<p>
246
374
Caching is in place; the results of decryption and verification are
247
375
(subject to configuration) saved in ~/.topal/cache.  The results of
248
376
caching mean that you won't be repeatedly asked for your passphrase,
249
377
at the expense of storing decrypts in the clear.
250
 
<P>
251
 
Be warned: Topal often invokes `less' to view something.  So you'll
252
 
need to use `q' to get out of it.  `Metamail' is called for anything
 
378
</p>
 
379
 
 
380
<p>
 
381
Be warned: Topal often invokes <tt>less</tt> to view something.  So you'll
 
382
need to use <tt>q</tt> to get out of it.  <tt>metamail</tt> is called for anything
253
383
after MIME processing.
254
 
<P>
255
 
A new option (for version 0.7.8) called `inline-separate-output'
 
384
</p>
 
385
 
 
386
<p>
 
387
A new option (for version 0.7.8) called <tt>inline-separate-output</tt>
256
388
concerns inlined (i.e., not MIME) messages.  If the option is on, then
257
 
the Topal/GnuPG output will be shown to you by less.  Then the
258
 
decrypted or verified output will be handed back to Pine.  This is the
 
389
the Topal/GnuPG output will be shown to you by <tt>less</tt>.  Then the
 
390
decrypted or verified output will be handed back to Pine/Alpine.  This is the
259
391
way to approach attachments.  However, you will normally want to keep
260
392
this option off, because if you're reading (for example) BugTraq
261
 
mailings, then it will want you to hit `q' an awful lot....
262
 
 
263
 
<H3><A NAME="sending">Sending</A></H3>
264
 
 
 
393
mailings, then it will want you to hit <tt>q</tt> an awful lot....
 
394
</p>
 
395
 
 
396
<h3><a name="sending">Sending</a></h3>
 
397
 
 
398
<p>
265
399
If you choose the `Topal' filter when sending, you will be offered a
266
400
menu
267
 
<PRE>
 
401
</p>
 
402
<pre>
268
403
  (lkr) List/edit current recipient keys   (@) Add own key 
269
404
  (n) Pass through unchanged  (o) Configuration  (q) Abort
270
405
  Execute GPG: (e) Encrypt (s) Sign-encrypt (c) Clearsign      
271
 
</PRE>
 
406
</pre>
 
407
<p>
272
408
Above that, it will indicate picking up keys for each recipient email
273
409
address.  It will also add a key `for self'.
274
 
<P>
275
 
`Abort' tells Pine you don't want Topal to process the email anymore.
276
 
<P>
277
 
`Pass through unchanged' does nothing to the message (except for forcing the
278
 
content-type to be text/plain when invoked with -sendmime; this is useful for dealing with an
279
 
obscure bug in Pine 4.44).  This means that you can always have Topal
280
 
invoked for sending.
281
 
<P>
 
410
</p>
 
411
 
 
412
<p>
 
413
`Abort' tells Pine/Alpine you don't want Topal to process the email anymore.
 
414
</p>
 
415
 
 
416
<p>
 
417
`Pass through unchanged' does nothing to the message.  This means that
 
418
you can always have Topal invoked for sending.
 
419
</p>
 
420
 
 
421
<p>
282
422
`Add own key' adds an `encrypt to self' key.  (It is added by default,
283
423
but if you remove it, this is a quick way to restore it.)
284
 
<P>
 
424
</p>
 
425
 
 
426
<p>
285
427
The three `execute GPG' options use the current settings and execute
286
428
GPG.  You will be asked to confirm the command-line, and after
287
 
processing, less is invoked to visually check that the desired result
 
429
processing, <tt>less</tt> is invoked to visually check that the desired result
288
430
has been achieved.  Again, a confirmation is asked for.
289
 
<P>
 
431
</p>
 
432
 
 
433
<p>
290
434
If -sendmime was used, then a menu will ask 
291
 
<PRE>
 
435
</p>
 
436
<pre>
292
437
  (p) Inline plain text  (a) application/pgp  (m) multipart/* 
293
438
  (q) Abort  
294
 
</PRE>
 
439
</pre>
 
440
<p>
295
441
offer a choice of three MIME types.  Don't use (a) unless you really
296
442
know what you're doing.  If you are signing and encrypting, a further
297
 
choice, <PRE>(e) multipart/* encapsulated</PRE> will be offered.
 
443
choice,</p><pre>(e) multipart/* encapsulated</pre><p>will be offered.
298
444
This encapsulates a MIME signed message inside an encrypted message.
299
445
Otherwise, we do both operations at once.  (If you choose `clearsign'
300
446
and `multipart/*', then all trailing blank lines will be deleted.
301
 
Note also that Pine appears to delete trailing whitespace in trailing
 
447
Note also that Pine/Alpine appears to delete trailing whitespace in trailing
302
448
blank lines.)
303
 
<P>
 
449
</p>
 
450
 
 
451
<p>
304
452
`Configuration' offers the same menu that is available from the
305
 
-config option.
306
 
<P>
 
453
<tt>-config</tt> option.
 
454
</p>
 
455
 
 
456
<p>
307
457
`List current recipient keys' offers a list of recipients:
308
 
<PRE>
 
458
</p>
 
459
<pre>
309
460
  Select key, or (dq) to quit and return to main send menu
310
461
  or (s) to select a key after searching in the main keyring
311
462
  or (ak) to add keys from the main keyring (not recommended, use `s')
312
 
  Displaying choices 1 to 2 of 1 to 2    (&lt;,) page up   (&gt;.) page down 
313
 
   1 - Details: pub  1024D/50973B91 2000-12-19 Dr Phil Brooke (at home) &lt;P.J.Broo
314
 
   2 - Details: pub  1024D/16BE903A 2001-02-25 Malcolm Gray &lt;malcolm.gray@jobstre
315
 
</PRE>
 
463
  Displaying choices 1 to 2 of 1 to 2    (<,) page up   (>.) page down 
 
464
   1 - 50973B91 2000-12-19 Dr Phil Brooke (at home) <P.J.Brooke@bcs.org.uk>    
 
465
   2 - 9DAF9B5C 2005-10-21 Dr Phil Brooke <pjb@scm.tees.ac.uk>                 
 
466
</pre>
 
467
<p>
316
468
`Quit and return to main send menu' sends you back to the first menu. 
317
 
<P>
 
469
</p>
 
470
 
 
471
<p>
318
472
`Add key from main keyring' prompts you for a search pattern.  It will
319
 
do a general search on your GPG keyring.  Beware of just pressing
320
 
enter - it will select <EM>all</EM> keys on your keyring.
321
 
<P>
 
473
do a general search on your GPG keyring <em>and add</em> all matching keys.  Beware of just pressing
 
474
enter - it will select <em>all</em> keys on your keyring.
 
475
</p>
 
476
 
 
477
<p>
322
478
A better alternative is to use the `select after search' option.  This
323
479
also does a search on your GPG keyring, but then you must select
324
480
one key to be added to your list of recipients.
325
 
<P>
 
481
</p>
 
482
 
 
483
<p>
326
484
Selecting a key will offer a third menu (a similar menu is offered
327
485
when selecting a single key):
328
 
<PRE>
329
 
  Key: Details: pub  1024D/50973B91 2000-12-19 Dr Phil Brooke (at home) &lt;P.J.Broo
 
486
</p>
 
487
<pre>
 
488
  Key: 50973B91 2000-12-19 Dr Phil Brooke (at home) <P.J.Brooke@bcs.org.uk>    
330
489
  (d) Display details of key with less, (v) Verbosely
331
490
  (r) Remove key from list   (kql) Return to key list  
332
 
</PRE>
 
491
</pre>
 
492
<p>
333
493
`Return to key list' takes you back to the second menu.  
334
 
<P>
 
494
</p>
 
495
 
 
496
<p>
335
497
`Display details of key (less)' simply uses GPG to list the
336
 
key details via less.  You'll need to use `q' to get out of less.
337
 
<P>
 
498
key details via <tt>less</tt>.  You'll need to use `q' to get out of <tt>less</tt>.
 
499
</p>
 
500
 
 
501
<p>
338
502
`Verbose details of key (less)' pipes verbose output from GPG for this
339
 
key into gpg.  You'll need to use `q' to get out of less.
340
 
<P>
 
503
key into gpg.  You'll need to use `q' to get out of <tt>less</tt>.
 
504
</p>
 
505
 
 
506
<p>
341
507
`Remove key from list' removes the key from this recipient list.
342
 
 
343
 
 
344
 
<H2><A NAME="nonpine">Command-line usage</A></H2>
345
 
 
 
508
</p>
 
509
 
 
510
<h3><a name="nonpine">Command-line usage</a></h3>
 
511
 
 
512
<p>
346
513
If you invoke Topal on the command-line with a filename as an
347
514
argument, it will offer the sending functions on that file.  It
348
515
doesn't actually send anything: instead it allows you to encrypt,
349
516
sign, etc. the message.  You have a choice of overwriting or
350
517
preserving the original file (this bit is case-sensitive).
351
 
<P>
 
518
</p>
 
519
 
 
520
<p>
352
521
The main purpose of this mode is for encrypting or signing attachments
353
 
before they are attached to the message in Pine.  Beware that Pine
 
522
before they are attached to the message in Pine/Alpine.  Beware that Pine/Alpine
354
523
does not feed the attachments to a sending filter.
355
 
<P>
 
524
</p>
 
525
 
 
526
<p>
356
527
MIME functions are not available in this mode: it makes no sense.
357
 
 
358
 
<HR>
359
 
 
360
 
<H2><A NAME="additional-programs">Additional Modes</A></H2>
361
 
 
362
 
Two scripts used to be included with topal: topal-fix-email and
363
 
topal-fix-folder.  They have been replaced by the <TT>--fix-email</TT>
364
 
and <TT>--fix-folder</TT> command-line options to the main binary.
365
 
<P>
366
 
<TT>topal --fix-email</TT> modifies any email that is (at the top level) a
367
 
multipart/signed or multipart/encrypted message.  It creates a
368
 
multipart/alternative message.  The revised message contains the first
369
 
part of the original message as one alternative, then the entire
370
 
original message as an alternative part.  Pine can cope with invoking
371
 
Topal on the (original) subpart.  Confused?  (It probably isn't clever
372
 
for /encrypted mail, but at least Topal can get at it.)
373
 
<P>
 
528
</p>
 
529
 
 
530
<h3><a name="remote">Remote and server mode</a></h3>
 
531
 
 
532
<p>
 
533
Suppose you are reading your email on a remote host via ssh (as I
 
534
often do).  You now want to compose an email and sign it, but your
 
535
secret key is only accessible on the local computer.  Topal has
 
536
rudimentary support for this (primarily to support my style of
 
537
working).  This comes in two parts: a `server' mode to run on the local
 
538
computer (with access to the secret key) and a remote option in the
 
539
sending menu.
 
540
</p>
 
541
 
 
542
<p>
 
543
The server mode (on the local host) is started by running <tt>topal
 
544
-server</tt>.  This is where GPG requests for signing are made.
 
545
</p>
 
546
 
 
547
<p>
 
548
When sending, you can choose `remote'.  This prompts for the host to
 
549
connect to using ssh/scp: this host should be running the `server'.
 
550
The files are sent to the local server, processed by the server, then
 
551
the results are copied back.  ssh and scp are both used: because
 
552
they're used repeatedly, you might want to use key-based
 
553
authentication and have the key added to a current ssh-agent.
 
554
</p>
 
555
 
 
556
<p>
 
557
There isn't a remote mode for receiving: my approach is to use unison
 
558
(or some other file synchroniser or a simple scp) to move the email(s)
 
559
concerned, then view them on the local computer.
 
560
</p>
 
561
 
 
562
<hr/>
 
563
 
 
564
<h2><a name="fix-multipart">Fixing multipart emails</a></h2>
 
565
 
 
566
<p>
 
567
Two scripts used to be included with topal (long ago):
 
568
<tt>topal-fix-email</tt> and <tt>topal-fix-folder</tt>.  They have
 
569
been replaced by the <tt>--fix-email</tt> and <tt>--fix-folder</tt>
 
570
command-line options to the main binary.
 
571
</p>
 
572
 
 
573
<p>
 
574
<tt>topal --fix-email</tt> modifies any email that is (at the top
 
575
level) a multipart/signed or multipart/encrypted message.  It creates
 
576
a multipart/misc message instead: this revised message is simply a
 
577
wrapper version of the original message so that Pine/Alpine can pass the
 
578
signed or encrypted part to Topal.  
 
579
</p>
 
580
 
 
581
<p>
374
582
Usage: 
375
 
<DL>
376
 
<DT><TT>topal --fix-folder</TT> &lt;folder&gt; ...</DT> <DD>This fixes the old
377
 
email folders you may have.</DD>
378
 
<DT><TT>topal --fix-email</TT></DT> <DD>Takes no arguments; it accepts a single
 
583
</p>
 
584
<dl>
 
585
<dt><tt>topal --fix-folder</tt> &lt;folder&gt; ...</dt> <dd>This fixes the old
 
586
email folders you may have.</dd>
 
587
<dt><tt>topal --fix-email</tt></dt> <dd>Takes no arguments; it accepts a single
379
588
email on stdin.  Ideally, it should be invoked by procmail (see the
380
 
<A HREF="#procmail-config">configuration section</A> above).
381
 
</DL>
382
 
<P>
383
 
<TT>topal --fix-email</TT> has a simpler mode (<TT>--simple</TT>) where it
 
589
<a href="#procmail-config">configuration section</a> above).</dd>
 
590
</dl>
 
591
 
 
592
<p>
 
593
<tt>topal --fix-email</tt> has a simpler mode (<tt>--simple</tt>) where it
384
594
pretends that there are two MIME content types:
385
595
`application/x-topal-encrypted' and `application/x-topal-signed'.  You
386
596
might prefer using this.
387
 
 
388
 
<HR>
389
 
 
390
 
<H2><A NAME="notes">Notes</A></H2>
391
 
 
392
 
<H3><A NAME="pinehack">The Pine patch, and sending other attachments</A></H3>
393
 
 
394
 
What does the patch to Pine do?  It removes some of the safety
 
597
</p>
 
598
 
 
599
<p>Why do we need this?  If we just set the <tt>.mailcap</tt> file
 
600
for, say, multipart/signed, then Alpine (at least version 1.00) is
 
601
unable to handle a top-level multipart/signed email: an error message
 
602
starting `Can't find body for requested message' is seen.  But
 
603
multipart/signed inside a multipart/mixed (or multipart/alternative,
 
604
etc.) can be successfully handed-off to Topal.</p>
 
605
 
 
606
<p>Replying to such messages is a pain: you'll have to save off the
 
607
actual message and read it in.  Suggestions on fixing this are welcome....</p> 
 
608
 
 
609
<p>See <tt>Workaround.Fix_Email</tt> in the sources for more details.</p>
 
610
 
 
611
<hr/>
 
612
 
 
613
<h2><a name="notes">Notes</a></h2>
 
614
 
 
615
<h3><a name="pinehack">The Pine/Alpine patch, and sending other attachments</a></h3>
 
616
 
 
617
<p>
 
618
What does the patch to Pine/Alpine do?  It removes some of the safety
395
619
checking when changing the content-type (_MIMETYPE_) in a filter.
396
620
Normally, if the returned content-type is not text/*, then the entire
397
621
content-type is dropped.
398
 
<P>
 
622
</p>
 
623
 
 
624
<p>
399
625
The patch instead adds a flag, `topal_hack', and sets this if the
400
626
returned content-type is not text.  From time-to-time, we 
401
627
pretend that the body is normal text.  We take a little care to check
402
628
if this message is already a multipart message, so hopefully, the normal
403
629
sending of attachments still works.
404
 
 
405
 
<H3><A NAME="keyids">Key IDs</A></H3>
406
 
 
 
630
</p>
 
631
 
 
632
<h3><a name="keyids">Key IDs and keylists</a></h3>
 
633
 
 
634
<p>
407
635
Topal internally lists keys by their fingerprint.  It uses GPG to look
408
636
up key fingerprints by using whatever GPG can cope with.
409
 
<P>
 
637
</p>
 
638
 
 
639
<p>
410
640
Duplicate keys are silently suppressed.  Removing a key only removes
411
641
one instance, if somehow you've coerced Topal to list duplicates
412
642
(which is quite easy, since adding a key with its short key ID, and
413
643
the same key with its fingerprint will add two identical keys).
414
 
<P>
 
644
</p>
 
645
 
 
646
<p>
415
647
The way that Topal chooses the keys is as follows:
416
 
<P>
417
 
<UL>
418
 
<LI>  For each recipient email address (supplied by Pine)
419
 
<OL>
420
 
<LI>    For each matching line in keylist, use the key ID to get a fingerprint, and add the key to the list.
421
 
<LI>    In there are no matching lines in keylist, try to get a
 
648
</p>
 
649
<ul>
 
650
<li>  For each recipient email address (supplied by Pine)
 
651
<ol>
 
652
<li>    For each matching line in keylist, use the key ID to get a fingerprint, and add the key to the list.</li>
 
653
<li>    In there are no matching lines in keylist, try to get a
422
654
fingerprint via just that email address (but exclude `xk'
423
 
configuration entries).
424
 
</OL>
425
 
</UL>
426
 
<P>
 
655
configuration entries).</li>
 
656
</ol></li>
 
657
</ul>
 
658
 
 
659
<p>
427
660
The keylist is a way to say, `for this particular email address, use
428
 
this particular key'.
429
 
 
430
 
 
431
 
<H3><A NAME="errors">Errors</A></H3>
432
 
 
 
661
this particular key'.  In your <tt>config</tt> file, include lines
 
662
such as
 
663
</p>
 
664
<pre>
 
665
ake=50973B91,philb@soc.plym.ac.uk
 
666
ake=50973B91,pjb@lothlann.freeserve.co.uk
 
667
</pre>
 
668
<p>These mean `use key 50973B91 for the the given email addresses.
 
669
Similarly,</p>
 
670
<pre>
 
671
xk=50973B91
 
672
</pre>
 
673
<p>means `don't use key 50973B91'.  There are also similar
 
674
<tt>sake</tt> and <tt>sxk</tt> options for the secret key selection
 
675
(via <tt>--read-from</tt>) (although the testing of the secret key
 
676
listings is less thorough so far).</p>
 
677
 
 
678
 
 
679
<h3><a name="errors">Errors</a></h3>
 
680
 
 
681
<p>
433
682
Bad things happening should result in Topal setting its exit status to
434
683
`failed', so Pine should detect this and not send your email.
435
 
<P>
 
684
</p>
 
685
 
 
686
<p>
436
687
Bug reports are welcome: send them by email to me (contact details below).
437
 
 
438
 
<H3><A NAME="decrypt-attachments">Decrypting attachments</A></H3>
439
 
 
 
688
</p>
 
689
 
 
690
<h3><a name="decrypt-attachments">Decrypting attachments</a></h3>
 
691
 
 
692
<p>
440
693
If an attachment is a plaintext PGP ASCII-armoured message, then Topal
441
694
will be invoked by Pine.  You probably want to say `no' when asked
442
695
here (beware of the configuration options here).  Otherwise, you'll
443
696
get a decrypted file with the original attachment filename, plus the
444
697
various Topal headers.
445
 
 
446
 
<H3><A NAME="cleaning-cache">Cleaning up the cache</A></H3>
447
 
 
 
698
</p>
 
699
 
 
700
<h3><a name="locale-problems">Locale problems</a></h3>
 
701
 
 
702
<p>
 
703
GPG does not do any encoding of input data.  This means that the
 
704
encoding is dependent on Pine/Alpine and Topal.  If a message is sent
 
705
with one encoding and received by a user running in a different
 
706
locale, then we might end up with a good message not verifying (i.e.,
 
707
bad signature).  
 
708
</p>
 
709
 
 
710
<p>
 
711
I currently have no way to automatically fix this.  However, the
 
712
<tt>--ask-charset</tt> option will ask during inline
 
713
decryption/verification if you want to change the encoding.  If you
 
714
know that the message was written by a UTF-8 user (and you're in a
 
715
different locale), this might help.  (This only happens if a bad
 
716
signature is returned.)
 
717
</p>
 
718
 
 
719
<p>
 
720
I know it's a kludge.  I'd be interested to hear success and failure
 
721
reports.
 
722
</p>
 
723
 
 
724
<h3><a name="cleaning-cache">Cleaning up the cache</a></h3>
 
725
 
 
726
<p>
448
727
You might want to run something like
449
 
<PRE>
 
728
</p>
 
729
<pre>
450
730
find ${HOME}/.topal/cache -mtime +7 | xargs rm
451
 
</PRE>
 
731
</pre>
 
732
<p>
452
733
to remove all the cache files that are a bit old (in this example, 7
453
734
days old or older).
454
 
 
455
 
<H3><A NAME="new-releases">New releases</A></H3>
456
 
 
457
 
To be notified of new releases of Topal, send an email to me....
458
 
 
459
 
<HR>
460
 
 
461
 
<H2><A NAME="author">Author</A></H2>
462
 
 
 
735
</p>
 
736
 
 
737
<h3><a name="remote-notes">Remote and server mode</a></h3>
 
738
 
 
739
<p>
 
740
When remote is invoked in a sending menu:
 
741
</p>
 
742
<ul>
 
743
<li>The host has to be chosen for ssh/scp.</li>
 
744
<li>Because topal might be outside the normal path, you'll be asked
 
745
for that too.</li>
 
746
<li>The sender scp's the relevant files into <tt>.topal/server</tt>.</li>
 
747
<li>The sender calls <tt>ssh (server) -remotesend ...</tt> or <tt>ssh
 
748
(server) -remotesendmime ...</tt>.</li>
 
749
<li>The invocation of <tt>-remotesend</tt> or <tt>-remotesendmime</tt>
 
750
triggers the server to run a new instance of Topal on the local
 
751
computer.</li>
 
752
<li>When that instance is finished, the relevant files are copied
 
753
back, along with the return value.</li>
 
754
</ul>
 
755
 
 
756
<h3><a name="new-releases">New releases</a></h3>
 
757
 
 
758
<p>To be notified of new releases of Topal, send an email to me.</p>
 
759
 
 
760
<h3><a name="release-numbering">Release numbering</a></h3>
 
761
 
 
762
<p>The old release numbering was making less sense to me.  New
 
763
releases are simple integers.  In the event that an earlier release is
 
764
modified, I'll then add extra components to the release number.</p>
 
765
 
 
766
<hr/>
 
767
 
 
768
<h2><a name="author">Author</a></h2>
 
769
 
 
770
<p>
463
771
Phil Brooke wrote this, partially out of boredom, but mostly because
464
772
he wanted a GPG/Pine add-on to do exactly what he wants.  There are
465
773
many similar programs. 
466
 
<P>
 
774
</p>
 
775
 
 
776
<p>
467
777
If you like this program, please tell me.  If you'd like it better
468
778
with changes, please tell me what changes you want.  If particular
469
 
items on the <A HREF="#todo">`To do' list</A> are important to you, let me know.  In
 
779
items on the <a href="#todo">`To do' list</a> are important to you, let me know.  In
470
780
particular, if you find bugs, feel free to tell me the details by
471
781
email.
472
 
<P>
473
 
This package is released under the GPL: see the file <A HREF="COPYING">COPYING</A>.
474
 
<P>
 
782
</p>
 
783
 
 
784
<p>
 
785
This package is released under the GPL: see the file <a href="COPYING">COPYING</a>.
 
786
</p>
 
787
 
 
788
<p>
475
789
I can be emailed on 
476
 
<A HREF="mailto:pjb@lothlann.freeserve.co.uk"><TT>pjb@lothlann.freeserve.co.uk</TT></A>
477
 
<P>
 
790
<a href="mailto:pjb@lothlann.freeserve.co.uk"><tt>pjb@lothlann.freeserve.co.uk</tt></a>
 
791
</p>
 
792
 
 
793
<p>
478
794
My key ID is 0x50973B91; the key is available from web pages and public key
479
795
servers.
480
 
<P>
 
796
</p>
 
797
 
 
798
<p>
481
799
If you want to send snailmail to me, email me for my (physical) address.
482
 
 
483
 
<HR>
484
 
 
485
 
<H2><A NAME="license">License</A></H2>
486
 
 
487
 
    This program is free software; you can redistribute it and/or modify
488
 
    it under the terms of the GNU General Public License as published by
489
 
    the Free Software Foundation; either version 2 of the License, or
490
 
    (at your option) any later version.
491
 
    <P>
492
 
    This program is distributed in the hope that it will be useful,
493
 
    but WITHOUT ANY WARRANTY; without even the implied warranty of
494
 
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
495
 
    GNU General Public License for more details.
496
 
    <P>
497
 
    You should have received a copy of the GNU General Public License
498
 
    along with this program; if not, write to the Free Software
499
 
    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
500
 
 
501
 
<HR>
502
 
 
503
 
<H2><A NAME="todo">To do...</A></H2>
504
 
 
505
 
<UL>
506
 
<LI> Fix these known/reported bugs:
507
 
<UL>
508
 
<LI> `Pine indicating both text elements as shown' problem -
509
 
no obvious reason for it, though.
510
 
<LI> Very rarely, some Topal-munged multipart/signed messages aren't
511
 
handed off to Pine.  Not obvious why, yet.
512
 
</UL>
513
 
<LI> Add signal handlers.
514
 
<LI> Catch GPG keyboard interrupt.
515
 
<LI> Should we check that the infile matches the cache file even if
516
 
the MD5 hash matches?  (We'd need to store the infile in the cache as well.)
517
 
<LI> Check through code: all external calls should check return
518
 
values.  General clean-up.
519
 
<LI> Add pkcs7 signatures via SSL?
520
 
<LI> Use mimeconstruct to attach attachments that are then signed/encrypted/whatever?
521
 
<LI> Add interrupt option at very beginning of execution?  (which
522
 
would bring up the configuration menu?)
523
 
<LI> Associate extra options with particular keys?
524
 
<LI> Configuration routine for managing keys/config/keylist?
525
 
<LI> Implement rest of configuration menu.
526
 
<LI> Make a much nicer interface all round....
527
 
<LI> Separate out all the constant strings -- so that we can have internationalization.
528
 
<LI> Context-sensitive help throughout (modify mkhelp to create multiple
529
 
   procedures, or do it by number?); add COPYING option?
530
 
<LI> More receiving/decrypt options: include both plaintext and
531
 
ciphertext.
532
 
<LI> Add periodic cache cleanup when Topal is invoked?
533
 
<LI> Add logging for workaround mode (report time of email processing (include PID); indicate if the file was changed or not)?
534
 
</UL>
535
 
 
536
 
<HR>
537
 
 
538
 
<H2><A NAME="changes">Version History</A></H2>
539
 
 
540
 
Look in <A HREF="release">release</A> for the current release number.
541
 
 
542
 
<DL>
543
 
<DT>06/2001, 0.1</DT> <DD>First alpha release.</DD>
544
 
 
545
 
<DT>06/2001, 0.2</DT> <DD>Minor changes.</DD>
546
 
 
547
 
<DT>06/2001, 0.3</DT> <DD>Major changes to how keys are identified and
548
 
looked up.</DD>
549
 
 
550
 
<DT>06/2001, 0.4</DT> <DD>Adding more customization features.</DD>
551
 
 
552
 
<DT>11/2001, 0.4.4</DT> <DD>Cleaned up some error messages; added -nps
553
 
mode.</DD>
554
 
 
555
 
<DT>11/2001, 0.4.5</DT> <DD>Added `gpg-options' config item with
556
 
default `--no-options'.  (Forgot to add this note as well....)</DD>
557
 
 
558
 
<DT>11/2001, 0.5.0</DT> <DD>Dumped -verify and -decrypt modes in
 
800
</p>
 
801
 
 
802
<hr/>
 
803
 
 
804
<h2><a name="licence">Licence</a></h2>
 
805
 
 
806
<p>
 
807
This program is free software: you can redistribute it and/or modify
 
808
it under the terms of the GNU General Public License version 3 as
 
809
published by the Free Software Foundation.
 
810
</p>
 
811
<p>
 
812
This program is distributed in the hope that it will be useful,
 
813
but WITHOUT ANY WARRANTY; without even the implied warranty of
 
814
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
815
GNU General Public License for more details.
 
816
</p>
 
817
<p>
 
818
You should have received a copy of the GNU General Public License
 
819
along with this program.  If not, see <a href="http://www.gnu.org/licenses/">http://www.gnu.org/licenses/</a>.
 
820
</p>
 
821
 
 
822
<hr/>
 
823
 
 
824
<h2><a name="todo">To do...</a></h2>
 
825
 
 
826
<ul>
 
827
<li> Planned releases:
 
828
<ul>
 
829
<li> Add S/MIME support via gpgsm. </li>
 
830
<li> Improve attachments code (and add some documentation). </li>
 
831
</ul></li>
 
832
<li> Better error handling, particularly when missing dependencies
 
833
such as mime-construct or metamail.</li>
 
834
<li> Add signal handlers.</li>
 
835
<li> Catch GPG keyboard interrupt.</li>
 
836
<li> Should we check that the infile matches the cache file even if
 
837
the MD5 hash matches?  (We'd need to store the infile in the cache as well.)</li>
 
838
<li> Check through code: all external calls should check return
 
839
values.  </li>
 
840
<li> Refactor code.</li>
 
841
<li> Add interrupt option at very beginning of execution?  (which
 
842
would bring up the configuration menu?)</li>
 
843
<li> Associate extra options with particular keys?</li>
 
844
<li> Configuration routine for managing keys/config/keylist?</li>
 
845
<li> Implement rest of configuration menu.</li>
 
846
<li> Make a much nicer interface all round....</li>
 
847
<li> Separate out all the constant strings -- so that we can have internationalization.</li>
 
848
<li> Context-sensitive help throughout (modify mkhelp to create multiple
 
849
   procedures, or do it by number?); add COPYING option?</li>
 
850
<li> More receiving/decrypt options: include both plaintext and
 
851
ciphertext.</li>
 
852
<li> Add periodic cache cleanup when Topal is invoked?</li>
 
853
<li> Add logging for workaround mode (report time of email processing (include PID); indicate if the file was changed or not)?</li>
 
854
</ul>
 
855
 
 
856
<hr/>
 
857
 
 
858
<h2><a name="changes">Version history</a></h2>
 
859
 
 
860
<p>Look in <a href="release">release</a> for the current release number.</p>
 
861
 
 
862
<dl>
 
863
<dt>06/2001, 0.1</dt> <dd>First alpha release.</dd>
 
864
 
 
865
<dt>06/2001, 0.2</dt> <dd>Minor changes.</dd>
 
866
 
 
867
<dt>06/2001, 0.3</dt> <dd>Major changes to how keys are identified and
 
868
looked up.</dd>
 
869
 
 
870
<dt>06/2001, 0.4</dt> <dd>Adding more customization features.</dd>
 
871
 
 
872
<dt>11/2001, 0.4.4</dt> <dd>Cleaned up some error messages; added -nps
 
873
mode.</dd>
 
874
 
 
875
<dt>11/2001, 0.4.5</dt> <dd>Added `gpg-options' config item with
 
876
default `--no-options'.  (Forgot to add this note as well....)</dd>
 
877
 
 
878
<dt>11/2001, 0.5.0</dt> <dd>Dumped -verify and -decrypt modes in
559
879
favour of the multiple-block `-display' mode.  Added -help.  Added
560
880
caching.  Added more switches relating to caching.  Better output
561
 
formatting.</DD>
562
 
 
563
 
<DT>11/2001, 0.5.1</DT> <DD>Improved menus.  Tidied up some of the
564
 
interface.  Added -s, which does the same as -nps.</DD>
565
 
 
566
 
<DT>12/2001, 0.5.2</DT> <DD>Tidied disclaimer.  Added synonyms for
 
881
formatting.</dd>
 
882
 
 
883
<dt>11/2001, 0.5.1</dt> <dd>Improved menus.  Tidied up some of the
 
884
interface.  Added -s, which does the same as -nps.</dd>
 
885
 
 
886
<dt>12/2001, 0.5.2</dt> <dd>Tidied disclaimer.  Added synonyms for
567
887
-help (-h, -?, --help, --h) Cleaned up menus; keypresses aren't echoed
568
 
any longer.</DD>
 
888
any longer.</dd>
569
889
 
570
 
<DT>12/2001, 0.5.3</DT> <DD>Altered packaging to include version in
 
890
<dt>12/2001, 0.5.3</dt> <dd>Altered packaging to include version in
571
891
directory name.  Changed names of some -clear options to be a bit more
572
892
sensible.  Changing config settings method (big change).  Making -s
573
893
the default operation.  Some rearrangement of code, constants.  Some
574
894
configuration editing possible via Topal.  Send has access to
575
 
configuration menu.  </DD>
576
 
 
577
 
<DT>12/2001, 0.5.4</DT> <DD>Bug fix; one-off error in the sending
578
 
menus.</DD>
579
 
 
580
 
<DT>12/2001, 0.5.5</DT> <DD>Removed redundant examples directory.
 
895
configuration menu.  </dd>
 
896
 
 
897
<dt>12/2001, 0.5.4</dt> <dd>Bug fix; one-off error in the sending
 
898
menus.</dd>
 
899
 
 
900
<dt>12/2001, 0.5.5</dt> <dd>Removed redundant examples directory.
581
901
Changed over to HTML documentation.  Tweaked the RELEASE stuff.  Use
582
902
space instead of enter when waiting to continue: this looks forward to
583
903
offering a help option at every prompt.  The receive/blocks
584
904
stuff now uses an expanding array.  The GPG return value is checked
585
905
when receiving: if it's bad, then some bits of the output are omitted;
586
906
the cache file is not written.  The date bit of Topal output moved
587
 
onto the previous line (echo -n blah blah).</DD>
 
907
onto the previous line (echo -n blah blah).</dd>
588
908
 
589
 
<DT>12/2001, 0.5.6</DT> <DD>Adding installation instructions.  Using
 
909
<dt>12/2001, 0.5.6</dt> <dd>Adding installation instructions.  Using
590
910
tee and PIPESTATUS to get stderr on screen during receiving while also
591
911
saving that output and recording gpg's exit status.  Changed RELEASE
592
912
filename to release.  Tidied up the Makefile.  Invalid passphrase
597
917
search excludes keys in XK list.  Added key search/selection menu
598
918
choice - much nicer to use than the add menu.  More configuration
599
919
stuff added (still more to do, although the config file can always be
600
 
used).  Partial documentation update.</DD>
601
 
 
602
 
<DT>2/2002, 0.5.7</DT> <DD>Adding limited RFC2015/MIME decoding of
603
 
multipart email.</DD>
604
 
 
605
 
<DT>2/2002, 0.5.8</DT> <DD>Adding mime-construct to configuration in
 
920
used).  Partial documentation update.</dd>
 
921
 
 
922
<dt>2/2002, 0.5.7</dt> <dd>Adding limited RFC2015/MIME decoding of
 
923
multipart email.</dd>
 
924
 
 
925
<dt>2/2002, 0.5.8</dt> <dd>Adding mime-construct to configuration in
606
926
expectation of more RFC2015 features.  Put test for the config file
607
927
existing before actually attempting to read it (oops).  Added -O2
608
928
-Wall and the TOPALDEBUG variable for compiling. Put up WWW page via
609
929
own Freeserve site.  Announcing via Freshmeat.  Automating output WWW
610
 
site generation (all the grunge in the Makefile).
 
930
site generation (all the grunge in the Makefile).</dd>
611
931
 
612
 
<DT>3/2002, 0.6.0</DT> <DD>Distribution uses a gzip'd binary now....
 
932
<dt>3/2002, 0.6.0</dt> <dd>Distribution uses a gzip'd binary now....
613
933
Added a pre-built binary that is statically linked against the GNAT
614
934
stuff so that people don't need to acquire GNAT first (this, I
615
 
believe, complies with the GNAT licence).  <P> Added the scripts
 
935
believe, complies with the GNAT licence).  <br/> Added the scripts
616
936
topal-fix-email and topal-fix-folder.  This makes it a lot easier to
617
937
work with other people's multipart/signed or /encrypted email.
618
 
Procmail recipe added to this README.<P>Added display of
 
938
Procmail recipe added to this README.<br/>Added display of
619
939
application/pgp messages.  Including the text of one of these in a
620
940
reply might be difficult, but then, it was difficult without topal's
621
 
mangling.  At least they can be verified and read now.<P>-sendmime
622
 
option added. Hack needed (in topal-pine-patch [now pine-4.44-patch])
 
941
mangling.  At least they can be verified and read now.<br/>-sendmime
 
942
option added. Hack needed (in topal-pine-patch [now pine-4.44.patch])
623
943
to allow non-text/blah content-types in Pine.  RFC2015 send and
624
944
received done (including micalg detection when sending clearsigned
625
945
messages: list used from RFC3156.).  Ditto for application/pgp, but
626
946
I'm not sure of some of the parameters, since I've only ever seen
627
 
signed emails of this form.<P>Removed some of the waits for execution,
 
947
signed emails of this form.<br/>Removed some of the waits for execution,
628
948
since it seems reliable.  Added error checking on return value of GPG
629
 
in sends.</DD>
 
949
in sends.</dd>
630
950
 
631
 
<DT>3/2002, 0.6.1</DT> <DD>The Content-Type for MIME sending is
 
951
<dt>3/2002, 0.6.1</dt> <dd>The Content-Type for MIME sending is
632
952
displayed on the screen using `cat' rather than `less', which was
633
 
getting to be annoying.<P>Two changes that are related to how I
 
953
getting to be annoying.<br/>Two changes that are related to how I
634
954
manage the source code: Slight tweak to makefile for keeping track
635
955
of RCS files; and using rcs -n&lt;symbolic-name&gt; to tag the
636
 
released files.</DD>
 
956
released files.</dd>
637
957
 
638
 
<DT>3/2002, 0.6.2</DT> <DD>MIME clear-signed messages: trailing blank
 
958
<dt>3/2002, 0.6.2</dt> <dd>MIME clear-signed messages: trailing blank
639
959
lines are now deleted before signing (this would cause BAD signature
640
960
when verifying on some other MTAs).  Added remarks to documentation
641
 
about the patch to Pine and attachments.</DD>
 
961
about the patch to Pine and attachments.</dd>
642
962
 
643
 
<DT>4/2002, 0.6.3</DT> <DD>RFC1847 multipart encapsulation added.
 
963
<dt>4/2002, 0.6.3</dt> <dd>RFC1847 multipart encapsulation added.
644
964
(See section 6.1 of RFC3156.)  Cleaned up related receiving/caching
645
 
behaviour.<P>Another MIME clear-signed messages bugfix.  This one
646
 
sorts out line-end conventions correctly.  <P>New patch for Pine: this
 
965
behaviour.<br/>Another MIME clear-signed messages bugfix.  This one
 
966
sorts out line-end conventions correctly.  <br/>New patch for Pine: this
647
967
stops a SEGFAULT when using RFC2015 stuff and other attachments at the
648
 
same time.<P>Updated documentation; added man pages for the two scripts.</DD>
 
968
same time.<br/>Updated documentation; added man pages for the two scripts.</dd>
649
969
 
650
 
<DT>4/2002, 0.6.4</DT> <DD>New patch for Pine.  Adds a workaround for
 
970
<dt>4/2002, 0.6.4</dt> <dd>New patch for Pine.  Adds a workaround for
651
971
the problem where some versions of MS Exchange would silently lose
652
972
inbound MIME clearsigned email.  It turns out that a slight formatting
653
 
change stops the problem.</DD>
 
973
change stops the problem.</dd>
654
974
 
655
 
<DT>5/2002, 6/2002; 0.6.5, 0.6.6, 0.6.7, 0.6.8</DT> <DD>Adding more debugging,
 
975
<dt>5/2002, 6/2002; 0.6.5, 0.6.6, 0.6.7, 0.6.8</dt> <dd>Adding more debugging,
656
976
mostly to the menus code.  Used for tracking down a nasty problem
657
977
causing exceptions.  Many thanks to Felix Madlener for pointing this
658
 
out and testing the revised code.</DD>
 
978
out and testing the revised code.</dd>
659
979
 
660
 
<DT>7/2002, 0.6.9</DT><DD>Renamed the Pine patch for when new versions
 
980
<dt>7/2002, 0.6.9</dt><dd>Renamed the Pine patch for when new versions
661
981
come out.  (It's still the same patch as for Topal 0.6.4.)  Added trap
662
982
for non-existent file when using `-s'.  Cache directory as well as
663
983
.topal directory is also chmod'd to 700.  Added README.txt to package
664
984
file (even though it's generated from the .html) so that those who
665
 
just want to `less' it (instead of firing up a HTML reader) can do so.</DD>
 
985
just want to `less' it (instead of firing up a HTML reader) can do so.</dd>
666
986
 
667
 
<DT>8/2002, 0.7.0</DT><DD>Changed email address in man page.  Lots more
 
987
<dt>8/2002, 0.7.0</dt><dd>Changed email address in man page.  Lots more
668
988
exception handling for extra info when something goes wrong.  Moderate
669
989
code reorganisation: mostly splitting blocks of code out for future
670
990
work.  Fixed `bug' (feature?) where send fails if a public key is
679
999
we shouldn't actually get an output file from GPG (since we're only
680
1000
verifying one part with the other); we put a vague warning if this
681
1001
happens, and trap when reading the cache.  Added content-type to
682
 
plaintext for MIME/encrypted.  Documentation update.</DD>
683
 
 
684
 
<DT>8/2002, 0.7.1</DT><DD>Fixed minor bug with inverted return code
685
 
(`-s' trap).  Doc update.</DD>
686
 
 
687
 
<DT>9/2002, 0.7.2</DT><DD>Fixed minor bug in key list handling code
688
 
(dealing with key selection).</DD>
689
 
 
690
 
<DT>9/2002; 0.7.3, 0.7.4 (BETA)</DT><DD>Disposed of the dependency on a shell by
 
1002
plaintext for MIME/encrypted.  Documentation update.</dd>
 
1003
 
 
1004
<dt>8/2002, 0.7.1</dt><dd>Fixed minor bug with inverted return code
 
1005
(`-s' trap).  Doc update.</dd>
 
1006
 
 
1007
<dt>9/2002, 0.7.2</dt><dd>Fixed minor bug in key list handling code
 
1008
(dealing with key selection).</dd>
 
1009
 
 
1010
<dt>9/2002; 0.7.3, 0.7.4 (BETA)</dt><dd>Disposed of the dependency on a shell by
691
1011
introducing Ada bindings for fork/exec/dup/pipe/glob, etc..  Several
692
1012
external binaries are no longer needed (cat, echo).  Most return codes
693
1013
are now properly checked (although still need to do a better audit).
694
1014
Followed Eduardo Chappa's advice and changed Pine patch version
695
1015
letter.  Miscellaneous cleanups and fixes.  Many thanks to Peter
696
 
Losher for giving me the incentive to sort out the external calls.</DD>
 
1016
Losher for giving me the incentive to sort out the external calls.</dd>
697
1017
 
698
 
<DT>9/2002; 0.7.5 (BETA)</DT><DD>Tidying up structure of external calls, and
 
1018
<dt>9/2002; 0.7.5 (BETA)</dt><dd>Tidying up structure of external calls, and
699
1019
how the various messages are built up and torn down.  Changed the lynx
700
1020
switches at the suggestion of Felix Madlener (many thanks!).  When
701
1021
receiving MIME encrypted attachments, the output is not included in
702
 
the Topal output, but only in the metamail invocation.</DD>
 
1022
the Topal output, but only in the metamail invocation.</dd>
703
1023
 
704
 
<DT>10/2002; 0.7.6 (BETA)</DT><DD>Explicitly noted which versions are
 
1024
<dt>10/2002; 0.7.6 (BETA)</dt><dd>Explicitly noted which versions are
705
1025
not intended for general use (beta versions).  Rearranged command line
706
 
parsing for more flexibility in future.</DD>
 
1026
parsing for more flexibility in future.</dd>
707
1027
 
708
 
<DT>10/2002; 0.7.7 (BETA)</DT><DD>Re-implementing topal-fix-email and
 
1028
<dt>10/2002; 0.7.7 (BETA)</dt><dd>Re-implementing topal-fix-email and
709
1029
topal-fix-folder as part of the main topal binary.  This removes the
710
1030
(script) dependency on munpack, but adds formail and diff to the main
711
1031
binary.  Fixed some missing bits for particular binaries in
717
1037
Topal filter.  This might also fix the minor problem with text/html
718
1038
occasionally being sent when it shouldn't be....)  Fixed bug where
719
1039
MIME decrypt failure would still cause metamail to be invoked, but
720
 
that's a waste of time.</DD>
 
1040
that's a waste of time.</dd>
721
1041
 
722
 
<DT>10/2002; 0.7.8</DT><DD>Clearing out case statements with `when
 
1042
<dt>10/2002; 0.7.8</dt><dd>Clearing out case statements with `when
723
1043
others'.  Tidying up sending.adb.  Fixed problem in MIME output where
724
1044
a leading blank line was added.  Finally implemented `topal
725
1045
--fix-folders' functionality added.  No longer need the two old
727
1047
`inline-separate-output' option: this effectively turns off the GnuPG/Topal
728
1048
wrappers in output.  However, the side-effect is that the cache must
729
1049
be cleared when upgrading to this version.
730
 
</DD>
 
1050
</dd>
731
1051
 
732
 
<DT>11/2002; 0.7.9</DT><DD>Added some infrastructure for
 
1052
<dt>11/2002; 0.7.9</dt><dd>Added some infrastructure for
733
1053
encrypting/signing attachments (but this is nowhere near working yet).
734
1054
Documentation and manpage update (again).  Seems stable, will release.
735
 
</DD>
 
1055
</dd>
736
1056
 
737
 
<DT>2/2003; 0.7.10, 0.7.11</DT><DD>Tweaking distribution pages (mkdistrib).
 
1057
<dt>2/2003; 0.7.10, 0.7.11</dt><dd>Tweaking distribution pages (mkdistrib).
738
1058
Including patches against Pine versions 4.50 and 4.53.  (They're all
739
1059
more-or-less the same patch.  It's pretty
740
1060
easy to apply them against 4.51 and 4.52 if you feel so inclined.)
745
1065
message.  --fix-email workaround also writes out the original input in 
746
1066
the exception handler.  Changed recommended procmail recipe so that
747
1067
Topal's exit code is checked.
748
 
</DD>
 
1068
</dd>
749
1069
 
750
 
<DT>2/2003; 0.7.12</DT><DD>Adding `workaround-error-log' file to
 
1070
<dt>2/2003; 0.7.12</dt><dd>Adding `workaround-error-log' file to
751
1071
.topal. This accepts output from topal --fix-email when it fails to
752
1072
exit cleanly.  Not quite clear if this bit works yet (was tracking
753
1073
down other problem).  It appears that when running without a real
754
1074
terminal, the call to set_echo fails.  Odd.  Nasty workaround
755
1075
implemented.
756
 
</DD>
757
 
 
758
 
<DT>2/2002; 0.7.13</DT><DD>Added missing includes to ada-echo-c.c.
759
 
Perhaps related to issue in the previous entry.</DD>
760
 
 
761
 
<A NAME="last-changes">
762
 
<!-- Don't remove the next line -- or its counterpart later on! -->
763
 
<!-- MRC -->
764
 
 
765
 
<DT>4/2003; 0.7.13b</DT><DD>Bug fix release only - backported from
 
1076
</dd>
 
1077
 
 
1078
<dt>2/2002; 0.7.13</dt><dd>Added missing includes to ada-echo-c.c.
 
1079
Perhaps related to issue in the previous entry.</dd>
 
1080
 
 
1081
<dt>4/2003; 0.7.13b</dt><dd>Bug fix release only - backported from
766
1082
(not-yet-released 0.8.0).  Fixed bug when
767
1083
changing own signing key using the -config option - thanks to Stewart
768
 
James for the bug report.  </DD>
 
1084
James for the bug report.  </dd>
769
1085
 
770
 
<DT>10/2003; 0.7.13.2</DT><DD>Bug fix release only - backported from
 
1086
<dt>10/2003; 0.7.13.2</dt><dd>Bug fix release only - backported from
771
1087
(not-yet-released 0.8.0).  Changed bug fix versioning scheme.
772
1088
Makefile now links properly against static GNAT runtime.  Fixed
773
1089
problem which manifests as: `relocation error: /lib/libreadline.so.4:
774
1090
undefined symbol: BC' (needed instruction to link against ncurses) -
775
1091
thanks to Marty Hoff for the bug report. Added patch against Pine
776
 
version 4.58.</DD>
 
1092
version 4.58.</dd>
777
1093
 
778
 
<DT>10/2003; 0.7.13.3</DT><DD>Now use -gnatwa and -gnato for all Ada
 
1094
<dt>10/2003; 0.7.13.3</dt><dd>Now use -gnatwa and -gnato for all Ada
779
1095
compilation.  It was omitted from the main binary build command
780
 
before.  Fixed all the resulting warnings.</DD>
781
 
 
 
1096
before.  Fixed all the resulting warnings.</dd>
 
1097
 
 
1098
<dt>1/2004; 0.7.13.4</dt><dd>Patched externals calls for errno to
 
1099
prevent (in some cases) warnings from ld.so, and in other cases,
 
1100
failures to build.</dd>
 
1101
 
 
1102
<dt>6/2004; 0.7.13.5</dt><dd>Added patch against Pine version
 
1103
4.60.  Updated some notices.</dd>
 
1104
 
 
1105
<dt>1/4/2005; 0.7.13.6</dt><dd>Calls to the GPG binary now have LANG
 
1106
set to C before exec so that we don't have to worry about different
 
1107
language output in GPG.  Thanks for Joern Brederec for the bug report
 
1108
and suggestion of how to fix it.</dd>
 
1109
 
 
1110
<dt>2005-2007</dt><dd>Four internal development releases junked.</dd>
 
1111
 
 
1112
<dt>8/1/2008; release 55</dt><dd>
 
1113
<tt>--fix-email</tt> now replaces the original message with a
 
1114
multipart/misc wrapper, rather than expanding it into a
 
1115
multipart/alternative message.
 
1116
<br/>
 
1117
Replaced some key selection code.  Hopefully, this reduces the number
 
1118
of locale-dependent and GPG version-specific problems.  Additionally,
 
1119
revoked, disabled and invalid keys are no longer offered; checks are
 
1120
made to ensure that the key is valid for encryption/signing when applicable.
 
1121
<br/>
 
1122
New patch for Alpine 1.00.  Includes configuration setting.
 
1123
<br/>
 
1124
The `pass through unchanged' send option no longer modifies the
 
1125
content-type to text/plain.
 
1126
<br/>
 
1127
Should now build and run on Cygwin.
 
1128
<br/>
 
1129
Licence is now GPL-3.
 
1130
<br/>
 
1131
Attempt to prevent potential memory leak (if running for a long time)
 
1132
by making the implementation of <tt>expanding_array</tt> a controlled type.
 
1133
<br/>
 
1134
Cleaned up Ada source to reduce warnings.
 
1135
<br/>
 
1136
Other minor changes, e.g., better checks on keylists, documentation clean-up.
 
1137
<br/>
 
1138
Changed <a href="#release-numbering">release numbering</a>.
 
1139
<br/>
 
1140
HTML cleaned up and CSS added.</dd>
 
1141
 
 
1142
<dt>8/1/2008; release 56</dt><dd>
 
1143
<tt>--read-from</tt> option added to select different signing keys
 
1144
depending on the From line.  Also added <tt>sake</tt> and <tt>sxk</tt>
 
1145
configurations.
 
1146
<br/>
 
1147
Fixed bug in Keys.Remove.Key (didn't match if the full fingerprint
 
1148
wasn't given).
 
1149
<br/>
 
1150
Command-line parser now accepts 1 or more hyphens for any option.
 
1151
<br/>
 
1152
Improved keylist documentation.
 
1153
<br/>
 
1154
Corrected release date for release 55... oops.
 
1155
</dd>
 
1156
 
 
1157
<dt>8/1/2008; release 57</dt><dd>
 
1158
Initial attempt at supporting attachments within Topal.
 
1159
<br/>
 
1160
Changed MIME boundary detection code (the previous algorithm couldn't
 
1161
cope with multipart included in a signed email).  Please tell me if
 
1162
this breaks your emails....
 
1163
<br/>
 
1164
Bug fix to _INCLUDEALLHDRS_ - it needs to turn the CRLF back into LF
 
1165
or it might chop off some of your message....
 
1166
</dd>
 
1167
<dt>22/6/2008; release 58</dt><dd>
 
1168
UI improvements (count keys in keylist, clearer indication of position
 
1169
in menus).
 
1170
<br/>
 
1171
Added patch for Alpine 1.10.  Renamed all patch files.
 
1172
<br/>
 
1173
Default paths for binaries are no longer absolute.  
 
1174
<br/>
 
1175
Configuration files now allow comments, but they're not preserved by Topal.
 
1176
<br/>
 
1177
Added more exception handling messages.
 
1178
<br/>
 
1179
Sending and receiving both save off original input as tempfiles to
 
1180
help debugging.
 
1181
<br/>
 
1182
Added --ask-charset command line option.  This is really only for
 
1183
testing a new workaround for locale-related bad signatures.  Please
 
1184
see <a href="#locale-problems">locale problems</a> in the notes and
 
1185
send feedback.
 
1186
<br/>
 
1187
Started removing dependency on mime-construct; new source files mime.ad[sb].
 
1188
<br/>
 
1189
Build date added to binary.
 
1190
</dd>
 
1191
<dt>3/7/2008; release 59</dt><dd>
 
1192
Added sequence numbers to temporary files to reduce possible name
 
1193
conflicts.
 
1194
<br/>
 
1195
The makefile's install target now installs to INSTALLPATH.  This can
 
1196
be overridden, e.g., <tt>make install INSTALLPATH=/usr/local</tt>.
 
1197
The four more specific paths, INSTALLPATHBIN, INSTALLPATHMAN,
 
1198
INSTALLPATHDOC and INSTALLPATHPATCHES can also be overridden.  Fixes
 
1199
request from Nils Schlupp re: ebuild.
 
1200
<br/>
 
1201
The --ask-charset command-line option is now only used if a bad signature
 
1202
is returned; a second attempt is then made if a different character
 
1203
set is suggested by the user.
 
1204
</dd>
 
1205
<dt>13/7/2008; release 60</a></dt><dd>
 
1206
Update installation instructions for make install.
 
1207
<br/>
 
1208
We now use a modified version of Jeffrey S. Dutky's mime-tool instead
 
1209
of mime-construct for creating MIME messages.  We include our modified
 
1210
version in the Topal tarball (since both are GPL, and our
 
1211
modifications are needed if creating MIME messages).
 
1212
<br/>
 
1213
MIME viewing can now use metamail, use run-mailcap or save the attachment to the
 
1214
folder <tt>~/.topal/viewmime</tt> (which you can then open in
 
1215
Alpine).  run-mailcap and saving support are new.
 
1216
<br/>
 
1217
Sending menu allows user to view and edit the email.  A quicker
 
1218
method for changing/setting the signing (own) key is available.
 
1219
</dd>
 
1220
 
 
1221
<!-- Don't remove the next line - or its counterpart later on! -->
 
1222
<!-- MRC -->
 
1223
 
 
1224
<dt>14/7/2008; release 61</dt><dd>
 
1225
An initial, rather crude, but (for my purposes at least) effective
 
1226
remote mode for sending.
 
1227
<br/>
 
1228
Some history is now saved.
 
1229
</dd>
 
1230
<dt><a name="last-changes"/>17/7/2008; release 62</a></dt><dd>
 
1231
Added basic support for S/MIME verification of messages.
 
1232
<br/>
 
1233
Quoted-printable encoder (in MIME-tool) improved (single dots and
 
1234
leading "From ") as per RFC2049.
 
1235
<br/>
 
1236
Ignore errors in strip in Makefile (trips up Cygwin, which expects the
 
1237
executable to be foo.exe).
 
1238
<br/>
 
1239
Update feature list for remote sending.
 
1240
<br/>
 
1241
Internal changes to configuration storage.
 
1242
</dd>
782
1243
<!-- MRC --> 
783
 
 
784
 
</A>
785
 
 
786
 
</DL>
787
 
 
788
 
<HR>
789
 
 
790
 
</BODY>
791
 
</HTML>
 
1244
</dl>
 
1245
 
 
1246
<hr/>
 
1247
 
 
1248
</body>
 
1249
</html>