| 1 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML//EN"> |
| 2 | <html> |
| 3 | <head> |
| 4 | <title>MHonArc Resources: ANNOTATE</title> |
| 5 | </head> |
| 6 | <body> |
| 7 | <!--x-rc-nav--> |
| 8 | <table border=0><tr valign="top"> |
| 9 | <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> |
| 10 | <!--/x-rc-nav--> |
| 11 | <hr> |
| 12 | <h1>ANNOTATE</h1> |
| 13 | |
| 14 | <!-- *************************************************************** --> |
| 15 | <hr> |
| 16 | <h2>Syntax</h2> |
| 17 | |
| 18 | <dl> |
| 19 | |
| 20 | <dt><strong>Envariable</strong></dt> |
| 21 | <dd><p> |
| 22 | <code>M2H_ANNOTATE=</code>[ <code>0</code> | <code>1</code> ] |
| 23 | </p> |
| 24 | </dd> |
| 25 | |
| 26 | <dt><strong>Element</strong></dt> |
| 27 | <dd><p>N/A |
| 28 | </p> |
| 29 | </dd> |
| 30 | |
| 31 | <dt><strong>Command-line Option</strong></dt> |
| 32 | <dd><p> |
| 33 | <code>-annotate </code> |
| 34 | </p> |
| 35 | </dd> |
| 36 | |
| 37 | </dl> |
| 38 | |
| 39 | <!-- *************************************************************** --> |
| 40 | <hr> |
| 41 | <h2>Description</h2> |
| 42 | |
| 43 | <p>ANNOTATE is used to add an annotation to a message, or multiple |
| 44 | messages. Annotation |
| 45 | text is specified by the |
| 46 | <a href="notetext.html">NOTETEXT</a> resource. The messages to |
| 47 | apply the annotation to are specify as arguments to the command-line. |
| 48 | Messages can be specified by message-id or message number. |
| 49 | </p> |
| 50 | |
| 51 | <p>See <b>Examples</b> below on how to use ANNOTATE. |
| 52 | See the <a href="note.html">NOTE</a> resource on how to display |
| 53 | annotations in archive pages. |
| 54 | </p> |
| 55 | |
| 56 | <!-- *************************************************************** --> |
| 57 | <hr> |
| 58 | <h2>Default Setting</h2> |
| 59 | |
| 60 | <p>Off. |
| 61 | </p> |
| 62 | |
| 63 | <!-- *************************************************************** --> |
| 64 | <hr> |
| 65 | <h2>Resource Variables</h2> |
| 66 | |
| 67 | <p>N/A |
| 68 | </p> |
| 69 | |
| 70 | <!-- *************************************************************** --> |
| 71 | <hr> |
| 72 | <h2>Examples</h2> |
| 73 | |
| 74 | <p>The following adds an annotation to message 15 of an archive: |
| 75 | </p> |
| 76 | <pre> |
| 77 | % <b>mhonarc -annotate -outdir /home/httpd/docs/mail \</b> |
| 78 | <b>-notetext "This is an annotation" 15</b> |
| 79 | </pre> |
| 80 | |
| 81 | <p>Multiple <tt>-notetext</tt> can be specified if you want to keep |
| 82 | the command-line cleaner for larger annotations. The following adds |
| 83 | an annotation to the messages with a message-id of |
| 84 | <tt><34D622C8.C37760AB@foo.org></tt> and message number of |
| 85 | 23: |
| 86 | </p> |
| 87 | <pre> |
| 88 | % <b>mhonarc -annotate -outdir /home/httpd/docs/mail \</b> |
| 89 | <b>-notetext "<p>This is the start of an annotation." \</b> |
| 90 | <b>-notetext "Here is some more text." \</b> |
| 91 | <b>-notetext "Here is some more text (again)." \</b> |
| 92 | <b>-notetext "The End.</p>" \</b> |
| 93 | <b>"34D622C8.C37760AB@foo.org" 23</b> |
| 94 | </pre> |
| 95 | |
| 96 | <p>All <tt>-notetext</tt> options text will be concatenated together |
| 97 | to form the complete text of the annotation. Also, the text is |
| 98 | treated as HTML markup, so HTML tagging can be used to provide formatting. |
| 99 | </p> |
| 100 | |
| 101 | <p>Using the <tt>-notetext</tt> is convienent for small annotations, |
| 102 | but it can be cumbersome for large ones. An alternative is to |
| 103 | <em>not</em> specify <tt>-notetext</tt>. If not present, MHonArc |
| 104 | will read the text of the annotation from standard input. For example: |
| 105 | </p> |
| 106 | |
| 107 | <pre> |
| 108 | % <b>mhonarc -annotate -outdir /home/httpd/docs/mail 28 72</b> |
| 109 | Reading database ... |
| 110 | Annotating messages in out ... |
| 111 | Please enter note text (terminated with EOF char): |
| 112 | <b><p>Here is some annotation text. This will be applied to</b> |
| 113 | <b>messages 28 and 72. To tell MHonArc I am done with this text,</b> |
| 114 | <b>I will terminate the text with my system's EOF character.</b> |
| 115 | <b>^D</b> |
| 116 | </pre> |
| 117 | |
| 118 | <p>The <tt>^D</tt> represents the EOF character and is not part |
| 119 | of the annotation text. On Unix systems, this |
| 120 | is normally Ctrl-D (holding down the Control key and pressing the D key). |
| 121 | Under Windows, it is normally Ctrl-Z. |
| 122 | </p> |
| 123 | |
| 124 | <p>The standard input method of specify annotation data allows |
| 125 | annotation text to come for a file the output of another process. |
| 126 | Here is an example of using the contents of a file as the text: |
| 127 | </p> |
| 128 | <pre> |
| 129 | % <b>mhonarc -annotate -outdir /home/httpd/docs/mail < somefile.html</b> |
| 130 | </pre> |
| 131 | |
| 132 | <p>Which is equivalent to:</p> |
| 133 | <pre> |
| 134 | % <b>cat somefile.html | mhonarc -annotate -outdir /home/httpd/docs/mail </b> |
| 135 | </pre> |
| 136 | |
| 137 | <p>The first version utilizes the command-line shell's ability to |
| 138 | redirect a file's contents into a command's standard input. The second |
| 139 | version is piping the output of the <b>cat</b> command to MHonArc. |
| 140 | By the way, <b>cat</b> is a program that concatenates files and prints |
| 141 | them to standard output (standard on Unix-based systems). |
| 142 | </p> |
| 143 | |
| 144 | <!-- *************************************************************** --> |
| 145 | <hr> |
| 146 | <h2>Version</h2> |
| 147 | |
| 148 | <p>2.3.0 |
| 149 | </p> |
| 150 | |
| 151 | <!-- *************************************************************** --> |
| 152 | <hr> |
| 153 | <h2>See Also</h2> |
| 154 | |
| 155 | <p> |
| 156 | <a href="note.html">NOTE</a>, |
| 157 | <a href="notedir.html">NOTEDIR</a>, |
| 158 | <a href="notetext.html">NOTETEXT</a> |
| 159 | </p> |
| 160 | |
| 161 | <!-- *************************************************************** --> |
| 162 | <hr> |
| 163 | <!--x-rc-nav--> |
| 164 | <table border=0><tr valign="top"> |
| 165 | <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> |
| 166 | <!--/x-rc-nav--> |
| 167 | <hr> |
| 168 | <address> |
| 169 | $Date: 2002/07/27 05:13:10 $ <br> |
| 170 | <img align="top" src="../monicon.png" alt=""> |
| 171 | <a href="http://www.mhonarc.org/" |
| 172 | ><strong>MHonArc</strong></a><br> |
| 173 | Copyright © 1998-1999, <a href="http://www.earlhood.com/" |
| 174 | >Earl Hood</a>, <a href="mailto:mhonarc@mhonarc.org" |
| 175 | >mhonarc@mhonarc.org</a><br> |
| 176 | </address> |
| 177 | |
| 178 | </body> |
| 179 | </html> |