<html> <head> <title>MHonArc Resources: PRINTXCOMMENTS</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="prevpglinkia.html">PREVPGLINKIA</a>]</td><td><nobr>[<a href="../resources.html#printxcomments">Resources</a>][<a href="../mhonarc.html">TOC</a>]</nobr></td><td align="right" width="50%">[Next: <a href="quiet.html">QUIET</a>]</td></tr></table> <!--/x-rc-nav--> <hr> <h1>PRINTXCOMMENTS</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_PRINTXCOMMENTS=</code> [ <code>0</code> | <code>1</code> ] </p> </dd> <dt><strong>Element</strong></dt> <dd><p> <code><PRINTXCOMMENTS></code><br> <code><NOPRINTXCOMMENTS></code><br> </p> </dd> <dt><strong>Command-line Option</strong></dt> <dd><p> <code>-printxcomments</code><br> <code>-noprintxcomments</code> </p> </dd> </dl> <!-- *************************************************************** --> <hr> <h2><a name="description">Description</a></h2> <p>PRINTXCOMMENTS determines if special comment declarations are included in archive messages pages. For each message page file, something like the following appears at the beginning: </p> <pre class="code"> <!--X-Subject: Hello World! --> <!--X-From-R13: rneyNrneyubbq.pbz --> <!--X-Date: Sun May 23 18:35:25 EDT 1999 --> <!--X-Message-Id: asdjf21kasdla2j.121asdlk@example.com --> <!--X-Content-Type: text/plain --> </pre> <p>Normally, these "X" comments are for informative purposes only and are not required by mhonarc to perform archive operations. </p> <p>However, the comments can provide important functionality in some cases, for example: </p> <ul> <li><p>When <a href="../app-utilsprg.html#mha-dbrecover"><tt>mha-dbrecover</tt></a> is used: <tt>mha-dbrecover</tt> uses X comments to reconstruct an archive database file from archive message pages. </p> </li> <li><p>Meta-fields for search indexers: Search engines that provide media-type-aware indexing (like <a href="http://www.namazu.org/">Namazu</a>) can key off the X comments when MHonArc message pages are indexed. </p> </li> </ul> <p>If PRINTXCOMMENTS is disabled, X comments will not be printed. </p> <table class="note" width="100%"> <tr valign="baseline"> <td><strong>NOTE:</strong></td> <td width="100%"><p>Some X comments — which are intermixed with message page content — will always be printed, even if PRINTXCOMMENTS is disabled. These X comments are critical for performing archive updates. </p> </td> </tr> </table> <p> </p> <!-- *************************************************************** --> <hr> <h2><a name="default">Default Setting</a></h2> <p>On. </p> <!-- *************************************************************** --> <hr> <h2><a name="rcvars">Resource Variables</a></h2> <p>N/A </p> <!-- *************************************************************** --> <hr> <h2><a name="examples">Examples</a></h2> <p>None. </p> <!-- *************************************************************** --> <hr> <h2><a name="version">Version</a></h2> <p>2.6.14 </p> <!-- *************************************************************** --> <hr> <h2><a name="seealso">See Also</a></h2> <p> </p> <!-- *************************************************************** --> <hr> <!--x-rc-nav--> <table border=0><tr valign="top"> <td align="left" width="50%">[Prev: <a href="prevpglinkia.html">PREVPGLINKIA</a>]</td><td><nobr>[<a href="../resources.html#printxcomments">Resources</a>][<a href="../mhonarc.html">TOC</a>]</nobr></td><td align="right" width="50%">[Next: <a href="quiet.html">QUIET</a>]</td></tr></table> <!--/x-rc-nav--> <hr> <address> $Date: 2005/07/08 06:34:02 $<br> <img align="top" src="../monicon.png" alt=""> <a href="http://www.mhonarc.org/"><strong>MHonArc</strong></a><br> Copyright © 2005, <a href="http://www.earlhood.com/" >Earl Hood</a>, <a href="mailto:mhonarc%40mhonarc.org">mhonarc<!-- >-->@<!-- >-->mhonarc.org</a> </address> </body> </html>