Update of /home/users/mhonarc.org/ehood/cvs/mhonarc/mhonarc/MHonArc/doc/resources
In directory denethor.mallorn.com:/tmp/cvs-serv31387/resources
Modified Files:
add.html addressmodifycode.html afs.html rcfile.html rmm.html
scan.html
Log Message:
Some doc updates and fixes.
Index: add.html
===================================================================
RCS file: /home/users/mhonarc.org/ehood/cvs/mhonarc/mhonarc/MHonArc/doc/resources/add.html,v
retrieving revision 1.14
retrieving revision 1.15
diff -C2 -r1.14 -r1.15
*** add.html 6 Oct 2003 22:04:15 -0000 1.14
--- add.html 13 May 2005 00:00:36 -0000 1.15
***************
*** 54,58 ****
<p>The ADD resource instructs <em>MHonArc</em> to add messages
! to an existing archive. The archive specified does not exist,
<em>MHonArc</em> will automatically create the archive. If input
is coming from standard in, then the input is treated as a single
--- 54,58 ----
<p>The ADD resource instructs <em>MHonArc</em> to add messages
! to an existing archive. If the archive specified does not exist,
<em>MHonArc</em> will automatically create the archive. If input
is coming from standard in, then the input is treated as a single
***************
*** 61,66 ****
<p>When adding, <em>MHonArc</em> will skip any messages that
! already exists in the archive. This allows one to have <em>MHonArc</em>
! rescan a mail folder to only add any new messages found.
</p>
--- 61,66 ----
<p>When adding, <em>MHonArc</em> will skip any messages that
! already exists in the archive: allowing <em>MHonArc</em>
! to rescan a mail folder to add only new messages found.
</p>
Index: addressmodifycode.html
===================================================================
RCS file: /home/users/mhonarc.org/ehood/cvs/mhonarc/mhonarc/MHonArc/doc/resources/addressmodifycode.html,v
retrieving revision 1.15
retrieving revision 1.16
diff -C2 -r1.15 -r1.16
*** addressmodifycode.html 6 Oct 2003 22:04:16 -0000 1.15
--- addressmodifycode.html 13 May 2005 00:00:36 -0000 1.16
***************
*** 97,101 ****
<h2><a name="examples">Examples</a></h2>
! <p>ADDRESSMODIFYCODE main use is to obfuscate addresses,
or hide them entirely, to
prevent spam address harvesters from getting user addresses from
--- 97,101 ----
<h2><a name="examples">Examples</a></h2>
! <p>ADDRESSMODIFYCODE's main use is to obfuscate addresses,
or hide them entirely, to
prevent spam address harvesters from getting user addresses from
***************
*** 121,125 ****
<p>You cannot rely on ADDRESSMODIFYCODE alone to
hide/obfuscate addresses (see <a href="#note1">NOTE</a> above).
! Also look at the <a href="spammode.html">SPAMMODE</a> if you are
interested in fighting address harvesting.
</p>
--- 121,125 ----
<p>You cannot rely on ADDRESSMODIFYCODE alone to
hide/obfuscate addresses (see <a href="#note1">NOTE</a> above).
! See the <a href="spammode.html">SPAMMODE</a> resource if you are
interested in fighting address harvesting.
</p>
Index: afs.html
===================================================================
RCS file: /home/users/mhonarc.org/ehood/cvs/mhonarc/mhonarc/MHonArc/doc/resources/afs.html,v
retrieving revision 1.12
retrieving revision 1.13
diff -C2 -r1.12 -r1.13
*** afs.html 6 Oct 2003 22:04:16 -0000 1.12
--- afs.html 13 May 2005 00:00:36 -0000 1.13
***************
*** 52,56 ****
<h2><a name="description">Description</a></h2>
! <p>If AFS is set, MHonArc is skips the archive directory permission
check. The resource gets its name from the Andrew File System (AFS)
since standard Unix permission checks are not adequate to verify
--- 52,56 ----
<h2><a name="description">Description</a></h2>
! <p>If AFS is set, MHonArc skips the archive directory permission
check. The resource gets its name from the Andrew File System (AFS)
since standard Unix permission checks are not adequate to verify
Index: rcfile.html
===================================================================
RCS file: /home/users/mhonarc.org/ehood/cvs/mhonarc/mhonarc/MHonArc/doc/resources/rcfile.html,v
retrieving revision 1.16
retrieving revision 1.17
diff -C2 -r1.16 -r1.17
*** rcfile.html 6 Oct 2003 22:04:20 -0000 1.16
--- rcfile.html 13 May 2005 00:00:36 -0000 1.17
***************
*** 57,64 ****
<h2><a name="description">Description</a></h2>
! <p>RCFILE tells MHonArc what the resource file is.
! The resource file allows you to specify most of the resources set by
! environment variables and command-line options, and it allows you to specify
! other resources to control MHonArc's behavior.
</p>
--- 57,64 ----
<h2><a name="description">Description</a></h2>
! <p>RCFILE tells MHonArc what resource files to load.
! A resource file allows you to specify most of the resources set by
! environment variables and command-line options along with other
! resources to control MHonArc's behavior.
</p>
***************
*** 77,82 ****
<P>Resources are set in the file by using <EM>elements</EM> similiar
! in style to HTML/SGML markup. However, MHonArc uses simpler
! parsing rules for the resource file than standard SGML: </P>
<UL>
--- 77,82 ----
<P>Resources are set in the file by using <EM>elements</EM> similiar
! in style to HTML/XML markup. However, MHonArc uses simpler
! parsing rules for the resource file than standard XML: </P>
<UL>
***************
*** 90,94 ****
<tr valign=top>
<td><strong>NOTE:</strong></td>
! <td width="100%"><p>You should use SGML comment declarations
(<CODE><!-- </CODE>...<CODE> --></CODE>) when commenting a
resource file. This will eliminate possible conflicts
--- 90,94 ----
<tr valign=top>
<td><strong>NOTE:</strong></td>
! <td width="100%"><p>You should use XML comment declarations
(<CODE><!-- </CODE>...<CODE> --></CODE>) when commenting a
resource file. This will eliminate possible conflicts
***************
*** 100,104 ****
<br>
! <LI><P>The opening tag of an element must occur by itself on a
single line.</P>
<p><b>Correct</b>:
--- 100,104 ----
<br>
! <LI><P>The open tag of an element must occur by itself on a
single line.</P>
<p><b>Correct</b>:
***************
*** 152,164 ****
<LI><P>Some elements can take an optional attribute called
! "<CODE>Override</CODE>", if applicable. This tells MHonArc
that the contents of the element will completely override the default
! behavior of MHonArc, and previous instances of the element, for
! example: "<tt class="icode"><EXCS Override></tt>". If
"<tt class="icode">Override</tt>" is not specified, then the contents of the
element augment the current setting. </P>
<LI><P>Some elements can take an optional attribute called
! "<CODE>Chop</CODE>", if applicable. This tells MHonArc
to remove the last line-break of the element's content.
</P>
--- 152,164 ----
<LI><P>Some elements can take an optional attribute called
! "<CODE>Override</CODE>". This tells MHonArc
that the contents of the element will completely override the default
! behavior of MHonArc and previous instances of the element. Example:
! "<tt class="icode"><EXCS Override></tt>". If
"<tt class="icode">Override</tt>" is not specified, then the contents of the
element augment the current setting. </P>
<LI><P>Some elements can take an optional attribute called
! "<CODE>Chop</CODE>". This tells MHonArc
to remove the last line-break of the element's content.
</P>
***************
*** 170,174 ****
</P>
! <LI><P>Elements can<b>NOT</b> be nested. Many resources define
the values of <a href="../rcvars.html">resource variables</a>, which
may be used within resource elements:
--- 170,174 ----
</P>
! <LI><P>Elements <b>CANNOT</b> be nested. Many resources define
the values of <a href="../rcvars.html">resource variables</a>, which
may be used within resource elements:
***************
*** 210,222 ****
<p>Many resources are allowed to have <em>resource variables</em> as
part of there content. Resource variables represent data that
! can only be defined during run-time. I.e. Resource variables
! will get expanded to an appropriate value during the execution
of MHonArc. For more information on resource variables, see
! the section: <a href="../rcvars.html">Resource Variables</a>.
! </p>
!
! <p>The description for each resource will contain a list
! of all applicable variables that may be used in defining the
! resource's value.
</p>
--- 210,217 ----
<p>Many resources are allowed to have <em>resource variables</em> as
part of there content. Resource variables represent data that
! defined during run-time: resource variables
! will get expanded to the appropriate value during the execution
of MHonArc. For more information on resource variables, see
! <cite><a href="../rcvars.html">Resource Variables</a></cite>.
</p>
***************
*** 225,229 ****
<p>MHonArc supports the ability to define locale specific variations
of a resource file based upon the <a href="lang.html">LANG</a> resource
! setting. For example, take the following command-line invocation:
</p>
<table border="1" width="100%"><tr><td><pre class="shell">
--- 220,224 ----
<p>MHonArc supports the ability to define locale specific variations
of a resource file based upon the <a href="lang.html">LANG</a> resource
! setting. For example:
</p>
<table border="1" width="100%"><tr><td><pre class="shell">
***************
*** 257,269 ****
<a href="include.html">INCLUDE</a> and
<a href="otherindexes.html">OTHERINDEXES</a>
! resource.
</p>
</td>
</tr>
</table>
! <p>Therefore, if you manage multiple archives comprising multiple languages,
! you can define generic settings in a shared resource file and then define
! language-specific overrides and/or variations. Continuing with the
! previous example, the following invocation can be used for a French Canadian
archive:
</p>
--- 252,262 ----
<a href="include.html">INCLUDE</a> and
<a href="otherindexes.html">OTHERINDEXES</a>
! resources.
</p>
</td>
</tr>
</table>
! <p>Continuing with the
! previous example, the following specifies a French-Canadian
archive:
</p>
***************
*** 292,299 ****
</ol>
! <p>By leveraging the use of custom <a href="definevar.html">resource
variables</a>, you can parameterize textual labels so the locale-specific
resource files only need to define variable values instead of redefining
! layout. For example, take the following default value of the
<a href="nextbutton.html">NEXTBUTTON</a> resource:
</p>
--- 285,296 ----
</ol>
! <p>If you manage multiple archives comprising multiple languages,
! you can define generic settings in a shared resource file and define
! language-specific overrides and/or variations in locale-specific
! resource files. For example,
! by leveraging the use of custom <a href="definevar.html">resource
variables</a>, you can parameterize textual labels so the locale-specific
resource files only need to define variable values instead of redefining
! layout. For example, the following is the default value of the
<a href="nextbutton.html">NEXTBUTTON</a> resource:
</p>
***************
*** 304,310 ****
</pre>
! <p>To facilitate the the localization of your archives, the resource
! should be changed so the button label becomes a custom resource variable
! references:
</p>
<pre class="code">
--- 301,307 ----
</pre>
! <p>To facilitate the the localization of your archives, change
! the resource so the button label becomes a custom resource variable
! reference:
</p>
<pre class="code">
***************
*** 314,320 ****
</pre>
! <p>You will notice that "<tt class="icode">Date Next</tt>" has been
! changed to "<tt class="icode">$BUTTON-DATE-NEXT-LABEL$</tt>". Therefore,
! in the locale specific resource file, all that needs to be done is to
define <tt>$BUTTON-DATE-NEXT-LABEL$</tt>. Continuing with the
<tt>settings.mrc</tt> example, the following would be defined in
--- 311,317 ----
</pre>
! <p>Notice that "<tt class="icode">Date Next</tt>" has been
! changed to "<tt class="icode">$BUTTON-DATE-NEXT-LABEL$</tt>".
! In the locale specific resource file, all you need to do is
define <tt>$BUTTON-DATE-NEXT-LABEL$</tt>. Continuing with the
<tt>settings.mrc</tt> example, the following would be defined in
***************
*** 346,352 ****
<hr>
<h2><a name="examples">Examples</a></h2>
-
- <p>The following shows you what a resource file looks like:
- </p>
<PRE class="code">
--- 343,346 ----
Index: rmm.html
===================================================================
RCS file: /home/users/mhonarc.org/ehood/cvs/mhonarc/mhonarc/MHonArc/doc/resources/rmm.html,v
retrieving revision 1.13
retrieving revision 1.14
diff -C2 -r1.13 -r1.14
*** rmm.html 6 Oct 2003 22:04:20 -0000 1.13
--- rmm.html 13 May 2005 00:00:36 -0000 1.14
***************
*** 56,61 ****
option. When active, all non-option related arguments are treated
as messages to delete from the archive. Messages can be specified
! by message numbers, message number ranges, or message-ids. Either
! methods can be used together. See <b>Examples</b> below.
</p>
--- 56,61 ----
option. When active, all non-option related arguments are treated
as messages to delete from the archive. Messages can be specified
! by a combination of message numbers, message number ranges, or message-ids.
! See <a href="#examples"><b>Examples</b></a> below.
</p>
***************
*** 91,96 ****
</pre></td></tr></table>
! <p>If we want to delete message 15 and message 20 through 35, the
! following can be used:
</p>
<table border=1 width="100%"><tr><td><pre class="shell">
--- 91,96 ----
</pre></td></tr></table>
! <p>To delete message 15 and message 20 through 35, use the
! following:
</p>
<table border=1 width="100%"><tr><td><pre class="shell">
***************
*** 104,108 ****
prompt> <b>mhonarc -rmm 199802171800.KAA27647<!--
-->@<!--
! -->medusa.acs.uci.edu</b>
</pre></td></tr></table>
<p>You can surround message-ids with <tt><></tt>'s, but you
--- 104,108 ----
prompt> <b>mhonarc -rmm 199802171800.KAA27647<!--
-->@<!--
! -->example.com</b>
</pre></td></tr></table>
<p>You can surround message-ids with <tt><></tt>'s, but you
***************
*** 117,121 ****
prompt> <b>mhonarc -rmm 23-34 199802171800.KAA27647<!--
-->@<!--
! -->medusa.acs.uci.edu 52</b>
</pre></td></tr></table>
--- 117,121 ----
prompt> <b>mhonarc -rmm 23-34 199802171800.KAA27647<!--
-->@<!--
! -->example.com 52</b>
</pre></td></tr></table>
Index: scan.html
===================================================================
RCS file: /home/users/mhonarc.org/ehood/cvs/mhonarc/mhonarc/MHonArc/doc/resources/scan.html,v
retrieving revision 1.12
retrieving revision 1.13
diff -C2 -r1.12 -r1.13
*** scan.html 6 Oct 2003 22:04:20 -0000 1.12
--- scan.html 13 May 2005 00:00:36 -0000 1.13
***************
*** 75,84 ****
<h2><a name="examples">Examples</a></h2>
! <p>The following example generates an output in the order
defined in the database of the archive:
</p>
! <pre>
! % <b>mhonarc -scan -outdir /home/ehood/html/archive</b>
Reading database ...
117 messages in /home/ehood/html/archive:
--- 75,84 ----
<h2><a name="examples">Examples</a></h2>
! <p>The following example generates output in the order
defined in the database of the archive:
</p>
! <table border=1 width="100%"><tr><td><pre class="shell">
! prompt> <b>mhonarc -scan -outdir /home/ehood/html/archive</b>
Reading database ...
117 messages in /home/ehood/html/archive:
***************
*** 104,115 ****
13 1996/08/01 Steve McCullagh Perl 5.002 and $| errors
...
! </pre>
! <p>If you want always to get a listing that shows messages by number,
! use somthing like the following:
</p>
! <pre>
! % <b>mhonarc -scan -noreverse -nosort -outdir /home/ehood/html/archive</b>
Reading database ...
117 messages in /home/ehood/html/archive:
--- 104,115 ----
13 1996/08/01 Steve McCullagh Perl 5.002 and $| errors
...
! </pre></td></tr></table>
! <p>To get a listing that shows messages by number,
! do the following:
</p>
! <table border=1 width="100%"><tr><td><pre class="shell">
! prompt> <b>mhonarc -scan -noreverse -nosort -outdir /home/ehood/html/archive</b>
Reading database ...
117 messages in /home/ehood/html/archive:
***************
*** 134,138 ****
15 1996/08/02 Mike Stok Re: More on -w (was Re: Is this a known bu
...
! </pre>
<!-- *************************************************************** -->
--- 134,138 ----
15 1996/08/02 Mike Stok Re: More on -w (was Re: Is this a known bu
...
! </pre></td></tr></table>
<!-- *************************************************************** -->
---------------------------------------------------------------------
To sign-off this list, send email to majordomo(_at_)mhonarc(_dot_)org with the
message text UNSUBSCRIBE MHONARC-COMMITS