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

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML//EN">
<HTML>
<HEAD>
<TITLE>MHonArc v2.5 -- Appendix: Utility Programs
</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="app-diagnos.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="app-api.html"><img src="next.png" border=0 alt="[Next]"></a></nobr></td></tr></table>
<!--X-NavButtons-End-->
<HR>

<H1><a name="appendixA">Appendix: Utility Programs</a></H1>

<P>This appendix describes the additional utility programs that
are included in the MHonArc distribution.  The utility programs
are installed with <b>mhonarc</b> during the installation process.
</P>

<!--X-TOC-Start-->
<ul>
<li><a href="#mha-dbedit">mha-dbedit</a>
<li><a href="#mha-dbrecover">mha-dbrecover</a>
<ul>
<li><small><a href="#mha-dbrecover-options">Additional Options</a></small>
</ul>
<li><a href="#mha-decode">mha-decode</a>
<ul>
<li><small><a href="#mha-decode-options">Additional Options</a></small>
<li><small><a href="#mha-decode-examples">Examples</a></small>
</ul>
</ul>
<!--X-TOC-End-->

<hr>
<H2><a name="mha-dbedit">mha-dbedit</a></H2>

<P><b>mha-dbedit</b> allows modifications to be made to an archive
database without regenerating any archive pages.
</P>

<p>Typical usage:
</p>
<pre>
    shell&gt; <b>mha-dbedit -rcfile <var>res.mrc</var> -outdir <var>/path/to/archive</var></b>
</pre>

<hr>
<H2><a name="mha-dbrecover">mha-dbrecover</a></H2>

<P><b>mha-dbrecover</b> recreates an archive database from the individual
message pages.  This program is useful if an archive database gets
corrupted, or accidentally deleted.
</P>

<p>Typical usage:
</p>
<pre>
    shell&gt; <b>mha-dbrecover -outdir <var>/path/to/archive</var></b>
</pre>

<p>If the archive used different resource settings from the defaults
for controling filenames, then you must specify those settings when
invoking <b>mha-dbrecover</b>.  For example, if you are using
"<tt>shtml</tt>" for <a href="resources/htmlext.html">HTMLEXT</a>,
then you should invoke <b>mha-dbrecover</b> like the following:
</p>
<pre>
    shell&gt; <b>mha-dbrecover -htmlext shtml -outdir <var>/path/to/archive</var></b>
</pre>

<p><b>mha-dbrecover</b> will only recreate non-layout message related data.
If the archive had resource settings that were different than the
the defaults, then those resource settings must be specified when
invoking <b>mha-dbrecover</b>.  For example:
</p>
<pre>
    shell&gt; <b>mha-dbrecover -rcfile <var>res.mrc</var> -outdir <var>/path/to/archive</var></b>
</pre>

<h3><a name="mha-dbrecover-options">Additional Options</a></h3>

<p><b>mha-dbrecover</b> supports the additional command-line options:
</p>

<dl>
<dt><tt>-dbr-startnum <var>#</var></tt></dt>
<dd>The starting message number to recover data from.  This option is
    useful if you have many message files in a directory, but you only
    want to recover a subset of the files.
    If this option is not specified, the starting number is 0.
    </dd>
</dl>
<dl>
<dt><tt>-dbr-endnum <var>#</var></tt></dt>
<dd>The ending message number to recover data from.  This option is
    useful if you have many message files in a directory, but you only
    want to recover a subset of the files.
    If this option is not specified, all messages starting from
    <tt>-dbr-startnum</tt> will be recovered.
    </dd>
</dl>

<p>Using the number range options are typically not needed, but may
be useful if the archive is maintained with a
<a href="resources/maxsize.html">MAXSIZE</a> (or
<a href="resources/expireage.html">EXPIREAGE</a>),
and
<a href="resources/keeponrmm.html">KEEPONRMM</a> is active.  The
message number range options will allow you to minimize recovering
processing by having <b>mha-dbrecover</b> skip messaages that will
be dropped from the database due to the
<a href="resources/maxsize.html">MAXSIZE</a>,
or <a href="resources/expireage.html">EXPIREAGE</a>,
setting.
</p>
<p>For example, say you have an archive directory with 1000 message
pages numbered 0 through 999, and the maximum size of the archive
is 200.  The following command will make recovering more efficient
by skipping the first 800 messages since they will be dropped from
the database anyway:
</p>
<pre>
    shell&gt; <b>mha-dbrecover -dbr-startnum 800 -outdir <var>/path/to/archive</var></b>
</pre>

<table border=0 cellpadding=4>
<tr valign=top>
<td><strong>NOTE</strong></td>
<td><p>It is possible that message number order may not exactly match
date order.  You may want to increase the number range to take in
account of possible anomolies where message number order may vary from
message date order.
</p>
</td>
</tr>
</table>

<hr>
<H2><a name="mha-decode">mha-decode</a></H2>

<P><b>mha-decode</b> is a utility program unrelated to MHonArc archives.
<b>mha-decode</b> provides basic MIME decoding capabilites for
messages.
</P>
<p>If given mail folders as input, all messages within in the mail
folders will be decoded.  All message parts are written to files.  If a
filename is specified for a message part, that filename will be used
when writing the part to a file.  If no filename is specified in the
message, a unique name will be used based upon the content-type of
the message part.
</p>
<p>A single message can be decoded by using the <tt>-single</tt> option.
</p>

Only MHonArc options that affect parsing of mail folders are applicable
for <b>mha-decode</b>.  The following options are applicable:
<tt>-conlen</tt>,
<tt>-mhpattern</tt>,
<tt>-msgsep</tt>,
<tt>-noconlen</tt>,
<tt>-outdir</tt>,
<tt>-perlinc</tt>,
<tt>-rcfile</tt>,
<tt>-single</tt>,
<tt>-umask</tt>.

<h3><a name="mha-decode-options">Additional Options</a></h3>

<p><b>mha-decode</b> supports the additional command-line options:
</p>

<dl>
<dt><tt>-dcd-digest</tt></dt>
<dd>Do not parse message/rfc822 and message/news attachments.
    Normally, <b>mha-decode</b> will recursively parse message
    attachments and decode any parts contained within.  With this
    option, any message attachment encountered will be saved
    intact.
    </dd>
</dl>

<h3><a name="mha-decode-examples">Examples</a></h3>

<p>Basic usage:
</p>
<pre>
    shell&gt; <b>mha-decode inbox</b>
</pre>
<p>Use <tt>-outdir</tt> to have all decoded data placed into a
separate directory:
</p>
<pre>
    shell&gt; <b>mha-decode -outdir <var>/var/tmp</var> inbox</b>
</pre>
<p>And to decode a single message:</p>
<pre>
    shell&gt; <b>mha-decode -single <var>msg.822</var></b>
</pre>
<p>or from standard input:</p>
<pre>
    shell&gt; <b><var>some_program</var> | mha-decode -single</b>
</pre>
<p>Save out attached messages and then pass them into MHonArc
to be added to a archive:
</p>
<pre>
    shell&gt; <b>mha-decode -dcd-digest -single <var>digest</var></b>
    shell&gt; <b>mhonarc -outdir <var>/path/to/archive</var> -mhpattern '^822.*\.822$' .</b>
</pre>
<p><b>Note:</b> There is a trailing dot, '<tt>.</tt>', at the end of the
called to <b>mhonarc</b> to tell <b>mhonarc</b> to process the
current working directory.
</p>
<p><b>Note:</b> You may need to reset the
<a href="resources/mhpattern.html">MHPATTERN</a> resource if normal
input into the archive is from MH-style mail folders.
</p>

<hr>
<!--X-NavButtons-Start-->
<table width="100%">
<tr valign="top">
<td align="left"><nobr><a href="app-diagnos.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="app-api.html"><img src="next.png" border=0 alt="[Next]"></a></nobr></td></tr></table>
<!--X-NavButtons-End-->

<HR>
<address>
$Date: 2002/05/03 04:30:50 $ <br>
<img align="top" src="monicon.png" alt="">
<a href="http://www.mhonarc.org"
><strong>MHonArc</strong></a><br>
Copyright &#169; 1998-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 -- Appendix: Utility Programs
	5	</TITLE>
	6	</HEAD>
	7	<!--
	8	<BODY background="ssbg75.jpg"
	9	text="#000000" link="#0000ee" vlink="#551a8b" alink="ff0000">
	10	-->
	11	<BODY>
	12
	13	<!--X-NavButtons-Start-->
	14	<table width="100%">
	15	<tr valign="top">
	16	<td align="left"><nobr><a href="app-diagnos.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="app-api.html"><img src="next.png" border=0 alt="[Next]"></a></nobr></td></tr></table>
	17	<!--X-NavButtons-End-->
	18	<HR>
	19
	20	<H1><a name="appendixA">Appendix: Utility Programs</a></H1>
	21
	22	<P>This appendix describes the additional utility programs that
	23	are included in the MHonArc distribution. The utility programs
	24	are installed with <b>mhonarc</b> during the installation process.
	25	</P>
	26
	27	<!--X-TOC-Start-->
	28	<ul>
	29	<li><a href="#mha-dbedit">mha-dbedit</a>
	30	<li><a href="#mha-dbrecover">mha-dbrecover</a>
	31	<ul>
	32	<li><small><a href="#mha-dbrecover-options">Additional Options</a></small>
	33	</ul>
	34	<li><a href="#mha-decode">mha-decode</a>
	35	<ul>
	36	<li><small><a href="#mha-decode-options">Additional Options</a></small>
	37	<li><small><a href="#mha-decode-examples">Examples</a></small>
	38	</ul>
	39	</ul>
	40	<!--X-TOC-End-->
	41
	42	<hr>
	43	<H2><a name="mha-dbedit">mha-dbedit</a></H2>
	44
	45	<P><b>mha-dbedit</b> allows modifications to be made to an archive
	46	database without regenerating any archive pages.
	47	</P>
	48
	49	<p>Typical usage:
	50	</p>
	51	<pre>
	52	shell> <b>mha-dbedit -rcfile <var>res.mrc</var> -outdir <var>/path/to/archive</var></b>
	53	</pre>
	54
	55	<hr>
	56	<H2><a name="mha-dbrecover">mha-dbrecover</a></H2>
	57
	58	<P><b>mha-dbrecover</b> recreates an archive database from the individual
	59	message pages. This program is useful if an archive database gets
	60	corrupted, or accidentally deleted.
	61	</P>
	62
	63	<p>Typical usage:
	64	</p>
65	<pre>
66	shell> <b>mha-dbrecover -outdir <var>/path/to/archive</var></b>
67	</pre>
68
69	<p>If the archive used different resource settings from the defaults
70	for controling filenames, then you must specify those settings when
71	invoking <b>mha-dbrecover</b>. For example, if you are using
72	"<tt>shtml</tt>" for <a href="resources/htmlext.html">HTMLEXT</a>,
73	then you should invoke <b>mha-dbrecover</b> like the following:
74	</p>
75	<pre>
76	shell> <b>mha-dbrecover -htmlext shtml -outdir <var>/path/to/archive</var></b>
77	</pre>
78
79	<p><b>mha-dbrecover</b> will only recreate non-layout message related data.
80	If the archive had resource settings that were different than the
81	the defaults, then those resource settings must be specified when
82	invoking <b>mha-dbrecover</b>. For example:
83	</p>
84	<pre>
85	shell> <b>mha-dbrecover -rcfile <var>res.mrc</var> -outdir <var>/path/to/archive</var></b>
86	</pre>
87
88	<h3><a name="mha-dbrecover-options">Additional Options</a></h3>
89
90	<p><b>mha-dbrecover</b> supports the additional command-line options:
91	</p>
92
93	<dl>
94	<dt><tt>-dbr-startnum <var>#</var></tt></dt>
95	<dd>The starting message number to recover data from. This option is
96	useful if you have many message files in a directory, but you only
97	want to recover a subset of the files.
98	If this option is not specified, the starting number is 0.
99	</dd>
100	</dl>
101	<dl>
102	<dt><tt>-dbr-endnum <var>#</var></tt></dt>
103	<dd>The ending message number to recover data from. This option is
104	useful if you have many message files in a directory, but you only
105	want to recover a subset of the files.
106	If this option is not specified, all messages starting from
107	<tt>-dbr-startnum</tt> will be recovered.
108	</dd>
109	</dl>
110
111	<p>Using the number range options are typically not needed, but may
112	be useful if the archive is maintained with a
113	<a href="resources/maxsize.html">MAXSIZE</a> (or
114	<a href="resources/expireage.html">EXPIREAGE</a>),
115	and
116	<a href="resources/keeponrmm.html">KEEPONRMM</a> is active. The
117	message number range options will allow you to minimize recovering
118	processing by having <b>mha-dbrecover</b> skip messaages that will
119	be dropped from the database due to the
120	<a href="resources/maxsize.html">MAXSIZE</a>,
121	or <a href="resources/expireage.html">EXPIREAGE</a>,
122	setting.
123	</p>
124	<p>For example, say you have an archive directory with 1000 message
125	pages numbered 0 through 999, and the maximum size of the archive
126	is 200. The following command will make recovering more efficient
127	by skipping the first 800 messages since they will be dropped from
128	the database anyway:
129	</p>
130	<pre>
131	shell> <b>mha-dbrecover -dbr-startnum 800 -outdir <var>/path/to/archive</var></b>
132	</pre>
133
134	<table border=0 cellpadding=4>
135	<tr valign=top>
136	<td><strong>NOTE</strong></td>
137	<td><p>It is possible that message number order may not exactly match
138	date order. You may want to increase the number range to take in
139	account of possible anomolies where message number order may vary from
140	message date order.
141	</p>
142	</td>
143	</tr>
144	</table>
145
146	<hr>
147	<H2><a name="mha-decode">mha-decode</a></H2>
148
149	<P><b>mha-decode</b> is a utility program unrelated to MHonArc archives.
150	<b>mha-decode</b> provides basic MIME decoding capabilites for
151	messages.
152	</P>
153	<p>If given mail folders as input, all messages within in the mail
154	folders will be decoded. All message parts are written to files. If a
155	filename is specified for a message part, that filename will be used
156	when writing the part to a file. If no filename is specified in the
157	message, a unique name will be used based upon the content-type of
158	the message part.
159	</p>
160	<p>A single message can be decoded by using the <tt>-single</tt> option.
161	</p>
162
163	Only MHonArc options that affect parsing of mail folders are applicable
164	for <b>mha-decode</b>. The following options are applicable:
165	<tt>-conlen</tt>,
166	<tt>-mhpattern</tt>,
167	<tt>-msgsep</tt>,
168	<tt>-noconlen</tt>,
169	<tt>-outdir</tt>,
170	<tt>-perlinc</tt>,
171	<tt>-rcfile</tt>,
172	<tt>-single</tt>,
173	<tt>-umask</tt>.
174
175	<h3><a name="mha-decode-options">Additional Options</a></h3>
176
177	<p><b>mha-decode</b> supports the additional command-line options:
178	</p>
179
180	<dl>
181	<dt><tt>-dcd-digest</tt></dt>
182	<dd>Do not parse message/rfc822 and message/news attachments.
183	Normally, <b>mha-decode</b> will recursively parse message
184	attachments and decode any parts contained within. With this
185	option, any message attachment encountered will be saved
186	intact.
187	</dd>
188	</dl>
189
190	<h3><a name="mha-decode-examples">Examples</a></h3>
191
192	<p>Basic usage:
193	</p>
194	<pre>
195	shell> <b>mha-decode inbox</b>
196	</pre>
197	<p>Use <tt>-outdir</tt> to have all decoded data placed into a
198	separate directory:
199	</p>
200	<pre>
201	shell> <b>mha-decode -outdir <var>/var/tmp</var> inbox</b>
202	</pre>
203	<p>And to decode a single message:</p>
204	<pre>
205	shell> <b>mha-decode -single <var>msg.822</var></b>
206	</pre>
207	<p>or from standard input:</p>
208	<pre>
209	shell> <b><var>some_program</var> \| mha-decode -single</b>
210	</pre>
211	<p>Save out attached messages and then pass them into MHonArc
212	to be added to a archive:
213	</p>
214	<pre>
215	shell> <b>mha-decode -dcd-digest -single <var>digest</var></b>
216	shell> <b>mhonarc -outdir <var>/path/to/archive</var> -mhpattern '^822.*\.822$' .</b>
217	</pre>
218	<p><b>Note:</b> There is a trailing dot, '<tt>.</tt>', at the end of the
219	called to <b>mhonarc</b> to tell <b>mhonarc</b> to process the
220	current working directory.
221	</p>
222	<p><b>Note:</b> You may need to reset the
223	<a href="resources/mhpattern.html">MHPATTERN</a> resource if normal
224	input into the archive is from MH-style mail folders.
225	</p>
226
227	<hr>
228	<!--X-NavButtons-Start-->
229	<table width="100%">
230	<tr valign="top">
231	<td align="left"><nobr><a href="app-diagnos.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="app-api.html"><img src="next.png" border=0 alt="[Next]"></a></nobr></td></tr></table>
232	<!--X-NavButtons-End-->
233
234	<HR>
235	<address>
236	$Date: 2002/05/03 04:30:50 $ <br>
237	<img align="top" src="monicon.png" alt="">
238	<a href="http://www.mhonarc.org"
239	><strong>MHonArc</strong></a><br>
240	Copyright © 1998-1999, <a href="http://www.mhonarc.org/~ehood/"
241	>Earl Hood</a>, <a href="mailto:mhonarc@mhonarc.org"
242	>mhonarc@mhonarc.org</a><br>
243	</address>
244
245	</BODY>
246	</HTML>