[OpenSPARC-T2-DV] / tools / perl-5.8.0 / doc / MHonArc / quickstart.html

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML//EN">
<HTML>
<HEAD>
<TITLE>MHonArc v2.5 -- Quick Start</TITLE>
</HEAD>
<!--
<BODY background="ssbg75.jpg"
      text="#000000" link="#0000ee" vlink="#551a8b" alink="ff0000">
-->
<BODY>

<!--X-NavButtons-Start-->
<table width="100%">
<tr valign="top">
<td align="left"><nobr><a href="install.html"><img src="prev.png"border=0 alt="[Prev]"></a>&nbsp;&nbsp;&nbsp;</nobr></td><td align="center" width="99%"><a href="mhonarc.html"><img src="up.png" border=0 alt="[TOC]"></a><a href="faq/faq.html"><img src="faq.png" border=0 alt="[FAQ]"></a><a href="app-bugs.html"><img src="bug.png" border=0 alt="[Bugs]"></a><a href="http://www.mhonarc.org/"><img src="home.png" border=0 alt="[Home]"></a></td><td align="right"><nobr>&nbsp;&nbsp;&nbsp;<a href="commontasks.html"><img src="next.png" border=0 alt="[Next]"></a></nobr></td></tr></table>
<!--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.
</P>

<!--X-TOC-Start-->
<ul>
<li><a href="#folders">Converting mail</a>
<li><a href="#adding">Adding Messages to an Archive</a>
<li><a href="#single">Converting a single message</a>
</ul>
<!--X-TOC-End-->

<hr>
<H2><a name="folders">Converting mail</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>
shell&gt; <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>shell&gt;</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>
shell&gt; <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>
shell&gt; <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>
shell&gt; <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>
shell&gt; <b>mhonarc ~/mail/inbox</b>
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 disabled with 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>
shell&gt; <b>mhonarc -add </b><VAR>&lt;path&gt;</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>
shell&gt; <b>mhonarc -add &lt; single.msg</b> 
</PRE>
</blockquote>
<P>Or, from a pipe:
</P>
<blockquote>
<PRE>
shell&gt; <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>

<p><STRONG>Examples</STRONG></p>

<DL>
<DT>Input from standard input:

<DD><P><tt>shell&gt; <b>mhonarc -single &lt; messagefile &gt; file.html</b></tt> 
</P>
</DL>

<DL>
<DT>Filename on command-line:

<DD>
<P><tt>shell&gt; <b>mhonarc -single messagefile &gt; file.html</b></tt> 
</P>
</DL>

<hr>
<!--X-NavButtons-Start-->
<table width="100%">
<tr valign="top">
<td align="left"><nobr><a href="install.html"><img src="prev.png"border=0 alt="[Prev]"></a>&nbsp;&nbsp;&nbsp;</nobr></td><td align="center" width="99%"><a href="mhonarc.html"><img src="up.png" border=0 alt="[TOC]"></a><a href="faq/faq.html"><img src="faq.png" border=0 alt="[FAQ]"></a><a href="app-bugs.html"><img src="bug.png" border=0 alt="[Bugs]"></a><a href="http://www.mhonarc.org/"><img src="home.png" border=0 alt="[Home]"></a></td><td align="right"><nobr>&nbsp;&nbsp;&nbsp;<a href="commontasks.html"><img src="next.png" border=0 alt="[Next]"></a></nobr></td></tr></table>
<!--X-NavButtons-End-->

<HR>
<address>
$Date: 2001/12/24 14:38:07 $ <br>
<img align="top" src="monicon.png" alt="">
<a href="http://www.mhonarc.org"
><strong>MHonArc</strong></a><br>
Copyright &#169; 1997-1999, <a href="http://www.mhonarc.org/~ehood/"
>Earl Hood</a>, <a href="mailto:mhonarc@mhonarc.org"
>mhonarc@mhonarc.org</a><br>
</address>

</BODY>
</HTML>
Commit	Line	Data
86530b38 AT	1	<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML//EN">
	2	<HTML>
	3	<HEAD>
	4	<TITLE>MHonArc v2.5 -- Quick Start</TITLE>
	5	</HEAD>
	6	<!--
	7	<BODY background="ssbg75.jpg"
	8	text="#000000" link="#0000ee" vlink="#551a8b" alink="ff0000">
	9	-->
	10	<BODY>
	11
	12	<!--X-NavButtons-Start-->
	13	<table width="100%">
	14	<tr valign="top">
	15	<td align="left"><nobr><a href="install.html"><img src="prev.png"border=0 alt="[Prev]"></a>   </nobr></td><td align="center" width="99%"><a href="mhonarc.html"><img src="up.png" border=0 alt="[TOC]"></a><a href="faq/faq.html"><img src="faq.png" border=0 alt="[FAQ]"></a><a href="app-bugs.html"><img src="bug.png" border=0 alt="[Bugs]"></a><a href="http://www.mhonarc.org/"><img src="home.png" border=0 alt="[Home]"></a></td><td align="right"><nobr>   <a href="commontasks.html"><img src="next.png" border=0 alt="[Next]"></a></nobr></td></tr></table>
	16	<!--X-NavButtons-End-->
	17	<HR>
	18
	19	<H1><a name="quickstart">Quick Start</a></H1>
	20
	21	<P>This section will give you a "<EM>quick start</EM>" on using
	22	MHonArc.
	23	</P>
	24
	25	<!--X-TOC-Start-->
	26	<ul>
	27	<li><a href="#folders">Converting mail</a>
	28	<li><a href="#adding">Adding Messages to an Archive</a>
	29	<li><a href="#single">Converting a single message</a>
	30	</ul>
	31	<!--X-TOC-End-->
	32
	33	<hr>
	34	<H2><a name="folders">Converting mail</a></H2>
	35
	36	<P>Since MHonArc supports <EM>MH</EM> mail folders and
	37	UUCP/Unix mailbox files, the term "<EM>mail folder</EM>" will represent
	38	the <EM>MH</EM> mail folder or mailbox file you want to process.
	39	To convert your mail folder to an HTML archive, use the following:
	40	</P>
	41
	42	<blockquote>
	43	<pre>
	44	shell> <b>mhonarc </b><VAR>path</VAR><b>/inbox</b>
	45	</pre>
	46	</blockquote>
	47
	48	<P>Where <VAR>path</VAR> represents the path to the directory
	49	that contains the mail folder <EM>inbox</EM>. If you are in the
	50	directory that contains inbox, then you can leave out the
	51	"<VAR>path</VAR><tt>/</tt>".
	52	</P>
	53
	54	<table border=0 cellpadding=4>
	55	<tr valign=top>
	56	<td><strong>NOTE</strong></td>
	57	<td>The "<b><tt>shell></tt></b>" represents your shell's prompt.
	58	</td>
	59	</tr>
	60	</table>
	61
	62	<P>You may specify more than one mail folder
	63	to process on the command-line: </P>
	64
65	<blockquote>
66	<pre>
67	shell> <b>mhonarc </b><VAR>path</VAR><b>/inbox1</b> <VAR>path</VAR><b>/inbox2</b> ...
68	</pre>
69	</blockquote>
70
71	<p>You may also specify standard input, "<b><tt>-</tt></b>",
72	as the source of mail folder.
73	This is useful if want to use MHonArc in a pipe:
74	</p>
75
76	<blockquote>
77	<pre>
78	shell> <b>mhonarc -- - </b><VAR>path</VAR><b>/inbox</b>
79	</pre>
80	</blockquote>
81
82	<p>The "<b><tt>--</tt></b>" (two hyphens) is required to terminate
83	command-line option parsing so "<b><tt>-</tt></b>" will not be
84	treated as the start of an option. The example also illustrates
85	that you can still specify regular mail folders with standard
86	input. In this example, MHonArc will process standard input and
87	then <tt><VAR>path</VAR>/inbox</tt>.
88	</p>
89
90	<P>When MHonArc finishes, the following
91	files will be created: </P>
92
93	<UL>
94
95	<LI><P><tt><strong>maillist.html</strong></tt>:
96	The main index file containing links
97	to all mail messages converted. Messages are listed with subjects and
98	who the messages are from. All messages are listed in sorted order
99	by date received/sent. </P>
100
101	<LI><P><tt><strong>threads.html</strong></tt>:
102	The file listing messages by thread.
103	</P>
104
105	<LI><P><tt><strong>msg.html</strong></tt>: HTML versions of the mail messages, where<CODE> </CODE>represents a
106	message number from 0 to the number of message processed minus 1.
107	</P>
108
109	<LI><P><tt><strong>.mhonarc.db</strong></tt>
110	(or <tt>MHONARC.DB</tt> under Windows):
111	This database file is
112	needed inorder for MHonArc to perform additions of new mail messages
113	to the archive. Information is stored to perform mail threading updates
114	when new messages are added, as well as any defined
115	<a href="resources.html">resources</a>.
116	</P>
117
118	<LI><P><EM>Other</EM>: Depending on the content-types of the e-mail
119	messages converted, other files may be created for images, videos,
120	binaries, etc.
121	</P>
122
123	</UL>
124
125	<p>The actual filenames may differ depending on the settings
126	of various <a href="resources.html">resources</a>.
127	</p>
128
129	<P>All the files created will be put into the current
130	working directory, by default. You can control the
131	destination of the output location by using the
132	<a href="resources/outdir.html"><strong><tt>-outdir</tt></strong></a>
133	option. </P>
134
135	<DL>
136	<DT><STRONG>Example</STRONG>
137
138	<DD><PRE>
139	shell> <b>mhonarc -outdir /home/ehood/htmlarchive /home/ehood/mail/inbox</b>
140	</PRE>
141	</DL>
142
143	<P>Here is a sample session converting a mail folder:
144	</P>
145
146	<blockquote>
147	<PRE>
148	shell> <b>mhonarc ~/mail/inbox</b>
149	Converting messages to .
150	Reading /mnt/ehood/mail/inbox ..........
151	Writing mail ...
152	Writing ./maillist.html ...
153	Writing ./threads.html ...
154	Writing database ...
155	10 messages
156	</PRE>
157	</blockquote>
158
159	<p>By default, MHonArc prints out information about its progress.
160	This can be disabled with the
161	<a href="resources/quiet.html"><strong><tt>-quiet</tt></strong></a>
162	option.
163	</p>
164
165	<hr>
166	<H2><a name="adding">Adding Messages to an Archive</a></H2>
167
168	<P>If you have new messages you want to add to an existing archive,
169	you must utilizing the
170	<a href="resources/add.html"><strong><tt>-add</tt></strong></a>
171	command-line option. With the
172	<a href="resources/add.html"><strong><tt>-add</tt></strong></a>,
173	you can do the following: </P>
174
175	<UL>
176	<LI><P>Add a mail folder to an archive, or
177	</P>
178	<LI><P>Add a single message to an archive.
179	</P>
180	</UL>
181
182	<P>Adding a mail folder to an archive in the current working directory
183	can be done like the following: </P>
184
185	<blockquote>
186	<PRE>
187	shell> <b>mhonarc -add </b><VAR><path></VAR><b>/mailfolder</b>
188	</PRE>
189	</blockquote>
190
191	<P>If you are not in the same directory as the archive, then you
192	can specify the location of the archive to add to with the
193	<a href="resources/outdir.html"><strong><tt>-outdir</tt></strong></a>
194	option. </P>
195
196	<table border=0 cellpadding=4>
197	<tr valign=top>
198	<td><strong>NOTE</strong></td>
199	<td><P>MHonArc will skip any messages that already exist in
200	the archive. Therefore, MHonArc can be used to rescan the
201	same mail folder and only convert any new messages it finds.
202	</P>
203	</td>
204	</tr>
205	</table>
206
207	<P>If no mail folder arguments are specified, then MHonArc
208	will attempt to add a <EM>single</EM> message read in from standard
209	input. </P>
210
211	<P><STRONG>Example</STRONG></P>
212
213	<blockquote>
214	<PRE>
215	shell> <b>mhonarc -add < single.msg</b>
216	</PRE>
217	</blockquote>
218	<P>Or, from a pipe:
219	</P>
220	<blockquote>
221	<PRE>
222	shell> <b>cat single.msg \| mhonarc -add</b>
223	</PRE>
224	</blockquote>
225
226	<hr>
227	<H2><a name="single">Converting a single message</a></H2>
228
229	<P>MHonArc has the ability to process a single
230	mail message independent of creating, or modifying, an
231	archive. To convert a single message to HTML use the
232	<a href="resources/single.html"><strong><tt>-single</tt></strong></a>
233	command-line
234	option. The message to process can be specified by a filename on the
235	command-line, or by reading the message from standard input if no file
236	is specified. The filtered message is sent to standard output. All
237	formatting options apply to the single message as with messages
238	being processed for an archive, with the exception of formatting
239	related specificly to archive processing, like index links and mail
240	thread links. </P>
241
242	<p><STRONG>Examples</STRONG></p>
243
244	<DL>
245	<DT>Input from standard input:
246
247	<DD><P><tt>shell> <b>mhonarc -single < messagefile > file.html</b></tt>
248	</P>
249	</DL>
250
251	<DL>
252	<DT>Filename on command-line:
253
254	<DD>
255	<P><tt>shell> <b>mhonarc -single messagefile > file.html</b></tt>
256	</P>
257	</DL>
258
259	<hr>
260	<!--X-NavButtons-Start-->
261	<table width="100%">
262	<tr valign="top">
263	<td align="left"><nobr><a href="install.html"><img src="prev.png"border=0 alt="[Prev]"></a>   </nobr></td><td align="center" width="99%"><a href="mhonarc.html"><img src="up.png" border=0 alt="[TOC]"></a><a href="faq/faq.html"><img src="faq.png" border=0 alt="[FAQ]"></a><a href="app-bugs.html"><img src="bug.png" border=0 alt="[Bugs]"></a><a href="http://www.mhonarc.org/"><img src="home.png" border=0 alt="[Home]"></a></td><td align="right"><nobr>   <a href="commontasks.html"><img src="next.png" border=0 alt="[Next]"></a></nobr></td></tr></table>
264	<!--X-NavButtons-End-->
265
266	<HR>
267	<address>
268	$Date: 2001/12/24 14:38:07 $ <br>
269	<img align="top" src="monicon.png" alt="">
270	<a href="http://www.mhonarc.org"
271	><strong>MHonArc</strong></a><br>
272	Copyright © 1997-1999, <a href="http://www.mhonarc.org/~ehood/"
273	>Earl Hood</a>, <a href="mailto:mhonarc@mhonarc.org"
274	>mhonarc@mhonarc.org</a><br>
275	</address>
276
277	</BODY>
278	</HTML>