Update of /cvsroot/mhonarc/mhonarc/MHonArc/doc
In directory subversions:/tmp/cvs-serv32717/doc
Modified Files:
app-api.html app-mimeconf.html app-utilsprg.html contacts.html
intro.html layout.html mhonarc.html rcvars.html relnotes.html
Log Message:
* Some doc updates and fixes.
Index: app-api.html
===================================================================
RCS file: /cvsroot/mhonarc/mhonarc/MHonArc/doc/app-api.html,v
retrieving revision 1.8
retrieving revision 1.9
diff -C2 -r1.8 -r1.9
*** app-api.html 24 Nov 2002 04:18:35 -0000 1.8
--- app-api.html 2 Jan 2003 05:46:01 -0000 1.9
***************
*** 6,9 ****
--- 6,10 ----
.cb_head {
font-family: monospace;
+ padding-top: 1em;
border-color: black;
border-style: solid none none none;
***************
*** 26,31 ****
<h1><a name="appendixA">Appendix: Application Programming Interface</a></h1>
! <p>This appendix describes the simple API available to allow the
! embedding of MHonArc within other Perl programs.
</p>
--- 27,32 ----
<h1><a name="appendixA">Appendix: Application Programming Interface</a></h1>
! <p>A simple API is available to allow for embedded usage
! of MHonArc within other Perl programs.
</p>
***************
*** 64,68 ****
<table class="note" width="100%">
<tr valign=top>
! <td><strong>NOTE</strong></td>
<td width="100%"><p>The <tt>mhonarc::initialize()</tt> routine should only be
called once within your program.
--- 65,69 ----
<table class="note" width="100%">
<tr valign=top>
! <td><strong>NOTE:</strong></td>
<td width="100%"><p>The <tt>mhonarc::initialize()</tt> routine should only be
called once within your program.
***************
*** 71,77 ****
</tr>
</table>
<table class="note" width="100%">
<tr valign=top>
! <td><strong>NOTE</strong></td>
<td width="100%"><p>If <tt>mhamain.pl</tt> is not in perl's library search path, you
will need to add the directory path to perl's search path before
--- 72,79 ----
</tr>
</table>
+ <p> </p>
<table class="note" width="100%">
<tr valign=top>
! <td><strong>NOTE:</strong></td>
<td width="100%"><p>If <tt>mhamain.pl</tt> is not in perl's library search path, you
will need to add the directory path to perl's search path before
***************
*** 133,137 ****
<table class="note" width="100%">
<tr valign=top>
! <td><strong>NOTE</strong></td>
<td width="100%"><p>If <tt>$mhonarc::CODE</tt> is equal to <tt>75</tt>, this
indicates that MHonArc was unable to obtain a lock on the archive.
--- 135,139 ----
<table class="note" width="100%">
<tr valign=top>
! <td><strong>NOTE:</strong></td>
<td width="100%"><p>If <tt>$mhonarc::CODE</tt> is equal to <tt>75</tt>, this
indicates that MHonArc was unable to obtain a lock on the archive.
***************
*** 165,169 ****
<table class="note" width="100%">
<tr valign=top>
! <td><strong>NOTE</strong></td>
<td width="100%"><p>The
<a href="install.html#sitelib"><b><tt>mhasiteinit.pl</tt></b></a>
--- 167,171 ----
<table class="note" width="100%">
<tr valign=top>
! <td><strong>NOTE:</strong></td>
<td width="100%"><p>The
<a href="install.html#sitelib"><b><tt>mhasiteinit.pl</tt></b></a>
***************
*** 194,198 ****
<p><b>Synopsis:</b></p>
! <pre>
$do_load = &$mhonarc::CBDbPreLoad($pathname);
</pre>
--- 196,200 ----
<p><b>Synopsis:</b></p>
! <pre class="code">
$do_load = &$mhonarc::CBDbPreLoad($pathname);
</pre>
***************
*** 231,235 ****
<p><b>Synopsis:</b></p>
! <pre>
$do_save = &$mhonarc::CBDbPreSave($pathname, $tmp_pathname);
</pre>
--- 233,237 ----
<p><b>Synopsis:</b></p>
! <pre class="code">
$do_save = &$mhonarc::CBDbPreSave($pathname, $tmp_pathname);
</pre>
***************
*** 279,283 ****
<p><b>Synopsis:</b></p>
! <pre>
&$mhonarc::CBDbSave($db_fh);
</pre>
--- 281,285 ----
<p><b>Synopsis:</b></p>
! <pre class="code">
&$mhonarc::CBDbSave($db_fh);
</pre>
***************
*** 307,311 ****
<p><b>Synopsis:</b></p>
! <pre>
&$mhonarc::CBMessageBodyRead(
$fields_hash_ref, $html_text_ref, $files_array_ref);
--- 309,313 ----
<p><b>Synopsis:</b></p>
! <pre class="code">
&$mhonarc::CBMessageBodyRead(
$fields_hash_ref, $html_text_ref, $files_array_ref);
***************
*** 398,402 ****
</p>
<p><b>Synopsis:</b></p>
! <pre>
$boolean = &$mhonarc::CBMessageHeadRead(
$fields_hash_ref, $raw_header_txt);
--- 400,404 ----
</p>
<p><b>Synopsis:</b></p>
! <pre class="code">
$boolean = &$mhonarc::CBMessageHeadRead(
$fields_hash_ref, $raw_header_txt);
***************
*** 506,510 ****
<p><b>Synopsis:</b></p>
! <pre>
&$mhonarc::CBRawMessageBodyRead($fields_hash_ref, $body_data_ref);
</pre>
--- 508,512 ----
<p><b>Synopsis:</b></p>
! <pre class="code">
&$mhonarc::CBRawMessageBodyRead($fields_hash_ref, $body_data_ref);
</pre>
***************
*** 542,546 ****
<p><b>Synopsis:</b></p>
! <pre>
($result, $do_expand_again, $can_clip) =
&$mhonarc::CBRcVarExpand($mha_index, $var_name, $arg_string);
--- 544,548 ----
<p><b>Synopsis:</b></p>
! <pre class="code">
($result, $do_expand_again, $can_clip) =
&$mhonarc::CBRcVarExpand($mha_index, $var_name, $arg_string);
Index: app-mimeconf.html
===================================================================
RCS file: /cvsroot/mhonarc/mhonarc/MHonArc/doc/app-mimeconf.html,v
retrieving revision 1.13
retrieving revision 1.14
diff -C2 -r1.13 -r1.14
*** app-mimeconf.html 10 Dec 2002 04:08:02 -0000 1.13
--- app-mimeconf.html 2 Jan 2003 05:46:01 -0000 1.14
***************
*** 17,21 ****
<P>This appendix describes how well MHonArc implements
MIME-conformance as defined in
! <a href="http://www.pobox.com/~ehood/MIME/2049/rfc2049.html";>
RFC 2049: (MIME) Part Five: Conformance Criteria and Examples</a>.
Also, additional MIME-related features are summarized.
--- 17,21 ----
<P>This appendix describes how well MHonArc implements
MIME-conformance as defined in
! <a href="http://www.mhonarc.org/~ehood/MIME/2049/rfc2049.html";>
RFC 2049: (MIME) Part Five: Conformance Criteria and Examples</a>.
Also, additional MIME-related features are summarized.
***************
*** 33,42 ****
<p>MIME-conformance is defined in section 2 of
! <a href="http://www.pobox.com/~ehood/MIME/2049/rfc2049.html";>
RFC 2049: (MIME) Part Five: Conformance Criteria and Examples</a>.
Following is the text extracted from section 2 of RFC 2049 with
annotations — denoted by
<strong><img src="monicon.png" alt="MHonArc"></strong> —
! added on how MHonArc conforms to each criteria listed.
It should be noted that the criteria listed in RFC 2049 is geared
towards interactive MUAs; therefore, some criteria may not be
--- 33,42 ----
<p>MIME-conformance is defined in section 2 of
! <a href="http://www.mhonarc.org/~ehood/MIME/2049/rfc2049.html";>
RFC 2049: (MIME) Part Five: Conformance Criteria and Examples</a>.
Following is the text extracted from section 2 of RFC 2049 with
annotations — denoted by
<strong><img src="monicon.png" alt="MHonArc"></strong> —
! added on how well MHonArc conforms to each criteria listed.
It should be noted that the criteria listed in RFC 2049 is geared
towards interactive MUAs; therefore, some criteria may not be
***************
*** 392,397 ****
<td><strong><img src="monicon.png" alt="MHonArc"></strong></td>
<td><p>The
! <a href="resources/mimefilters.html#m2h_text_plain">m2h_text_plain::filter</a>
! supports an option to specify what character set to use if no character
set is specified. By default, US-ASCII is assumed.
</p>
--- 392,397 ----
<td><strong><img src="monicon.png" alt="MHonArc"></strong></td>
<td><p>The
! <a href="resources/defcharset">DEFCHARSET</a> resource
! can be used to specify what character set to use if no character
set is specified. By default, US-ASCII is assumed.
</p>
Index: app-utilsprg.html
===================================================================
RCS file: /cvsroot/mhonarc/mhonarc/MHonArc/doc/app-utilsprg.html,v
retrieving revision 1.20
retrieving revision 1.21
diff -C2 -r1.20 -r1.21
*** app-utilsprg.html 24 Nov 2002 04:18:35 -0000 1.20
--- app-utilsprg.html 2 Jan 2003 05:46:01 -0000 1.21
***************
*** 211,222 ****
prompt> <b>mhonarc <a class="shell" href="resources/outdir.html">-outdir</a> <var>/path/to/archive</var> <a class="shell" href="resources/mhpattern.html">-mhpattern</a> '^822.*\.822$' .</b>
</pre></td></tr></table>
! <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>
! <table class="note" width="100%">
<tr valign=top>
! <td><strong>NOTE</strong></td>
! <td width="100%"><p>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.
--- 211,230 ----
prompt> <b>mhonarc <a class="shell" href="resources/outdir.html">-outdir</a> <var>/path/to/archive</var> <a class="shell" href="resources/mhpattern.html">-mhpattern</a> '^822.*\.822$' .</b>
</pre></td></tr></table>
! <p> </p>
! <table class="note" width="100%">
! <tr valign="baseline">
! <td><strong>NOTE:</strong></td>
! <td width="100%"><p>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>
! </td>
! </tr>
! </table>
! <p> </p>
! <table class="caution" width="100%">
<tr valign=top>
! <td><strong style="color: red;">CAUTION:</strong></td>
! <td width="100%"><p>You will need to reset the
<a href="resources/mhpattern.html">MHPATTERN</a> resource if normal
input into the archive is from MH-style mail folders.
Index: contacts.html
===================================================================
RCS file: /cvsroot/mhonarc/mhonarc/MHonArc/doc/contacts.html,v
retrieving revision 1.25
retrieving revision 1.26
diff -C2 -r1.25 -r1.26
*** contacts.html 24 Nov 2002 04:18:35 -0000 1.25
--- contacts.html 2 Jan 2003 05:46:01 -0000 1.26
***************
*** 51,58 ****
<pre class="code">
subscribe mhonarc-users</pre>
! <p>as the message body.
</p>
! <P>If you send mail
<A HREF="mailto:mhonarc-users(_at_)mhonarc(_dot_)org">mhonarc-users(_at_)mhonarc(_dot_)org</A>,
your message will be distributed to all subscribers on the list.
--- 51,60 ----
<pre class="code">
subscribe mhonarc-users</pre>
! <p>as the message body. A confirmation message will be sent to you.
! Once you confirm your subscription request, you will be subscribed to
! the list.
</p>
! <P>If you send a message to
<A HREF="mailto:mhonarc-users(_at_)mhonarc(_dot_)org">mhonarc-users(_at_)mhonarc(_dot_)org</A>,
your message will be distributed to all subscribers on the list.
***************
*** 62,66 ****
</p>
! <p>If you are subscriber and want to send messages to the list from
different addresses, you can register your alternate addresses to the
<b>mhonarc-allow(_at_)mhonarc(_dot_)org</b> list.
--- 64,68 ----
</p>
! <p>If you are a subscriber and want to send messages to the list from
different addresses, you can register your alternate addresses to the
<b>mhonarc-allow(_at_)mhonarc(_dot_)org</b> list.
***************
*** 153,157 ****
<pre class="code">
subscribe mhonarc-dev</pre>
! <p>as the message body.
</p>
--- 155,161 ----
<pre class="code">
subscribe mhonarc-dev</pre>
! <p>as the message body. A confirmation message will be sent to you.
! Once you confirm your subscription request, you will be subscribed to
! the list.
</p>
Index: intro.html
===================================================================
RCS file: /cvsroot/mhonarc/mhonarc/MHonArc/doc/intro.html,v
retrieving revision 1.19
retrieving revision 1.20
diff -C2 -r1.19 -r1.20
*** intro.html 24 Nov 2002 04:18:35 -0000 1.19
--- intro.html 2 Jan 2003 05:46:01 -0000 1.20
***************
*** 29,55 ****
<H2><a name="whatis">What is MHonArc?</a></H2>
! <P>MHonArc is a highly customizable <A HREF="http://perl.com/perl/";>Perl</A>
! program for converting mail messages as specified in RFC 822 and
! <A HREF="http://www.mhonarc.org/~ehood/MIME/";>the MIME standard</A> to <A
! HREF="http://www.w3.org/pub/WWW/MarkUp/";>HTML</A>.
! MHonArc can perform the following tasks: </P>
!
! <UL>
! <LI>Convert <a href="http://www.ics.uci.edu/~mh/";><em>MH</em></a>
! mail folders or UUCP/Unix style mailboxes into an HTML mail archive.
! <LI>Add or remove messages to an existing HTML mail archive generated
! by MHonArc.
! <LI>Convert a single message to HTML.
! </UL>
!
! <P>Along with these tasks, MHonArc provides the following:
! </P>
!
! <UL>
! <LI>A main customizable index for mail messages archived.
! <LI>A customizable thread index listing messages by thread.
! <LI>Control over message formatting.
! <LI>The ability to hook in your own custom message filters.
! </UL>
<hr>
--- 29,37 ----
<H2><a name="whatis">What is MHonArc?</a></H2>
! <p>MHonArc is a Perl program for converting mail or news messages
! into HTML archives. It can also be used to convert individual
! messages into HTML documents. Other capabilities include robust
! MIME support and powerful user customization features.
! </p>
<hr>
***************
*** 62,71 ****
<LI>You want to keep organized archives
! of mail messages and/or news articles for a <A
HREF="http://www.w3.org/hypertext/WWW/TheProject.html";>World Wide
Web</A> (WWW) server; complete with live hypertext pointers
to their authors and to any url's mentioned.
! <LI>You would like to control the layout of mail/news archives to
keep a consistent style to your WWW pages.
--- 44,53 ----
<LI>You want to keep organized archives
! of mail or news articles for a <A
HREF="http://www.w3.org/hypertext/WWW/TheProject.html";>World Wide
Web</A> (WWW) server; complete with live hypertext pointers
to their authors and to any url's mentioned.
! <LI>You would like to control the layout of your archives to
keep a consistent style to your WWW pages.
Index: layout.html
===================================================================
RCS file: /cvsroot/mhonarc/mhonarc/MHonArc/doc/layout.html,v
retrieving revision 1.22
retrieving revision 1.23
diff -C2 -r1.22 -r1.23
*** layout.html 24 Nov 2002 04:18:35 -0000 1.22
--- layout.html 2 Jan 2003 05:46:01 -0000 1.23
***************
*** 252,257 ****
<td width="100%"><p>After a message is initially converted, the message
header data is static. Changes to resources that affect message header
! layout will only affect messages added after the changes have been
! applied.
</p>
</td>
--- 252,256 ----
<td width="100%"><p>After a message is initially converted, the message
header data is static. Changes to resources that affect message header
! layout will only affect new messages and not existing archived messages.
</p>
</td>
***************
*** 270,275 ****
<td width="100%"><p>After a message is initially converted, the message
body data is static. Changes to resources that affect message body
! appearance will only affect messages added after the changes have been
! applied.
</p>
</td>
--- 269,274 ----
<td width="100%"><p>After a message is initially converted, the message
body data is static. Changes to resources that affect message body
! appearance will only affect news messages and not existing archived
! messages.
</p>
</td>
Index: mhonarc.html
===================================================================
RCS file: /cvsroot/mhonarc/mhonarc/MHonArc/doc/mhonarc.html,v
retrieving revision 1.23
retrieving revision 1.24
diff -C2 -r1.23 -r1.24
*** mhonarc.html 21 Dec 2002 07:26:33 -0000 1.23
--- mhonarc.html 2 Jan 2003 05:46:01 -0000 1.24
***************
*** 15,19 ****
MHonArc</h1>
<p align="center">
! An Email-to-HTML converter.
</p>
--- 15,19 ----
MHonArc</h1>
<p align="center">
! A Mail-to-HTML converter.
</p>
Index: rcvars.html
===================================================================
RCS file: /cvsroot/mhonarc/mhonarc/MHonArc/doc/rcvars.html,v
retrieving revision 1.23
retrieving revision 1.24
diff -C2 -r1.23 -r1.24
*** rcvars.html 31 Dec 2002 05:03:29 -0000 1.23
--- rcvars.html 2 Jan 2003 05:46:01 -0000 1.24
***************
*** 222,226 ****
<dt><a name="mesg_spec"><b><i><tt>mesg_spec</tt></i></b></a></dt>
<dd><p>A message specification determines which message the variable's
! expanded will be based upon. Possible values are:
</p>
<table border=0>
--- 222,226 ----
<dt><a name="mesg_spec"><b><i><tt>mesg_spec</tt></i></b></a></dt>
<dd><p>A message specification determines which message the variable's
! expanded value will be based upon. Possible values are:
</p>
<table border=0>
***************
*** 254,262 ****
<tr valign=top>
<td align=right><tt>TFIRST</tt> -</td>
! <td>First message listed thread index.</td>
</tr>
<tr valign=top>
<td align=right><tt>TLAST</tt> -</td>
! <td>Last message listed thread index.</td>
</tr>
<tr valign=top>
--- 254,262 ----
<tr valign=top>
<td align=right><tt>TFIRST</tt> -</td>
! <td>First message listed in thread index.</td>
</tr>
<tr valign=top>
<td align=right><tt>TLAST</tt> -</td>
! <td>Last message listed in thread index.</td>
</tr>
<tr valign=top>
Index: relnotes.html
===================================================================
RCS file: /cvsroot/mhonarc/mhonarc/MHonArc/doc/relnotes.html,v
retrieving revision 1.13
retrieving revision 1.14
diff -C2 -r1.13 -r1.14
*** relnotes.html 21 Dec 2002 07:26:33 -0000 1.13
--- relnotes.html 2 Jan 2003 05:46:01 -0000 1.14
***************
*** 178,189 ****
<tr valign="baseline">
<td><strong style="color: red;">CAUTION:</strong></td>
! <td width="100%"><p>Downgrading to an earlier version of MHonArc can be
! <strong>dangerous</strong>, especially if downgrading to an older
! version that
! used different storage formats in archive database files from
the current version in use.
- If an older version of MHonArc is
- used to process an archive last modified by a newer version, archive
- data can get lost and/or unexpected output can occur.
</p>
</td>
--- 178,186 ----
<tr valign="baseline">
<td><strong style="color: red;">CAUTION:</strong></td>
! <td width="100%"><p>Downgrading to an earlier version of MHonArc can
! <strong>corrupt</strong> your archives, especially when downgrading to
! an older version that
! used different database file storage formats from
the current version in use.
</p>
</td>
***************
*** 233,238 ****
for the <a href="resources/mimefilters.html#m2h_text_plain::filter"
><tt>m2h_text_plain::filter</tt></a> has been removed. The
! <a href="resources/defcharset.html">DEFCHARSET</a> resource can
! be used.
</p>
--- 230,235 ----
for the <a href="resources/mimefilters.html#m2h_text_plain::filter"
><tt>m2h_text_plain::filter</tt></a> has been removed. The
! <a href="resources/defcharset.html">DEFCHARSET</a> can
! be used instead.
</p>
***************
*** 267,271 ****
the <tt>MHonArc::CharEnt</tt> module in v2.5. The old <tt>iso8859.pl</tt>
library is still provided for compatibility with older
! archives. To update archives to use the new settings, you
can run the following command,
</p>
--- 264,271 ----
the <tt>MHonArc::CharEnt</tt> module in v2.5. The old <tt>iso8859.pl</tt>
library is still provided for compatibility with older
! archives, and with v2.6, <tt>iso8859.pl</tt> directly invokes
! <tt>MHonArc::CharEnt</tt>.
! </p>
! <p>To update archives to use the new settings, you
can run the following command,
</p>
---------------------------------------------------------------------
To sign-off this list, send email to majordomo(_at_)mhonarc(_dot_)org with the
message text UNSUBSCRIBE MHONARC-DEV