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
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML//EN">
<HTML>
<HEAD>
<TITLE>MHonArc -- Quick Start
</TITLE>
</HEAD>
<BODY>
<!--X-NavButtons-Start-->
<p align=center>
[<a href="intro.html">Prev</a>][<a href="layout.html">Next</a>][<a href="mhonarc.html">TOC</a>][<a href="http://www.oac.uci.edu/indiv/ehood/MHonArc/faq/faq.html">FAQ</a>][<a href="bugs.html">Bugs</a>][<a href="http://www.oac.uci.edu/indiv/ehood/mhonarc.html">Home</a>]
</p>
<!--X-NavButtons-End-->
<HR>
<H1><a name="quickstart">Quick Start</a></H1>
<P>This section will give you a "<EM>quick start</EM>" on using
MHonArc. However, I recommend reading through the entire
documentation to take full advantage of all the features of
MHonArc. </P>
<hr>
<H2><a name="folders">Converting MH mail folders or Mailbox files</a></H2>
<P>Since MHonArc supports <EM>MH</EM> mail folders and
UUCP/Unix mailbox files, the term "<EM>mail folder</EM>" will represent
the <EM>MH</EM> mail folder or mailbox file you want to process.
To convert your mail folder to an HTML archive, use the following:
</P>
<blockquote>
<pre>
% <b>mhonarc </b><VAR>path</VAR><b>/inbox</b>
</pre>
</blockquote>
<P>Where <VAR>path</VAR> represents the path to the directory
that contains the mail folder <EM>inbox</EM>. If you are in the
directory that contains inbox, then you can leave out the
"<VAR>path</VAR><tt>/</tt>".
</P>
<table border=0 cellpadding=4>
<tr valign=top>
<td><strong>NOTE</strong></td>
<td>The "<b><tt>%</tt></b>" represents your shell's prompt.
</td>
</tr>
</table>
<P>You may specify more than one mail folder
to process on the command-line: </P>
<blockquote>
<pre>
% <b>mhonarc </b><VAR>path</VAR><b>/inbox1</b> <VAR>path</VAR><b>/inbox2</b> ...
</pre>
</blockquote>
<p>You may also specify standard input, "<b><tt>-</tt></b>",
as the source of mail folder.
This is useful if want to use MHonArc in a pipe:
</p>
<blockquote>
<pre>
% <b>mhonarc -- - </b><VAR>path</VAR><b>/inbox</b>
</pre>
</blockquote>
<p>The "<b><tt>--</tt></b>" (two hyphens) is required to terminate
command-line option parsing so "<b><tt>-</tt></b>" will not be
treated as the start of an option. The example also illustrates
that you can still specify regular mail folders with standard
input. In this example, MHonArc will process standard input and
then <tt><VAR>path</VAR>/inbox</tt>.
</p>
<P>When MHonArc finishes, the following
files will be created: </P>
<UL>
<LI><P><tt><strong>maillist.html</strong></tt>:
The main index file containing links
to all mail messages converted. Messages are listed with subjects and
who the messages are from. All messages are listed in sorted order
by date received/sent. </P>
<LI><P><tt><strong>threads.html</strong></tt>:
The file listing messages by thread.
</P>
<LI><P><tt><strong>msg*.html</strong></tt>: HTML versions of the mail messages, where<CODE> * </CODE>represents a
message number from 0 to the number of message processed minus 1.
</P>
<LI><P><tt><strong>.mhonarc.db</strong></tt>
(or <tt>MHONARC.DB</tt> under Windows):
This database file is
needed inorder for MHonArc to perform additions of new mail messages
to the archive. Information is stored to perform mail threading updates
when new messages are added, as well as any defined
<a href="resources.html">resources</a>.
</P>
<LI><P><EM>Other</EM>: Depending on the content-types of the e-mail
messages converted, other files may be created for images, videos,
binaries, etc.
</P>
</UL>
<p>The actual filenames may differ depending on the settings
of various <a href="resources.html">resources</a>.
</p>
<P>All the files created will be put into the current
working directory, by default. You can control the
destination of the output location by using the
<a href="resources/outdir.html"><strong><tt>-outdir</tt></strong></a>
option. </P>
<DL>
<DT><STRONG>Example</STRONG>
<DD><PRE>
% <b>mhonarc -outdir /home/ehood/htmlarchive /home/ehood/mail/inbox</b>
</PRE>
</DL>
<P>Here is a sample session converting a mail folder:
</P>
<blockquote>
<PRE>
% <b>mhonarc ~/mail/inbox</b>
Requiring content filter libraries ...
mhexternal.pl
mhtxthtml.pl
mhtxtplain.pl
mhtxtsetext.pl
Requiring charset filter libraries ...
iso8859.pl
Converting messages to .
Reading /mnt/ehood/mail/inbox ..........
Writing mail ...
Writing ./maillist.html ...
Writing ./threads.html ...
Writing database ...
10 messages
</PRE>
</blockquote>
<p>By default, MHonArc prints out information about its progress.
This can be disable if you specify the
<a href="resources/quiet.html"><strong><tt>-quiet</tt></strong></a>
option.
</p>
<hr>
<H2><a name="adding">Adding Messages to an Archive</a></H2>
<P>If you have new messages you want to add to an existing archive,
you must utilizing the
<a href="resources/add.html"><strong><tt>-add</tt></strong></a>
command-line option. With the
<a href="resources/add.html"><strong><tt>-add</tt></strong></a>,
you can do the following: </P>
<UL>
<LI><P>Add a mail folder to an archive, or
</P>
<LI><P>Add a single message to an archive.
</P>
</UL>
<P>Adding a mail folder to an archive in the current working directory
can be done like the following: </P>
<blockquote>
<PRE>
% <b>mhonarc -add </b><VAR><path></VAR><b>/mailfolder</b>
</PRE>
</blockquote>
<P>If you are not in the same directory as the archive, then you
can specify the location of the archive to add to with the
<a href="resources/outdir.html"><strong><tt>-outdir</tt></strong></a>
option. </P>
<table border=0 cellpadding=4>
<tr valign=top>
<td><strong>NOTE</strong></td>
<td><P>MHonArc will skip any messages that already exist in
the archive. Therefore, MHonArc can be used to rescan the
same mail folder and only convert any new messages it finds.
</P>
</td>
</tr>
</table>
<P>If no mail folder arguments are specified, then MHonArc
will attempt to add a <EM>single</EM> message read in from standard
input. </P>
<P><STRONG>Example</STRONG></P>
<blockquote>
<PRE>
% <b>mhonarc -add < single.msg</b>
</PRE>
</blockquote>
<P>Or, from a pipe:
</P>
<blockquote>
<PRE>
% <b>cat single.msg | mhonarc -add</b>
</PRE>
</blockquote>
<hr>
<H2><a name="single">Converting a single message</a></H2>
<P>MHonArc has the ability to process a single
mail message independent of creating, or modifying, an
archive. To convert a single message to HTML use the
<a href="resources/single.html"><strong><tt>-single</tt></strong></a>
command-line
option. The message to process can be specified by a filename on the
command-line, or by reading the message from standard input if no file
is specified. The filtered message is sent to standard output. All
formatting options apply to the single message as with messages
being processed for an archive, with the exception of formatting
related specificly to archive processing, like index links and mail
thread links. </P>
<H3><STRONG>Examples</STRONG>
</H3>
<DL>
<DT>Input from standard input:
<DD><P><tt>% <b>mhonarc -single < messagefile > file.html</b></tt>
</P>
</DL>
<DL>
<DT>Filename on command-line:
<DD>
<P><tt>% <b>mhonarc -single messagefile > file.html</b></tt>
</P>
</DL>
<hr>
<!--X-NavButtons-Start-->
<p align=center>
[<a href="intro.html">Prev</a>][<a href="layout.html">Next</a>][<a href="mhonarc.html">TOC</a>][<a href="http://www.oac.uci.edu/indiv/ehood/MHonArc/faq/faq.html">FAQ</a>][<a href="bugs.html">Bugs</a>][<a href="http://www.oac.uci.edu/indiv/ehood/mhonarc.html">Home</a>]
</p>
<!--X-NavButtons-End-->
<HR>
<address>
97/06/05 18:43:40<br>
<img align="top" src="monicon.gif" alt="">
<a href="http://www.oac.uci.edu/indiv/ehood/mhonarc.html"
><strong>MHonArc</strong></a><br>
Copyright © 1997, <a href="http://www.oac.uci.edu/indiv/ehood/"
>Earl Hood</a>, <a href="mailto:ehood@medusa.acs.uci.edu"
>ehood@medusa.acs.uci.edu</a><br>
</address>
</BODY>
</HTML>
|
