<html> <head> <title>MHonArc Resources: RCFILE</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="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="reconvert.html">RECONVERT</a>]</td></tr></table> <!--/x-rc-nav--> <hr> <h1>RCFILE</h1> <!--X-TOC-Start--> <ul> <li><a href="#syntax">Syntax</a> <li><a href="#description">Description</a> <ul> <li><small><a href="#">Resource file syntax</a></small> <li><small><a href="#">Resource variables</a></small> </ul> <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_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><a name="description">Description</a></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 class="note" width="100%"> <tr valign=top> <td><strong>NOTE:</strong></td> <td width="100%"><p>You should use SGML comment declarations (<CODE><!-- </CODE>...<CODE> --></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></</CODE><VAR>element_name</VAR><CODE>></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><EXCS Override></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><a name="default">Default Setting</a></h2> <p>Nil. </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 shows you what a resource file looks like: </p> <PRE class="code"> <!-- MHonArc resource file --> <b><<a href="sort.html">SORT</a>></b> <b><<a href="title.html">TITLE</a>></b> MHonArc test <b></TITLE></b> <b><<a href="ttitle.html">TTITLE</a>></b> MHonArc test (by thread) <b></TTITLE></b> <!--=== Index Page Customizations =========================================--> <!-- Have LISTBEGIN contain last updated information --> <b><<a href="listbegin.html">LISTBEGIN</a>></b> <address> Last updated: $LOCALDATE$<br> $NUMOFMSG$ messages in chronological order<br> </address> <ul> <li><a href="$TIDXFNAME$">Thread Index</a></li> </ul> <p> Listing format is the following: <p> <ul><li> <strong>Subject</strong> (# of follow-ups) <em>From</em><br> </ul> <p> <hr> <ul> <b></LISTBEGIN></b> <!-- A compact listing template --> <b><<a href="litemplate.html">LITEMPLATE</a>></b> <li> <strong>$SUBJECT:40$</strong> ($NUMFOLUP$) <em>$FROMNAME$</em><br> <b></LITEMPLATE></b> <b><<a href="listend.html">LISTEND</a>></b> </ul> <p> <hr> <strong> <a href="http://foo.org/">Home</a> </strong> <p> <b></LISTEND></b> <!--=== Thread Index Page Customizations ==================================--> <b><<a href="thead.html">THEAD</a>></b> <address> Thread index<br> Last updated: $LOCALDATE$<br> $NUMOFMSG$ messages<br> </address> <ul> <li><a href="$IDXFNAME$">Main Index</a></li> </ul> <hr> <b></THEAD></b> <!--=== Message Customizations ============================================--> <b><<a href="excs.html">EXCS</a> override></b> apparently errors-to followup forward lines message-id mime- nntp- originator path precedence received replied return-path status via x- <b></EXCS></b> <b><<a href="labelstyles.html">LABELSTYLES</a>></b> -default- subject:strong from:strong to:strong </LABELSTYLES> <b><<a href="fieldstyles.html">FIELDSTYLES</a>></b> -default- subject:strong from:strong to:strong keywords:em newsgroups:strong <b></FIELDSTYLES></b> <b><<a href="msghead.html">MSGHEAD</a>></b> <address> MHonArc test archive </address> <b></MSGHEAD></b> <b><<a href="msgfoot.html">MSGFOOT</a>></b> <strong> <a href="http://foo.org/">Home</a> | <a href="$IDXFNAME$">Main Index</a> | <a href="$TIDXFNAME$">Thread Index</a> </strong> <b></MSGFOOT></b> <!--=== Icons =============================================================--> <b><<a href="icons.html">ICONS</a>></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></ICONS></b> </PRE> <p>More examples are available under <a href="../app-rcfileexs.html"><cite>Appendix: Resource File Examples</cite></a>. </p> <!-- *************************************************************** --> <hr> <h2><a name="version">Version</a></h2> <p>1.0 </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="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="reconvert.html">RECONVERT</a>]</td></tr></table> <!--/x-rc-nav--> <hr> <address> $Date: 2003/01/02 23:04:56 $ <br> <img align="top" src="../monicon.png" alt=""> <a href="http://www.mhonarc.org/" ><strong>MHonArc</strong></a><br> Copyright © 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>
