The resource file is specified by the M2H_RCFILE
environment variable or the
-rcfile
command-line option. The command-line option overrides the
environment variable if both are defined.
NOTE: You should use SGML comment declarations (<!--
... -->
) when
commenting a resource file. This will eliminate possible conflict with later
versions of MHonArc if more stricter parsing rules are adopted.
</
element_name>
tag on its
own line unless explicitly stated otherwise in the Resource File Elements
section. Whitespace is allowed before the close tag.
Override
". This
tells MHonArc that the contents of the element will completely override
the default behavior of MHonArc, and previous instances of the element.
Example: "<EXCS Override>
". If "Override
" is not specified, then the
contents of the element augment the current behavior.
$
VARIABLE[:
N]$
The items in []'s are optional. Definition of each part:
$
$
character represents the beginning, and ending, of the variable.
$
and closing $
. If an unrecognized
variable is encountered, it gets replaced with an empty string. If a literal "$
" is
needed, use "$$
".
MAILTOURL
resource has different rules for variable expansion. If a
variable does not exactly match the set of variables available for the
MAILTOURL
, the variable text will be taken literally as part of the element
content. Therefore, a single "$
" can be used to represent a "$
" character.
$SUBJECT$
$FROMNAME$
$SUBJECT:50$
MBOX
MH
NODOC
NOMAILTO
NONEWS
Newsgroups:
mail header field to news
hyperlinks.
NOREVERSE
NOSORT
NOTHREAD
NOTREVERSE
REVERSE
SORT
SUBSORT
Re:
",
"A
", "An
", and "The
" words are ignored.
THREAD
TREVERSE
DBFILE
.mhonarc.db
". You should
not override the default name unless absolutely necessary, and you are confident about
what you are doing.
DOCURL
http://www.oac.uci.edu/indiv/ehood/mhonarc.html
".
EXCS
FIELDORDER
FIELDSTYLES
FOOTER
HEADER
ICONS
ICONS
element is used to specify the icons that represent the different
content-types of messages. See Icons on usage of this element.
IDXFNAME
maillist.html
".
INDEXBL
INDEXFL
LABELSTYLES
LISTBEGIN
LITEMPLATE
LISTEND
MAILTOURL
MIMEFILTERS
MSGFOOT
MSGHEAD
MSGSEP
^From
".
NEXTBL
NEXTFL
PERLINC
PREVBL
PREVFL
TFOOT
THEAD
TIDXFNAME
threads.html
".
TIMEZONES
TIMEZONES
element defines a timezone acronym and its hour
offset from UTC/GMT (Universal Coordinate Time). The format of each line is
"timezone_acronym:
hour_offset". Examples of timezone acronyms are:
UTC
, PDT
, EST
. The hour offset is should be positive for timezones West of UTC,
and negative for time zones East of UTC.
MHonArc has a default list of timezone acronyms defined with hour offsets.
Therefore, the list given in the resource file will augment the default list, unless the
"Override
" attribute is specified. If "Override
" is specified, the default list,
along with any other lists specified in previous TIMEZONES
elements, are
discarded, and only the timezone acronyms specified in the TIMEZONES
element
will be used.
The following is the default value for TIMEZONES
:
<TIMEZONES> UTC:0 GMT:0 AST:4 ADT:3 EST:5 EDT:4 CST:6 CDT:5 MST:7 MDT:6 PST:8 PDT:7 </TIMEZONES>Most of the time, the date used by MHonArc uses a hour offset instead of a timezone acronym. However, mail messages may contain timezone acronyms in received/sent dates and MHonArc must be told what the hour offset from UTC the timezone acronym represents in order to properly sort messages by date.
TINDEXBL
TINDEXFL
TITLE
TLEVELS
TLITXT
TTITLE
UMASK
<!-- MHonArc resource file --> <SORT> <TITLE> MHonArc test </TITLE> <TTITLE> MHonArc test </TTITLE> <!--=== Index Page Customizations =========================================--> <!-- Have LISTBEGIN contain last updated information --> <LISTBEGIN> <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> </LISTBEGIN> <!-- A compact listing template --> <LITEMPLATE> <li> <strong>$SUBJECT:40$</strong> ($NUMFOLUP$) <em>$FROMNAME$</em><br> </LITEMPLATE> <LISTEND> </ul> <p> <hr> <strong> <a href="http://foo.org/">Home</a> </strong> <p> </LISTEND> <!--=== Thread Index Page Customizations ==================================--> <THEAD> <address> Thread index<br> Last updated: $LOCALDATE$<br> $NUMOFMSG$ messages<br> </address> <ul> <li><a href="$IDXFNAME$">Main Index</a></li> </ul> <hr> </THEAD> <!--=== Message Customizations ============================================--> <EXCS override> apparently errors-to followup forward lines message-id mime- nntp- originator path precedence received replied return-path status via x- </EXCS> <LABELSTYLES> -default- subject:strong from:strong to:strong </LABELSTYLES> <FIELDSTYLES> -default- subject:strong from:strong to:strong keywords:em newsgroups:strong </FIELDSTYLES> <MSGHEAD> <address> MHonArc test archive </address> </MSGHEAD> <MSGFOOT> <strong> <a href="http://foo.org/">Home</a> | <a href="$IDXFNAME$">Main Index</a> | <a href="$TIDXFNAME$">Thread Index</a> </strong> </MSGFOOT> <!--=== Icons =============================================================--> <ICONS> 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 </ICONS>
EXCS
(can specify Override
attribute)
FIELDSTYLES
ICONS
(can specify Override
attribute)
LABELSTYLES
MIMEFILTERS
(can specify Override
attribute)
PERLINC
(can specify Override
attribute)
TIMEZONES
(can specify Override
attribute)
Override
attribute will discard previous settings of the element.
NOSORT
and SORT
), the
last element defined takes precedence.
EXCS
element, append a
'$
' after the field name.