-
Notifications
You must be signed in to change notification settings - Fork 158
Expand file tree
/
Copy pathfaq.html
More file actions
410 lines (385 loc) · 17.8 KB
/
Copy pathfaq.html
File metadata and controls
410 lines (385 loc) · 17.8 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="generator" content=
"HTML Tidy for HTML5 for Linux version 5.6.0" />
<title>Hypermail Frequently Asked Questions</title>
<link rel="author" href="https://github.com/hypermail-project" />
<link rel="stylesheet" href="hypermail-doc.css" />
<meta name="description" content=
"Hypermail Related Software Tools" />
<meta name="keywords" content=
"Hypermail tools, email tools, conversion software, checking Hypermail configurations" />
</head>
<body>
<br />
<h1 class="c1">Hypermail Frequently Asked Questions</h1>
<hr class="centered" />
<h2>Table of Contents</h2>
<ol>
<li><a href="#1">Will hypermail run on my system ?</a></li>
<li><a href="#2">Where can I get the latest stable version of Hypermail
?</a></li>
<li><a href="#3">Where can I get the latest development version of
Hypermail ?</a></li>
<li><a href="#4">How can I split the archives into months
?</a></li>
<li><a href="#5">How do I change the font on the pages
?</a></li>
<li><a href="#6">What is HM_MAILTO used for ?</a></li>
<li><a href="#7">Can I send a message to the list from the web
archive ?</a></li>
<li><a href="#8">How can I remove a listserver subject prefix
?</a></li>
<li><a href="#9">Which configuration file should I use
?</a></li>
<li><a href="#10">Why is the downloaded file name different
when I download hypermail.tar.gz ?</a></li>
<li><a href="#11">Can I throttle hypermail's CPU usage
?</a></li>
<li><a href="#12">How can I make my archive searchable
?</a></li>
<li><a href="#13">How does hypermail decide whether messages
are in the same thread?</a></li>
<li><a href="#14">How can I have multiple mailboxes produce one
archive?</a></li>
<li><a href="#15">I have received an email with attachment that
needs octet-stream. What should I do?</a></li>
<li><a href="#16">Why is Hypermail ignoring some
messages?</a></li>
<li><a href="#17">Bogus dates are causing some emails to be put
in a strange folder. Is there an easy way around this?</a></li>
</ol>
<hr class="centered" />
<h3><a href="#" id="1">1. Will hypermail run on my
system ?</a></h3>
<p>Hypermail can compile and run as-is on most of the more
popular UNIX systems today that support gcc or clang. If you're not sure
if hypermail will
run on your UNIX system, try compiling it and see!</p>
<p>Hypermail has been reported to work on MacOSX (X.2.6), with
the advice to use --disable-shared and manually execute make in
src/pcre2.</p>
<hr class="centered" />
<h3><a href="#" id="2">2. Where can I get the latest stable version of Hypermail</a></h3>
<p>The latest stable version of hypermail, as well as previous stable releases are all available from <a href=
"https://github.com/hypermail-project/hypermail/releases">https://github.com/hypermail-project/hypermail/releases</a></p>
<hr class="centered" />
<h3><a href="#" id="3">3. Where can I get the latest
development version of Hypermail ?</a></h3>
<p>The latest development version of Hypermail is the main branch available from the hypermail github code repository
at <a href="https:/github.com/hypermail-project/hypermail">https://github.com/hypermail-project/hypermail</a></p>.
<hr class="centered" />
<h3><a href="#" id="4">4. How can I split the archives
into months ?</a></h3>
<p><em>I have a fat archive that I'd like to split up by month,
like I see so many others doing. Is there a description somewhere
of a procedure to follow, or will I just have to think it
through?</em></p>
<p>If you are using version 2.1.0 or later and either have gdbm
or don't do incremental updates, see the <a href=
"hmrc.html#folder_by_date">folder_by_date</a> option. The simple
way to use this is to add these to your .hmrc:</p>
<blockquote>
folder_by_date="%y%m"<br />
usegdbm = 1
</blockquote>and regenerate your archive from its mbox file.
<p>An older alternative is a set of scripts in a directory named
<a href="source/archive/">archive/</a> that has tools to do just
what you want to do.</p>
<p>If you want index files split by month but don't need to split
the archive into multiple directories, try adding
"monthly_index=1" in your config file (usually ~/.hmrc)
(available in version 2.1). A summary.html file will provide
links to all the monthly indices. This is probably appropriate
for archives with a few thousand messages, but for larger
archives I recommend splitting into multiple directories.</p>
<p>There's a script at <a href=
"https://users.netrus.net/troc/perl.html">https://users.netrus.net/troc/perl.html</a>
called mms (monthly mail splitter) which has also been reported
useful.</p>
<hr class="centered" />
<h3><a href="#" id="5">5. How do I change the font on
the pages ?</a></h3>
<p>You can edit the CSS associated with the files or add an
external CSS. In hypermail 3.0, CSS rules are not included anymore
inside the message and index files generated by hypermail. By default,
Hypermail will generate a external hypermail.css file and include it in
messages and indexes by means of a link. You can change this behavior
thru configuration.</p>
<p>In hypermail 2.4, the CSS is embeeded inside each message and index.
You also have the possiblity to link external CSS files to further customize
the look and feel of your archive.
<hr class="centered" />
<h3><a href="#" id="6">6. What is MAILTO used for
?</a></h3>
<p><em>I've enabled this option in .hyprc (the configuration file
to which the pipe script for my archive points). Unlike the other
options, this one does not create a link to
mailto:admin@domain.com as I would expect. Any ideas?</em></p>
<p>MAILTO has a couple different uses. One is to trigger the
insertion of the <LINK REV=made HREF=mailto:...> header in
the HTML sources. This is most useable with ascii browsers such
as lynx.</p>
<blockquote>
<strong><small>hm_mailto = [ email-address | NONE ]<br />
#<br />
# The address of the contact point that is put in the HTML
header line<br />
# <LINK REV=made HREF=mailto:hm_mailto><br />
#<br />
# The <LINK...> header can be disabled by default by
setting<br />
# mailto to NONE.</small></strong>
</blockquote>
<p>It can also be used in a hypermail page template file since it
resolves to %m.</p>
<p>For example, your footer file might look like...</p>
<p><strong><small><P ALIGN=CENTER><IMG
SRC="/images/bar.png" WIDTH="400" HEIGHT="4"
ALT="---------"></P><br />
<ADDRESS><br />
<EM><br />
<SMALL><br />
This archive was generated by %u on %g<br />
<P ALIGN=CENTER><br />
Send administrative comments to<A
HREF="mailto:%m">%m</A><br />
</P><br />
</SMALL><br />
</EM><br />
</ADDRESS><br />
</BODY><br />
</HTML></small></strong></p>
<p>In this case the %m is expanded to admin@domain.com.</p>
<hr class="centered" />
<h3><a href="#" id="7">7. Can I send a message to the
list from the web archive ?</a></h3>
<p><em>I would like to add a link to the menu that says "Send a
Message to the List." I read through the documentation on your
website, and I think I know what I have to do. However, I cannot
find an example of what a .hyp template file should look
like.</em></p>
<p>That's what "Respond" on the menubar does. It allows a person
to reply to the existing message, with the reply sent to the list
address. And "mail a new topic" on the menubar allows a user to
send a new message to the list.</p>
<p>To enable this feature set</p>
<p><strong><small><br />
hm_hmail = listaddr@your-site.domain</small></strong></p>
<hr class="centered" />
<h3><a href="#" id="8">8. How can I remove a listserver
subject prefix ?</a></h3>
<p><em>The Subject index page does not seem to do the right
sorting. My list has a "subject prefix" so people can filter
their inbound mail better. Is that confusing the sorting
?</em></p>
<p>Yes. Hypermail functions that deal with replies look for the
Re: and return a pointer to the subject line after the "Re: ".
The listserver software is prefixing the subject line contents
with [subject-prefix]. For example:</p>
<p><strong><small>Initial message:<br /></small></strong></p>
<blockquote>
<strong><small>Subject: [subject-prefix] the subject of the
message</small></strong>
</blockquote>
<p><strong><small>Replies:<br /></small></strong></p>
<blockquote>
<strong><small>Subject: [subject-prefix] Re: the subject of the
message</small></strong>
</blockquote>
<p>The best solution is to use the directive</p>
<blockquote>
<strong>stripsubject = [subject-prefix]</strong>
</blockquote>in the config file for that list. Then
[subject-prefix] is stripped before the Reply processing occurs
and the proper things happen. This is the proper fix since
hypermail would need to know to strip the [subject-prefix] from
the initial messages to get it right.
<hr class="centered" />
<h3><a href="#" id="9">9. Which configuration file should
I use ?</a></h3>
<p><em>Which configuration file should I use ?. Is it the
hypermail.rc file in the Configs directory? I'm trying to edit
the appearance of pages created by hypermail, but I think I'm
trying to edit the wrong config file.</em></p>
<p>With one of the later versions you can use the -v option to
generate a config file that you can use. There is not just one
config file. What are included are examples.</p>
<blockquote>
<strong><small>$ hypermail -v >
some-file.rc</small></strong>
</blockquote>Edit the some-file.rc and set the values to what you
want.
<p>Then run hypermail using the config file by:</p>
<blockquote>
<strong><small>$ hypermail -c some-file.rc.</small></strong>
</blockquote>
<hr class="centered" />
<h3><a href="#" id="10">10. Why is the downloaded file name
different when I download hypermail.tar.gz ?</a></h3>
<p><em>The source is available from</em></p>
<blockquote>
<em><a href=
"https://www.hypermail-project.org/hypermail.tar.gz">www.hypermail.org/hypermail.tar.gz</a></em>
</blockquote><em>However: When downloading though IE v4 browser
on an NT PC, you get a file called hypermail_tar.tar.</em>
<p>Depending on your browser MIME type setup and support
applications, the filename downloaded might be hypermail.tar,
hypermail.tar.gz, etc. In any case, you will be informed as to
the filename when you actually download it onto a Windows/NT PC.
Use that name from that point forward.</p>
<hr class="centered" />
<h3><a href="#" id="11">11. Can I throttle hypermail's CPU
usage ?</a></h3>
<p><em>I'm looking for a good way to throttle hypermail. When it
runs it is taking over both CPU's on my system. Is there a way to
have it limit itself?</em></p>
<p>There is currently no "nice" call in hypermail to limit
itself. Maybe we can consider it in the future. You might run it
as a subcommand to nice. For example in an aliases file:</p>
<blockquote>
<strong><small>"|nice someval 'hypermail command
line'"</small></strong>
</blockquote>I've NEVER tried this so... ;)
<p>You might also be looking at a very large archive with lots of
messages being the cause. If so then try breaking it up into
smaller archives such as monthly archives. Tools are available
for that in the latest release.</p>
<p>And if the list is a high traffic list, consider not running
it from a sendmail alias and instead, run it from cron. (To
assure it does not run unnecessarily, consider using 'make' to
check dependencies on the inbound mailbox and the archive itself.
If the mailbox is newer, then run the hypermail command. If not,
then no new message have been received so don't bother running
it.</p>
<p>If the you are using the linkquotes option and incremental
update (-u option), add a searchbackmsgnum line to your config
file. It controls the tradeoff between speed and the reliability
of finding the right source for quoted text. Try to set it to the
largest number of messages between a message and the final direct
reply to that message.</p>
<hr class="centered" />
<h3><a href="#" id="12">12. How can I make my archive
searchable ?</a></h3>
<p><em>Where can I find a program that provides an easy way of
adding a "search this archive" feature to my hypermail
archive?</em></p>
<p>These seem to be the most popular choices:</p>
<ul>
<li><a href="http://www.namazu.org/">Namazu</a></li>
</ul>
<p>You can also use search engines by putting text such as this
on your web page (although this search produces results from an
entire site, not just the email archive):<br />
<form action=https://www.google.com/search><br />
<input type=text name=as_q><br />
<input type=hidden name=as_sitesearch
value=hypermail-project.org><br />
<input type=submit value="Search Hypermail"><br />
</form></p>
<p>You can probably get more complete (but apparently not recent)
info at: <a href=
"https://www.searchenginewatch.com/resources/software.html">Search
Engine Software For Your Web Site</a>.</p>
<hr class="centered" />
<h3><a href="#" id="13">13. How does hypermail decide
whether messages are in the same thread?</a></h3>
<p>It uses the In-Reply-To: header if that is available. If not,
it uses the References: header if that is available. If these are
not available, it looks for previous messages with the same
subject header. Matches based on the subject are listed as
"maybe" replies.</p>
<p>If the linkquotes option is used, it will also search the
message bodies of the previous searchbackmsgnum (default = 500)
messages for text that looks like it is being quoted in the
current message. If it finds one or more prior messages with such
text matches, it will treat the one with the longest match as the
message being replied to. The exact algorithms for deciding what
is quoted text are a bit complex. These matches override the
In-Reply-To: and References: info (this rule may deserve further
thought).</p>
<hr class="centered" />
<h3><a href="#" id="14">14. How can I have multiple
mailboxes produce one archive?</a></h3>
<p>One simple way is to combine them into one mailbox, and send
that to hypermail. Something like<br /></p>
<blockquote>
"cat file1 file2 file3 > combined"
</blockquote>should do that.
<p>Another way is to invoke hypermail several times, using the -u
flag for any mailboxes that you want added after the html archive
has been started:</p>
<pre>
hypermail -m file1
hypermail -u -m file2
hypermail -u -m file3
</pre>
<p>Do not try to send hypermail more than one mailbox at a time,
or send it a second mailbox without using the -u flag or the
increment=1 or increment=-1 option.</p>
<hr class="centered" />
<h3><a href="#" id="15">15. I have received an email with
attachment that needs octet-stream. What should I do?</a></h3>
<p>No attachment "needs" octet-stream. octet-stream is a label
that describes the attachment as being "a stream of octets". What
is that you say? Well, the application didn't know any more
specifics and thus it identified it as good as possible. It knows
it is a stream of octets, nothing else.</p>
<p>So, an attachment coming as "octet-stream" can be pretty much
ANYTHING. You have no idea, and neither does anyone else. The
only way to figure out is to download the file and see for
yourself, ask the person who mailed it or to hope that the mail
it came with describes what the attachment was about.</p>
<p>"octet-stream" could just as well be named "I haven't got the
slightest idea what this is, but I know it is built up with a
series of bytes".</p>
<hr class="centered" />
<h3><a href="#" id="16">16. Why is Hypermail ignoring some
messages?</a></h3>
<p>One possibility is that those messages have a header
saying</p>
<blockquote>
X-No-Archive: yes
</blockquote>which seems to indicate that the author doesn't want
them included in any archive. This is controlled by a configure
option which defaults to:
<blockquote>
deleted = "X-Hypermail-Deleted X-No-Archive"
</blockquote>To get Hypermail to treat these as normal messages,
add this to your config file (which is ~/.hmrc by default) or
alter the "deleted" line in your existing config file to:
<blockquote>
deleted = "X-Hypermail-Deleted"
</blockquote>
<hr class="centered" />
<h3><a href="#" id="17">17. Bogus dates are causing some
emails to be put in a strange folder. Is there an easy way around
this?</a></h3>
<p>If the bad dates were caused by a computer with the date set
absurdly, try running <a href=
"https://gradha.sdf-eu.org/program/mailbox_date_trimmer.en.html">mailbox_date_trimmer.py</a>,
available in the Hypermail's contrib directory.</p>
<p>If the bad dates are in a format that Hypermail doesn't
understand, then you will probably need to edit them
manually.</p>
<hr class="centered" />
<br />
<div style="text-align: center">
<address>
<strong>Do you have a Hypermail related question you'd like
to see listed here ? If so send mail to the Hypermail mailing
list <a href=
"mailto:hypermail@hypermail-project.org">hypermail@hypermail-project.org</a>
(preferably with the answers). In order to
minimize spam on the list, you must subscribe to the list (at
least temporarily) in order to send mail to it. You may
subscribe to the list by sending a message with the word
"subscribe" in the Subject: field to
hypermail-request@hypermail-project.org.</strong>
</address>
</div>
<p> </p>
</body>
</html>