1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160
|
<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>
|