<html>
<head>
<title>MHonArc Resources: ANNOTATE</title>
<link rel="stylesheet" type="text/css" href="../docstyles.css">
</head>
<body>
<!--x-rc-nav-->
<table border=0><tr valign="top">
<td align="left" width="50%">[Prev: <a href="afs.html">AFS</a>]</td><td><nobr>[<a href="../resources.html#annotate">Resources</a>][<a href="../mhonarc.html">TOC</a>]</nobr></td><td align="right" width="50%">[Next: <a href="archive.html">ARCHIVE</a>]</td></tr></table>
<!--/x-rc-nav-->
<hr>
<h1>ANNOTATE</h1>
<!--X-TOC-Start-->
<ul>
<li><a href="#syntax">Syntax</a>
<li><a href="#description">Description</a>
<li><a href="#default">Default Setting</a>
<li><a href="#rcvars">Resource Variables</a>
<li><a href="#examples">Examples</a>
<li><a href="#version">Version</a>
<li><a href="#seealso">See Also</a>
</ul>
<!--X-TOC-End-->
<!-- *************************************************************** -->
<hr>
<h2><a name="syntax">Syntax</a></h2>
<dl>
<dt><strong>Envariable</strong></dt>
<dd><p>
<code>M2H_ANNOTATE=</code>[ <code>0</code> | <code>1</code> ]
</p>
</dd>
<dt><strong>Element</strong></dt>
<dd><p>N/A
</p>
</dd>
<dt><strong>Command-line Option</strong></dt>
<dd><p>
<code>-annotate </code>
</p>
</dd>
</dl>
<!-- *************************************************************** -->
<hr>
<h2><a name="description">Description</a></h2>
<p>ANNOTATE is used to add an annotation to a message, or multiple
messages. Annotation
text is specified by the
<a href="notetext.html">NOTETEXT</a> resource. The messages to
apply the annotation to are specify as arguments to the command-line.
Messages can be specified by message-id or message number.
</p>
<p>See <b>Examples</b> below on how to use ANNOTATE.
See the <a href="note.html">NOTE</a> resource on how to display
annotations in archive pages.
</p>
<!-- *************************************************************** -->
<hr>
<h2><a name="default">Default Setting</a></h2>
<p>Off.
</p>
<!-- *************************************************************** -->
<hr>
<h2><a name="rcvars">Resource Variables</a></h2>
<p>N/A
</p>
<!-- *************************************************************** -->
<hr>
<h2><a name="examples">Examples</a></h2>
<p>The following adds an annotation to message 15 of an archive:
</p>
<table border=1 width="100%"><tr><td><pre class="shell">
prompt> <b>mhonarc -annotate -outdir /home/httpd/docs/mail \</b>
<b>-notetext "This is an annotation" 15</b>
</pre></td></tr></table>
<p>Multiple <tt>-notetext</tt> can be specified if you want to keep
the command-line cleaner for larger annotations. The following adds
an annotation to the messages with a message-id of
<tt><34D622C8.C37760AB<!--
-->@<!--
-->example.com></tt> and message number of
23:
</p>
<table border=1 width="100%"><tr><td><pre class="shell">
prompt> <b>mhonarc -annotate -outdir /home/httpd/docs/mail \</b>
<b>-notetext "<p>This is the start of an annotation." \</b>
<b>-notetext "Here is some more text." \</b>
<b>-notetext "Here is some more text (again)." \</b>
<b>-notetext "The End.</p>" \</b>
<b>"34D622C8.C37760AB<!--
-->@<!--
-->example.com" 23</b>
</pre></td></tr></table>
<p>All <tt>-notetext</tt> options text will be concatenated together
to form the complete text of the annotation. Also, the text is
treated as HTML markup, so HTML tagging can be used to provide formatting.
</p>
<p>Using the <tt>-notetext</tt> is convienent for small annotations,
but it can be cumbersome for large ones. An alternative is to
<em>not</em> specify <tt>-notetext</tt>. If not present, MHonArc
will read the text of the annotation from standard input. For example:
</p>
<table border=1 width="100%"><tr><td><pre class="shell">
prompt> <b>mhonarc -annotate -outdir /home/httpd/docs/mail 28 72</b>
Reading database ...
Annotating messages in out ...
Please enter note text (terminated with EOF char):
<b><p>Here is some annotation text. This will be applied to</b>
<b>messages 28 and 72. To tell MHonArc I am done with this text,</b>
<b>I will terminate the text with my system's EOF character.</b>
<b>^D</b>
</pre></td></tr></table>
<p>The <tt>^D</tt> represents the EOF character and is not part
of the annotation text. On Unix systems, this
is normally Ctrl-D (holding down the Control key and pressing the D key).
Under Windows, it is normally Ctrl-Z.
</p>
<p>The standard input method of specify annotation data allows
annotation text to come for a file the output of another process.
Here is an example of using the contents of a file as the text:
</p>
<table border=1 width="100%"><tr><td><pre class="shell">
prompt> <b>mhonarc -annotate -outdir /home/httpd/docs/mail < somefile.html</b>
</pre></td></tr></table>
<p>Which is equivalent to:</p>
<table border=1 width="100%"><tr><td><pre class="shell">
prompt> <b>cat somefile.html | mhonarc -annotate -outdir /home/httpd/docs/mail </b>
</pre></td></tr></table>
<p>The first version utilizes the command-line shell's ability to
redirect a file's contents into a command's standard input. The second
version is piping the output of the <b>cat</b> command to MHonArc.
By the way, <b>cat</b> is a program that concatenates files and prints
them to standard output (standard on Unix-based systems).
</p>
<!-- *************************************************************** -->
<hr>
<h2><a name="version">Version</a></h2>
<p>2.3.0
</p>
<!-- *************************************************************** -->
<hr>
<h2><a name="seealso">See Also</a></h2>
<p>
<a href="note.html">NOTE</a>,
<a href="notedir.html">NOTEDIR</a>,
<a href="notetext.html">NOTETEXT</a>
</p>
<!-- *************************************************************** -->
<hr>
<!--x-rc-nav-->
<table border=0><tr valign="top">
<td align="left" width="50%">[Prev: <a href="afs.html">AFS</a>]</td><td><nobr>[<a href="../resources.html#annotate">Resources</a>][<a href="../mhonarc.html">TOC</a>]</nobr></td><td align="right" width="50%">[Next: <a href="archive.html">ARCHIVE</a>]</td></tr></table>
<!--/x-rc-nav-->
<hr>
<address>
$Date: 2003/10/06 22:04:16 $ <br>
<img align="top" src="../monicon.png" alt="">
<a href="http://www.mhonarc.org/"
><strong>MHonArc</strong></a><br>
Copyright © 1998-1999, <a href="http://www.earlhood.com/"
>Earl Hood</a>, <a href="mailto:mhonarc%40mhonarc.org"
>mhonarc<!--
-->@<!--
-->mhonarc.org</a><br>
</address>
</body>
</html>