Update of /home/users/mhonarc.org/ehood/cvs/mhonarc/mhonarc/MHonArc/doc
In directory denethor.mallorn.com:/tmp/cvs-serv31387
Modified Files:
commontasks.html install.html layout.html quickstart.html
relnotes.html resources.html
Log Message:
Some doc updates and fixes.
Index: commontasks.html
===================================================================
RCS file: /home/users/mhonarc.org/ehood/cvs/mhonarc/mhonarc/MHonArc/doc/commontasks.html,v
retrieving revision 1.18
retrieving revision 1.19
diff -C2 -r1.18 -r1.19
*** commontasks.html 6 Oct 2003 22:04:14 -0000 1.18
--- commontasks.html 13 May 2005 00:00:35 -0000 1.19
***************
*** 43,53 ****
you may have noticed that the titles of the main (date)
and thread index pages are not very descriptive: "Mail Index"
! and "Mail Thread Index". It would be much nicer if the the
! titles reflect what type of mail is in the archive.
! </p>
! <p>MHonArc allows you to change the titles via the
<a href="resources/title.html"><tt>-title</tt></a> and
! <a href="resources/ttitle.html"><tt>-ttitle</tt></a> options.
! The <a href="resources/title.html"><tt>-title</tt></a> option sets
main index title, and the
<a href="resources/ttitle.html"><tt>-ttitle</tt></a> option sets
--- 43,54 ----
you may have noticed that the titles of the main (date)
and thread index pages are not very descriptive: "Mail Index"
! and "Mail Thread Index", respectively.
! MHonArc allows you to change the titles via the
<a href="resources/title.html"><tt>-title</tt></a> and
! <a href="resources/ttitle.html"><tt>-ttitle</tt></a> options so the
! index page titles provide a better reflection of the type of mail
! archived.
! </p>
! <p>The <a href="resources/title.html"><tt>-title</tt></a> option sets
main index title, and the
<a href="resources/ttitle.html"><tt>-ttitle</tt></a> option sets
***************
*** 101,105 ****
<p>For example, to get a reverse chronological listing,
! do something like the following:
</p>
<table border=1 width="100%"><tr><td><pre class="shell">
--- 102,106 ----
<p>For example, to get a reverse chronological listing,
! do the following:
</p>
<table border=1 width="100%"><tr><td><pre class="shell">
***************
*** 118,129 ****
<p>MHonArc supports the ability to automatically remove archive messages
! that are older than a specified time period, are older than
! a specified date/time, or the number of messages have reached the maximum
! number specified.
</p>
</p>For example, if you want an archive to only
! contain messages that are less than a month, you can do something
! like the following:
</p>
<table border=1 width="100%"><tr><td><pre class="shell">
--- 119,129 ----
<p>MHonArc supports the ability to automatically remove archive messages
! older than a specified time period, older than
! a specified date/time, or by exceeding a specified maximum number.
</p>
</p>For example, if you want an archive to only
! contain messages that are less than a month old, do
! the following:
</p>
<table border=1 width="100%"><tr><td><pre class="shell">
***************
*** 134,139 ****
to tell MHonArc to remove messages older than 2635200 seconds (30.5 days) when
adding new messages.
! I know, having to use seconds to specify the expiration age seems cumbersome.
! A table is provided in the <a href="resources/expireage.html">EXPIREAGE</a>
reference page listing common time periods and their equivalence in seconds.
</p>
--- 134,140 ----
to tell MHonArc to remove messages older than 2635200 seconds (30.5 days) when
adding new messages.
! Having to use seconds to specify the expiration age may be cumbersome,
! therefore, a table is provided in the
! <a href="resources/expireage.html">EXPIREAGE</a>
reference page listing common time periods and their equivalence in seconds.
</p>
***************
*** 142,147 ****
<a href="resources/expiredate.html"><tt>-expiredate</tt></a> option.
This allows
! you to specify an exact date/time where any messages older than the
! given date/time, will be automatically removed. For example:
</p>
<table border=1 width="100%"><tr><td><pre class="shell">
--- 143,148 ----
<a href="resources/expiredate.html"><tt>-expiredate</tt></a> option.
This allows
! you to specify an exact date/time where any messages older
! will be automatically removed. For example:
</p>
<table border=1 width="100%"><tr><td><pre class="shell">
***************
*** 154,158 ****
</p>
! <p>An archive can also have a maximum number of messages limit.
When the maximum number is reached, the oldest messages are automatically
removed. The following is an example of setting the maximum size
--- 155,159 ----
</p>
! <p>An archive can also have a maximum number limit.
When the maximum number is reached, the oldest messages are automatically
removed. The following is an example of setting the maximum size
***************
*** 165,173 ****
<h3><a name="manualrmm">Manual Removal</a></h3>
! <p>Sometimes it becomes necessary to remove specific messages from archive.
! For example, their may be some spam messages and you do not want them
! cluttering your archive (and providing free advertising). Or, there
! may be archived messages that you believe are not appropriate for
! the archive's intended audience.
</p>
<p>To remove specific messages, use the
--- 166,172 ----
<h3><a name="manualrmm">Manual Removal</a></h3>
! <p>Sometimes it becomes necessary to remove specific messages from archive:
! Their may be some spam messages cluttering up your archive, or there
! may be messages not appropriate for the archive's intended audience.
</p>
<p>To remove specific messages, use the
***************
*** 179,190 ****
<p>will delete messages 24, 28, 39, and 48.
</p>
! <p>You are now asking, "How do I know what a message's number is?". One
! way is to look at the number in the message's filename. I.e. Each
! converted message is writting to a filename containing the number of
message. For example, <tt>msg00024.html</tt>,
<tt>msg00028.html</tt>, <tt>msg00039.html</tt>, and <tt>msg00048.html</tt>
denote messages 24, 28, 39, and 48.
</p>
! <p>Checking filenames can be awkward, so one alternative is to use
the <a href="resources/scan.html"><tt>-scan</tt></a> option. For example:
</p>
--- 178,188 ----
<p>will delete messages 24, 28, 39, and 48.
</p>
! <p>The number assigned to a message is part of the message's filename.
! Each converted message is writting to a filename containing the number of
message. For example, <tt>msg00024.html</tt>,
<tt>msg00028.html</tt>, <tt>msg00039.html</tt>, and <tt>msg00048.html</tt>
denote messages 24, 28, 39, and 48.
</p>
! <p>Checking filenames can be awkward, an alternative is to use
the <a href="resources/scan.html"><tt>-scan</tt></a> option. For example:
</p>
***************
*** 234,246 ****
<p>One of the most powerful features of MHonArc is the ability to
! customize the layout of pages generated by MHonArc. Here, we give
a quick introduction on how customization can be done. For more
! information, see the <cite><a href="layout.html">Page Layout</a></cite>
! section.
</p>
! <p>In this introduction, the task we will be performing is to
! add a footer at the bottom of each page in the archive to
! contain the following markup:
</p>
<pre class="code">
--- 232,243 ----
<p>One of the most powerful features of MHonArc is the ability to
! customize the layout of pages. In this section, we give
a quick introduction on how customization can be done. For more
! information, see <cite><a href="layout.html">Page Layout</a></cite>.
</p>
! <p>In this introduction, we want to
! add a footer at the bottom of each page containing
! the following markup:
</p>
<pre class="code">
***************
*** 249,262 ****
</pre>
! <p>To modify page layout, we will need to create a
! <a href="resources/rcfile.html">resource file</a> and give it a
! filename "<tt>myresource.mrc</tt>". The name we give the file is
! completely arbitrary. There is nothing special about the name
! "<tt>myresource.mrc</tt>".
! </p>
!
! <p>Within <tt>myresource.mrc</tt>,
! we add the following to tell MHonArc to include our footer at the
! bottom of each page:
</p>
<pre class="code">
--- 246,252 ----
</pre>
! <p>Create a new file called
! "<tt>myresource.mrc</tt>" and edit <tt>myresource.mrc</tt> to include
! the following:
</p>
<pre class="code">
***************
*** 294,299 ****
</pre>
! <p>Now, when we invoke <tt>mhonarc</tt>, we tell it about our resource
! file so our footer will show up:
</p>
<table border=1 width="100%"><tr><td><pre class="shell">
--- 284,295 ----
</pre>
! <p>The file you created is formally called a
! <a href="resources/rcfile.html">resource file</a>. A resource file
! is a plain text file containing resource settings affecting the
! behavior of MHonArc. In this case, the resource defined above tells
! MHonArc to include our custom footer on all pages.
! </p>
! <p>To inform MHonArc about your resource file, you must
! specify it when invoking <tt>mhonarc</tt>:
</p>
<table border=1 width="100%"><tr><td><pre class="shell">
***************
*** 315,319 ****
<img align="top" src="monicon.png" alt="">
<a href="http://www.mhonarc.org/";><strong>MHonArc</strong></a><br>
! Copyright © 1997-1999, <a href="http://www.mhonarc.org/~ehood/";
>Earl Hood</a>, <a href="mailto:mhonarc%40mhonarc.org";
>mhonarc<!--
--- 311,315 ----
<img align="top" src="monicon.png" alt="">
<a href="http://www.mhonarc.org/";><strong>MHonArc</strong></a><br>
! Copyright © 1997-2005 <a href="http://www.mhonarc.org/~ehood/";
>Earl Hood</a>, <a href="mailto:mhonarc%40mhonarc.org";
>mhonarc<!--
Index: install.html
===================================================================
RCS file: /home/users/mhonarc.org/ehood/cvs/mhonarc/mhonarc/MHonArc/doc/install.html,v
retrieving revision 1.23
retrieving revision 1.24
diff -C2 -r1.23 -r1.24
*** install.html 7 May 2004 22:18:07 -0000 1.23
--- install.html 13 May 2005 00:00:35 -0000 1.24
***************
*** 190,199 ****
<ul>
<li><p><b>Digest::MD5</b>: Used for creating IDs for messages without
! message-ids. Normally, messages define a unique message-id, however,
! there are some use cases where message-ids are not present. Therefore,
! this module helps MHonArc detect already
! archived messages for messages without message-ids. If
! <tt>Digest::MD5</tt> is not available, MHonArc will be unable to
! detect for duplicate messages that do not contain message-ids.
</p>
</li>
--- 190,196 ----
<ul>
<li><p><b>Digest::MD5</b>: Used for creating IDs for messages without
! message-ids. MHonArc uses message-IDs to detect for already-archived
! or duplicate messages. <tt>Digest::MD5</tt> gives MHonArc this
! capability for messages without message-IDs.
</p>
</li>
***************
*** 202,206 ****
If <tt>File::Temp</tt> is not available, MHonArc will use its own
internal implementation, which is not as secure as <tt>File::Temp</tt>,
! but it should be adequate for most uses.
</p>
</li>
--- 199,203 ----
If <tt>File::Temp</tt> is not available, MHonArc will use its own
internal implementation, which is not as secure as <tt>File::Temp</tt>,
! but adequate for most uses.
</p>
</li>
***************
*** 286,291 ****
<p><a href="http://www.rpm.org/";>RPM</a> is a widely used software
! package manager for various Linux-based systems and sometimes used
! for other Unix-based environments. If the software on your system is
managed by RPM, you may prefer to install MHonArc via RPM:
</p>
--- 283,288 ----
<p><a href="http://www.rpm.org/";>RPM</a> is a widely used software
! package manager for various Linux-based systems and other
! Unix-based environments. If the software on your system is
managed by RPM, you may prefer to install MHonArc via RPM:
</p>
***************
*** 377,383 ****
</table>
! <p>After downloading the MHonArc distribution, it is best to move
! the file to a temporary location for extraction. To extract the
! distribution under Unix-like systems, use one of the following commands
based upon the distribution format you downloaded:
</p>
--- 374,380 ----
</table>
! <p>After downloading the MHonArc distribution, move
! the file to a temporary location for extraction. For extraction
! under Unix-like systems, use one of the following commands
based upon the distribution format you downloaded:
</p>
***************
*** 399,403 ****
<p>For Win32 systems, you can use a program like <em>WinZip</em> to
extract the tar-gzip or zip formats. If using
! <a href="http://www.cygwin.com/";>Cygwin</a>, you can use
the Unix-based extraction methods.
</p>
--- 396,400 ----
<p>For Win32 systems, you can use a program like <em>WinZip</em> to
extract the tar-gzip or zip formats. If using
! <a href="http://www.cygwin.com/";>Cygwin</a>, use
the Unix-based extraction methods.
</p>
***************
*** 429,433 ****
<p>Now, change your current directory to <tt>MHonArc-<var>X.X.X</var></tt>
for the <a href="#installingfiles">next step</a>. On a Unix-type
! system, the following command will do it:
</p>
<table border=1 width="100%"><tr><td><pre class="shell">
--- 426,430 ----
<p>Now, change your current directory to <tt>MHonArc-<var>X.X.X</var></tt>
for the <a href="#installingfiles">next step</a>. On a Unix-type
! system, use the following command:
</p>
<table border=1 width="100%"><tr><td><pre class="shell">
***************
*** 466,470 ****
<td width="100%"><p>The default
values are determined by the configuration of perl on your system.
! If you choose the defaults, you may need to possess root/admin privileges.
</p>
</td>
--- 463,468 ----
<td width="100%"><p>The default
values are determined by the configuration of perl on your system.
! If you choose the defaults, you may need root/admin privileges to successfully
! install MHonArc.
</p>
</td>
***************
*** 795,799 ****
<img align="top" src="monicon.png" alt="">
<a href="http://www.mhonarc.org/";><strong>MHonArc</strong></a><br>
! Copyright © 1997-2003, <a href="http://www.mhonarc.org/~ehood/";
>Earl Hood</a>, <a href="mailto:mhonarc%40mhonarc.org";
>mhonarc<!--
--- 793,797 ----
<img align="top" src="monicon.png" alt="">
<a href="http://www.mhonarc.org/";><strong>MHonArc</strong></a><br>
! Copyright © 1997-2003,2005 <a href="http://www.mhonarc.org/~ehood/";
>Earl Hood</a>, <a href="mailto:mhonarc%40mhonarc.org";
>mhonarc<!--
Index: layout.html
===================================================================
RCS file: /home/users/mhonarc.org/ehood/cvs/mhonarc/mhonarc/MHonArc/doc/layout.html,v
retrieving revision 1.24
retrieving revision 1.25
diff -C2 -r1.24 -r1.25
*** layout.html 6 Oct 2003 22:04:14 -0000 1.24
--- layout.html 13 May 2005 00:00:35 -0000 1.25
***************
*** 18,25 ****
<p>The section describes the layout of the pages created by
MHonArc. Each page's layout is controled by
! <a href="resources.html">resources</a>
! (see Section <a href="resources.html">Resources</a>). Layout
resources can be changed as you see fit to achieve the
! appearence you desire for your mail archives.
<!--X-TOC-Start-->
--- 18,24 ----
<p>The section describes the layout of the pages created by
MHonArc. Each page's layout is controled by
! <a href="resources.html">resources</a>. Layout
resources can be changed as you see fit to achieve the
! appearance you desire.
<!--X-TOC-Start-->
***************
*** 217,226 ****
<p>Message pages also contain comment declarations. Some of the
comment declarations are vital markers to allow MHonArc
! to properly edit the message when needed during updates.
</p>
<h3><a name="msgheaderlayout">Converted message header</a></h3>
! <p>The format of converted message headers are determined by the
following resource layout:
</p>
--- 216,225 ----
<p>Message pages also contain comment declarations. Some of the
comment declarations are vital markers to allow MHonArc
! to properly edit the message during updates.
</p>
<h3><a name="msgheaderlayout">Converted message header</a></h3>
! <p>The format of converted message headers is determined by the
following resource layout:
</p>
***************
*** 338,342 ****
<a href="http://www.mhonarc.org";
><strong>MHonArc</strong></a><br>
! Copyright © 1997-1999, <a href="http://www.mhonarc.org/~ehood/";
>Earl Hood</a>, <a href="mailto:mhonarc%40mhonarc.org";
>mhonarc<!--
--- 337,341 ----
<a href="http://www.mhonarc.org";
><strong>MHonArc</strong></a><br>
! Copyright © 1997-1999,2005 <a href="http://www.mhonarc.org/~ehood/";
>Earl Hood</a>, <a href="mailto:mhonarc%40mhonarc.org";
>mhonarc<!--
Index: quickstart.html
===================================================================
RCS file: /home/users/mhonarc.org/ehood/cvs/mhonarc/mhonarc/MHonArc/doc/quickstart.html,v
retrieving revision 1.18
retrieving revision 1.19
diff -C2 -r1.18 -r1.19
*** quickstart.html 6 Oct 2003 22:04:14 -0000 1.18
--- quickstart.html 13 May 2005 00:00:35 -0000 1.19
***************
*** 86,94 ****
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>
--- 86,94 ----
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
! by the date. </P>
<LI><P><tt><strong>threads.html</strong></tt>:
! The file listing messages by threads.
</P>
***************
*** 233,237 ****
<a href="http://www.mhonarc.org";
><strong>MHonArc</strong></a><br>
! Copyright © 1997-1999, <a href="http://www.mhonarc.org/~ehood/";
>Earl Hood</a>, <a href="mailto:mhonarc%40mhonarc.org";
>mhonarc<!--
--- 233,237 ----
<a href="http://www.mhonarc.org";
><strong>MHonArc</strong></a><br>
! Copyright © 1997-1999, 2005, <a href="http://www.mhonarc.org/~ehood/";
>Earl Hood</a>, <a href="mailto:mhonarc%40mhonarc.org";
>mhonarc<!--
Index: relnotes.html
===================================================================
RCS file: /home/users/mhonarc.org/ehood/cvs/mhonarc/mhonarc/MHonArc/doc/relnotes.html,v
retrieving revision 1.19
retrieving revision 1.20
diff -C2 -r1.19 -r1.20
*** relnotes.html 11 May 2005 04:46:48 -0000 1.19
--- relnotes.html 13 May 2005 00:00:35 -0000 1.20
***************
*** 324,329 ****
filter argument is specified.
</p>
! <p>The new behavior prevents malicious URLs used to verify
! mail addresses for spam purposes, secretly set cookies, or
gather some statistical data without the explicit consent of
the reader.
--- 324,329 ----
filter argument is specified.
</p>
! <p>The new behavior prevents malicious URLs being used to verify
! mail addresses, secretly setting cookies, or
gather some statistical data without the explicit consent of
the reader.
***************
*** 371,375 ****
a new message is added, make sure the before and after ranges
specified for <a href="resources/tslice.html">TSLICE</a> is
! equal to maximum before and the maximum after range arguments
specifed in the uses of the
<a href="rcvars.html#TSLICE"><tt>$TSLICE$</tt></a> resource
--- 371,375 ----
a new message is added, make sure the before and after ranges
specified for <a href="resources/tslice.html">TSLICE</a> is
! equal to the maximum-before and the maximum-after range arguments
specifed in the uses of the
<a href="rcvars.html#TSLICE"><tt>$TSLICE$</tt></a> resource
***************
*** 461,465 ****
<img align="top" src="monicon.png" alt="">
<a href="http://www.mhonarc.org/";><strong>MHonArc</strong></a><br>
! Copyright © 1997-2002, <a href="http://www.mhonarc.org/~ehood/";
>Earl Hood</a>, <a href="mailto:mhonarc%40mhonarc.org";
>mhonarc<!--
--- 461,465 ----
<img align="top" src="monicon.png" alt="">
<a href="http://www.mhonarc.org/";><strong>MHonArc</strong></a><br>
! Copyright © 1997-2005, <a href="http://www.mhonarc.org/~ehood/";
>Earl Hood</a>, <a href="mailto:mhonarc%40mhonarc.org";
>mhonarc<!--
Index: resources.html
===================================================================
RCS file: /home/users/mhonarc.org/ehood/cvs/mhonarc/mhonarc/MHonArc/doc/resources.html,v
retrieving revision 1.36
retrieving revision 1.37
diff -C2 -r1.36 -r1.37
*** resources.html 6 Oct 2003 22:04:15 -0000 1.36
--- resources.html 13 May 2005 00:00:35 -0000 1.37
***************
*** 29,33 ****
<h2><a name="overview">Overview</a></h2>
! <p>All the behavior of MHonArc is controlled by resources.
Resources may be set via environment variables (<em>envariables</em>
for short), command-line options, and/or elements in a
--- 29,33 ----
<h2><a name="overview">Overview</a></h2>
! <p>All MHonArc behavior is controlled by resources.
Resources may be set via environment variables (<em>envariables</em>
for short), command-line options, and/or elements in a
***************
*** 128,137 ****
the actual description of the resource may not be applicable for
the version number listed. I.e. The behavior of the resource may
! have changed in later releases. Therefore, the description of
! the resource may be applicable for a later version of MHonArc than
! from the version of MHonArc the resource first came available.
</p></dd>
<dt><strong>See Also</strong></dt>
! <dd><p>Links to any related resources.
</p></dd>
</dl>
--- 128,135 ----
the actual description of the resource may not be applicable for
the version number listed. I.e. The behavior of the resource may
! have changed in later releases.
</p></dd>
<dt><strong>See Also</strong></dt>
! <dd><p>Links to related documentation.
</p></dd>
</dl>
---------------------------------------------------------------------
To sign-off this list, send email to majordomo(_at_)mhonarc(_dot_)org with the
message text UNSUBSCRIBE MHONARC-COMMITS