[OpenSPARC-T2-DV] / tools / perl-5.8.0 / doc / MHonArc / resources / rcfile.html

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML//EN">
<html>
<head>
<title>MHonArc Resources: RCFILE</title>
</head>
<body>
<!--x-rc-nav-->
<table border=0><tr valign="top">
<td align="left" width="50%">[Prev:&nbsp;<a href="quiet.html">QUIET</a>]</td><td><nobr>[<a href="../resources.html#rcfile">Resources</a>][<a href="../mhonarc.html">TOC</a>]</nobr></td><td align="right" width="50%">[Next:&nbsp;<a href="refsbegin.html">REFSBEGIN</a>]</td></tr></table>
<!--/x-rc-nav-->
<hr>
<h1>RCFILE</h1>

<!-- *************************************************************** -->
<hr>
<h2>Syntax</h2>

<dl>

<dt><strong>Envariable</strong></dt>
<dd><p>
<code>M2H_RCFILE=</code><var>filename</var>
</p>
</dd>

<dt><strong>Element</strong></dt>
<dd><p>N/A
</p>
</dd>

<dt><strong>Command-line Option</strong></dt>
<dd><p>
<code>-rcfile </code><var>filename</var>
</p>
</dd>

</dl>

<!-- *************************************************************** -->
<hr>
<h2>Description</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>

<h3>Resource file syntax</h3>

<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>

<LI><P>Any line that is not a recognized element open tag, <EM>and</EM>
the line is not contained within an element, is ignored.  This implies
that regular text can be put anywhere <STRONG>outside</STRONG> of
recognized elements for commenting purposes.  </P>

<table border=0 cellpadding=4>
<tr valign=top>
<td><strong>NOTE</strong></td>
<td><p>You should use SGML comment declarations
(<CODE>&lt;!-- </CODE>...<CODE> --&gt;</CODE>) when commenting a
resource file. This will eliminate possible conflicts
if more stricter parsing rules are adopted.
</p>
</td>
</tr>
</table>
<br>

<LI><P>The opening tag of an element must occur by itself on a
single line.  Whitespace is allowed before the the open tag.  </P>

<LI><P>No comments are allowed inside elements because the text will
be treated as element content (unless the comment text is supposed
to be part of the resource value).  </P>

<LI><P>Each element must be closed with a
<CODE>&lt;/</CODE><VAR>element_name</VAR><CODE>&gt;</CODE> tag on
its own line unless resource associated with the element is
a boolean resource.
Whitespace is allowed
before the close tag.  </P>

<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.
<STRONG>Example</STRONG>: "<CODE>&lt;EXCS Override&gt;</CODE>". If
"<CODE>Override</CODE>" 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>

<LI><P>Element names are case-insensitive.
</P>

<LI><P>Elements can occur in any order in the resource file.
</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.
</P>

</UL>

<H3>Resource variables</h3>

<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>

<!-- *************************************************************** -->
<hr>
<h2>Default Setting</h2>

<p>Nil.
</p>

<!-- *************************************************************** -->
<hr>
<h2>Resource Variables</h2>

<p>N/A
</p>

<!-- *************************************************************** -->
<hr>
<h2>Examples</h2>

<p>The following shows you what a resource file looks like:
</p>

<PRE>
&lt;!-- MHonArc resource file
  --&gt;
<b>&lt;<a href="sort.html">SORT</a>&gt;</b>
<b>&lt;<a href="title.html">TITLE</a>&gt;</b>
MHonArc test
<b>&lt;/TITLE&gt;</b>
 
<b>&lt;<a href="ttitle.html">TTITLE</a>&gt;</b>
MHonArc test (by thread)
<b>&lt;/TTITLE&gt;</b>
 
&lt;!--=== Index Page Customizations =========================================--&gt;
 
&lt;!-- Have LISTBEGIN contain last updated information
  --&gt;
<b>&lt;<a href="listbegin.html">LISTBEGIN</a>&gt;</b>
&lt;address&gt;
Last updated: $LOCALDATE$&lt;br&gt;
$NUMOFMSG$ messages in chronological order&lt;br&gt;
&lt;/address&gt;
&lt;ul&gt;
&lt;li&gt;&lt;a href="$TIDXFNAME$"&gt;Thread Index&lt;/a&gt;&lt;/li&gt;
&lt;/ul&gt;
&lt;p&gt;
Listing format is the following:
&lt;p&gt;
&lt;ul&gt;&lt;li&gt; 
&lt;strong&gt;Subject&lt;/strong&gt;
(# of follow-ups)
&lt;em&gt;From&lt;/em&gt;&lt;br&gt;
&lt;/ul&gt;
&lt;p&gt;
&lt;hr&gt;
&lt;ul&gt;
<b>&lt;/LISTBEGIN&gt;</b>
 
 
&lt;!-- A compact listing template
  --&gt;
<b>&lt;<a href="litemplate.html">LITEMPLATE</a>&gt;</b>
&lt;li&gt; 
&lt;strong&gt;$SUBJECT:40$&lt;/strong&gt;
($NUMFOLUP$) &lt;em&gt;$FROMNAME$&lt;/em&gt;&lt;br&gt;
<b>&lt;/LITEMPLATE&gt;</b>
 
<b>&lt;<a href="listend.html">LISTEND</a>&gt;</b>
&lt;/ul&gt;
&lt;p&gt;
&lt;hr&gt;
&lt;strong&gt;
&lt;a href="http://foo.org/"&gt;Home&lt;/a&gt;
&lt;/strong&gt;
&lt;p&gt;
<b>&lt;/LISTEND&gt;</b>
 
&lt;!--=== Thread Index Page Customizations ==================================--&gt;
<b>&lt;<a href="thead.html">THEAD</a>&gt;</b>
&lt;address&gt;
Thread index&lt;br&gt;
Last updated: $LOCALDATE$&lt;br&gt;
$NUMOFMSG$ messages&lt;br&gt;
&lt;/address&gt;
&lt;ul&gt;
&lt;li&gt;&lt;a href="$IDXFNAME$"&gt;Main Index&lt;/a&gt;&lt;/li&gt;
&lt;/ul&gt;
&lt;hr&gt;
<b>&lt;/THEAD&gt;</b>
 
&lt;!--=== Message Customizations ============================================--&gt;
<b>&lt;<a href="excs.html">EXCS</a> override&gt;</b>
apparently
errors-to 
followup
forward 
lines 
message-id
mime- 
nntp- 
originator 
path 
precedence 
received 
replied 
return-path 
status 
via 
x- 
<b>&lt;/EXCS&gt;</b>

<b>&lt;<a href="labelstyles.html">LABELSTYLES</a>&gt;</b>
-default-
subject:strong
from:strong
to:strong
&lt;/LABELSTYLES&gt;
 
<b>&lt;<a href="fieldstyles.html">FIELDSTYLES</a>&gt;</b>
-default-
subject:strong
from:strong
to:strong
keywords:em
newsgroups:strong
<b>&lt;/FIELDSTYLES&gt;</b>
 
<b>&lt;<a href="msghead.html">MSGHEAD</a>&gt;</b>
&lt;address&gt;
MHonArc test archive
&lt;/address&gt;
<b>&lt;/MSGHEAD&gt;</b>
 
<b>&lt;<a href="msgfoot.html">MSGFOOT</a>&gt;</b>
&lt;strong&gt;
&lt;a href="http://foo.org/"&gt;Home&lt;/a&gt; |
&lt;a href="$IDXFNAME$"&gt;Main Index&lt;/a&gt; |
&lt;a href="$TIDXFNAME$"&gt;Thread Index&lt;/a&gt;
&lt;/strong&gt;
<b>&lt;/MSGFOOT&gt;</b>
 
&lt;!--=== Icons =============================================================--&gt;
<b>&lt;<a href="icons.html">ICONS</a>&gt;</b>
application/octet-stream:http://foo.org/icons/binary.xbm
application/postscript:http://foo.org/icons/postscript.xbm
audio/basic:http://foo.org/icons/sound.xbm
image/gif:http://foo.org/icons/image.xbm
image/jpeg:http://foo.org/icons/image.xbm
image/tiff:http://foo.org/icons/image.xbm
multipart/alternative:http://foo.org/icons/alternative.xbm
multipart/digest:http://foo.org/icons/text.xbm
multipart/mixed:http://foo.org/icons/mixed.xbm
multipart/parallel:http://foo.org/icons/mixed.xbm
text/richtext:http://foo.org/icons/mixed.xbm
text/html:http://foo.org/icons/mixed.xbm
text/plain:http://foo.org/icons/text.xbm
unknown:http://foo.org/icons/unknown.doc.xbm
video/mpeg:http://foo.org/icons/movie.xbm
video/quicktime:http://foo.org/icons/movie.xbm
<b>&lt;/ICONS&gt;</b>
</PRE>


<!-- *************************************************************** -->
<hr>
<h2>Version</h2>

<p>1.0
</p>

<!-- *************************************************************** -->
<hr>
<h2>See Also</h2>

<p>
</p>

<!-- *************************************************************** -->
<hr>
<!--x-rc-nav-->
<table border=0><tr valign="top">
<td align="left" width="50%">[Prev:&nbsp;<a href="quiet.html">QUIET</a>]</td><td><nobr>[<a href="../resources.html#rcfile">Resources</a>][<a href="../mhonarc.html">TOC</a>]</nobr></td><td align="right" width="50%">[Next:&nbsp;<a href="refsbegin.html">REFSBEGIN</a>]</td></tr></table>
<!--/x-rc-nav-->
<hr>
<address>
$Date: 2002/07/27 05:13:11 $ <br>
<img align="top" src="../monicon.png" alt="">
<a href="http://www.mhonarc.org/"
><strong>MHonArc</strong></a><br>
Copyright &#169; 1997-1999, <a href="http://www.earlhood.com/"
>Earl Hood</a>, <a href="mailto:mhonarc@mhonarc.org"
> mhonarc@mhonarc.org</a><br>
</address>

</body>
</html>
Commit	Line	Data
86530b38 AT	1	<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML//EN">
	2	<html>
	3	<head>
	4	<title>MHonArc Resources: RCFILE</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="quiet.html">QUIET</a>]</td><td><nobr>[<a href="../resources.html#rcfile">Resources</a>][<a href="../mhonarc.html">TOC</a>]</nobr></td><td align="right" width="50%">[Next: <a href="refsbegin.html">REFSBEGIN</a>]</td></tr></table>
	10	<!--/x-rc-nav-->
	11	<hr>
	12	<h1>RCFILE</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_RCFILE=</code><var>filename</var>
	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>-rcfile </code><var>filename</var>
	34	</p>
	35	</dd>
	36
	37	</dl>
	38
	39	<!-- *************************************************************** -->
	40	<hr>
	41	<h2>Description</h2>
	42
	43	<p>RCFILE tells MHonArc what the resource file is.
	44	The resource file allows you to specify most of the resources set by
	45	environment variables and command-line options, and it allows you to specify
	46	other resources to control MHonArc's behavior.
	47	</p>
	48
	49	<h3>Resource file syntax</h3>
	50
	51	<P>Resources are set in the file by using <EM>elements</EM> similiar
	52	in style to HTML/SGML markup. However, MHonArc uses simpler
	53	parsing rules for the resource file than standard SGML: </P>
	54
	55	<UL>
	56
	57	<LI><P>Any line that is not a recognized element open tag, <EM>and</EM>
	58	the line is not contained within an element, is ignored. This implies
	59	that regular text can be put anywhere <STRONG>outside</STRONG> of
	60	recognized elements for commenting purposes. </P>
	61
	62	<table border=0 cellpadding=4>
	63	<tr valign=top>
	64	<td><strong>NOTE</strong></td>
65	<td><p>You should use SGML comment declarations
66	(<CODE><!-- </CODE>...<CODE> --></CODE>) when commenting a
67	resource file. This will eliminate possible conflicts
68	if more stricter parsing rules are adopted.
69	</p>
70	</td>
71	</tr>
72	</table>
73	<br>
74
75	<LI><P>The opening tag of an element must occur by itself on a
76	single line. Whitespace is allowed before the the open tag. </P>
77
78	<LI><P>No comments are allowed inside elements because the text will
79	be treated as element content (unless the comment text is supposed
80	to be part of the resource value). </P>
81
82	<LI><P>Each element must be closed with a
83	<CODE></</CODE><VAR>element_name</VAR><CODE>></CODE> tag on
84	its own line unless resource associated with the element is
85	a boolean resource.
86	Whitespace is allowed
87	before the close tag. </P>
88
89	<LI><P>Some elements can take an optional attribute called
90	"<CODE>Override</CODE>", if applicable. This tells MHonArc
91	that the contents of the element will completely override the default
92	behavior of MHonArc, and previous instances of the element.
93	<STRONG>Example</STRONG>: "<CODE><EXCS Override></CODE>". If
94	"<CODE>Override</CODE>" is not specified, then the contents of the
95	element augment the current setting. </P>
96
97	<LI><P>Some elements can take an optional attribute called
98	"<CODE>Chop</CODE>", if applicable. This tells MHonArc
99	to remove the last line-break of the element's content.
100	</P>
101
102	<LI><P>Element names are case-insensitive.
103	</P>
104
105	<LI><P>Elements can occur in any order in the resource file.
106	</P>
107
108	<LI><P>Elements can<b>NOT</b> be nested. Many resources define
109	the values of <a href="../rcvars.html">resource variables</a>, which
110	may be used within resource elements.
111	</P>
112
113	</UL>
114
115	<H3>Resource variables</h3>
116
117	<p>Many resources are allowed to have <em>resource variables</em> as
118	part of there content. Resource variables represent data that
119	can only be defined during run-time. I.e. Resource variables
120	will get expanded to an appropriate value during the execution
121	of MHonArc. For more information on resource variables, see
122	the section: <a href="../rcvars.html">Resource Variables</a>.
123	</p>
124
125	<p>The description for each resource will contain a list
126	of all applicable variables that may be used in defining the
127	resource's value.
128	</p>
129
130	<!-- *************************************************************** -->
131	<hr>
132	<h2>Default Setting</h2>
133
134	<p>Nil.
135	</p>
136
137	<!-- *************************************************************** -->
138	<hr>
139	<h2>Resource Variables</h2>
140
141	<p>N/A
142	</p>
143
144	<!-- *************************************************************** -->
145	<hr>
146	<h2>Examples</h2>
147
148	<p>The following shows you what a resource file looks like:
149	</p>
150
151	<PRE>
152	<!-- MHonArc resource file
153	-->
154	<b><<a href="sort.html">SORT</a>></b>
155	<b><<a href="title.html">TITLE</a>></b>
156	MHonArc test
157	<b></TITLE></b>
158
159	<b><<a href="ttitle.html">TTITLE</a>></b>
160	MHonArc test (by thread)
161	<b></TTITLE></b>
162
163	<!--=== Index Page Customizations =========================================-->
164
165	<!-- Have LISTBEGIN contain last updated information
166	-->
167	<b><<a href="listbegin.html">LISTBEGIN</a>></b>
168	<address>
169	Last updated: $LOCALDATE$<br>
170	$NUMOFMSG$ messages in chronological order<br>
171	</address>
172	<ul>
173	<li><a href="$TIDXFNAME$">Thread Index</a></li>
174	</ul>
175	<p>
176	Listing format is the following:
177	<p>
178	<ul><li>
179	<strong>Subject</strong>
180	(# of follow-ups)
181	<em>From</em><br>
182	</ul>
183	<p>
184	<hr>
185	<ul>
186	<b></LISTBEGIN></b>
187
188
189	<!-- A compact listing template
190	-->
191	<b><<a href="litemplate.html">LITEMPLATE</a>></b>
192	<li>
193	<strong>$SUBJECT:40$</strong>
194	($NUMFOLUP$) <em>$FROMNAME$</em><br>
195	<b></LITEMPLATE></b>
196
197	<b><<a href="listend.html">LISTEND</a>></b>
198	</ul>
199	<p>
200	<hr>
201	<strong>
202	<a href="http://foo.org/">Home</a>
203	</strong>
204	<p>
205	<b></LISTEND></b>
206
207	<!--=== Thread Index Page Customizations ==================================-->
208	<b><<a href="thead.html">THEAD</a>></b>
209	<address>
210	Thread index<br>
211	Last updated: $LOCALDATE$<br>
212	$NUMOFMSG$ messages<br>
213	</address>
214	<ul>
215	<li><a href="$IDXFNAME$">Main Index</a></li>
216	</ul>
217	<hr>
218	<b></THEAD></b>
219
220	<!--=== Message Customizations ============================================-->
221	<b><<a href="excs.html">EXCS</a> override></b>
222	apparently
223	errors-to
224	followup
225	forward
226	lines
227	message-id
228	mime-
229	nntp-
230	originator
231	path
232	precedence
233	received
234	replied
235	return-path
236	status
237	via
238	x-
239	<b></EXCS></b>
240
241	<b><<a href="labelstyles.html">LABELSTYLES</a>></b>
242	-default-
243	subject:strong
244	from:strong
245	to:strong
246	</LABELSTYLES>
247
248	<b><<a href="fieldstyles.html">FIELDSTYLES</a>></b>
249	-default-
250	subject:strong
251	from:strong
252	to:strong
253	keywords:em
254	newsgroups:strong
255	<b></FIELDSTYLES></b>
256
257	<b><<a href="msghead.html">MSGHEAD</a>></b>
258	<address>
259	MHonArc test archive
260	</address>
261	<b></MSGHEAD></b>
262
263	<b><<a href="msgfoot.html">MSGFOOT</a>></b>
264	<strong>
265	<a href="http://foo.org/">Home</a> \|
266	<a href="$IDXFNAME$">Main Index</a> \|
267	<a href="$TIDXFNAME$">Thread Index</a>
268	</strong>
269	<b></MSGFOOT></b>
270
271	<!--=== Icons =============================================================-->
272	<b><<a href="icons.html">ICONS</a>></b>
273	application/octet-stream:http://foo.org/icons/binary.xbm
274	application/postscript:http://foo.org/icons/postscript.xbm
275	audio/basic:http://foo.org/icons/sound.xbm
276	image/gif:http://foo.org/icons/image.xbm
277	image/jpeg:http://foo.org/icons/image.xbm
278	image/tiff:http://foo.org/icons/image.xbm
279	multipart/alternative:http://foo.org/icons/alternative.xbm
280	multipart/digest:http://foo.org/icons/text.xbm
281	multipart/mixed:http://foo.org/icons/mixed.xbm
282	multipart/parallel:http://foo.org/icons/mixed.xbm
283	text/richtext:http://foo.org/icons/mixed.xbm
284	text/html:http://foo.org/icons/mixed.xbm
285	text/plain:http://foo.org/icons/text.xbm
286	unknown:http://foo.org/icons/unknown.doc.xbm
287	video/mpeg:http://foo.org/icons/movie.xbm
288	video/quicktime:http://foo.org/icons/movie.xbm
289	<b></ICONS></b>
290	</PRE>
291
292
293	<!-- *************************************************************** -->
294	<hr>
295	<h2>Version</h2>
296
297	<p>1.0
298	</p>
299
300	<!-- *************************************************************** -->
301	<hr>
302	<h2>See Also</h2>
303
304	<p>
305	</p>
306
307	<!-- *************************************************************** -->
308	<hr>
309	<!--x-rc-nav-->
310	<table border=0><tr valign="top">
311	<td align="left" width="50%">[Prev: <a href="quiet.html">QUIET</a>]</td><td><nobr>[<a href="../resources.html#rcfile">Resources</a>][<a href="../mhonarc.html">TOC</a>]</nobr></td><td align="right" width="50%">[Next: <a href="refsbegin.html">REFSBEGIN</a>]</td></tr></table>
312	<!--/x-rc-nav-->
313	<hr>
314	<address>
315	$Date: 2002/07/27 05:13:11 $ <br>
316	<img align="top" src="../monicon.png" alt="">
317	<a href="http://www.mhonarc.org/"
318	><strong>MHonArc</strong></a><br>
319	Copyright © 1997-1999, <a href="http://www.earlhood.com/"
320	>Earl Hood</a>, <a href="mailto:mhonarc@mhonarc.org"
321	> mhonarc@mhonarc.org</a><br>
322	</address>
323
324	</body>
325	</html>