MHonArc -- Resources

[Prev][Next][TOC][FAQ][Bugs][Home]

# Resources

All the behavior of MHonArc is controlled by resources. Resources may be set via environment variables (envariables for short), command-line options, and/or elements in a resource file. For information on the syntax of a MHonArc resource file, see the RCFILE resource.

## Resource Types

There are four basic types of resources:

boolean

  Boolean resources are resources that are either on or off; active or deactive; or true or false. They basically work as flags for controlling MHonArc behavior.

string

  The resource represents a string value. How the string value is used depends on the resource.

list

  The resource is a list of values. How the list is used depends on the resource.

one-shot

  One-shot resources are resources that apply only to the current MHonArc process. You can tell if a resource is a one-shot by checking if the resource cannot be defined by a resource file element. One-shot resources are set only by command-line options or envariables.

A resource's type can be determined by reading the description for the resource.

All resources, except one-shots, are stored with the archive in a simple database. Therefore, after the first time you run MHonArc on an archive, you do not need to respecify the resources. MHonArc will remember your settings so subsequent archive updates are faster to execute.

## Resource Index

Each resource is described on its own page. Each resource page uses the following template:

> Syntax

>   Brief synopsis on how the resource can be defined. Command-line options take precedence over resource file elements. Resource file elements take precedence over environment variables ("envariables" for short). See RCFILE for more information on how resources are defined in a resource file. See your system's documentation on how to define envariables.

> Description

>   Description of the resource.

> Default Setting

>   The default value of the resource, if applicable.

> Resource Variables

>   Applicable resource variables that can be used for the resource. See RCFILE for information on the usage of resource variables.

> Examples

>   Example uses of the resource.

> Version

>   The version of MHonArc the resource became available. Note, the actual description of the resource may not be applicable for the version number listed. I.e. The behavior of the resource may have changed in later releases. Therefore, the description of the resource maybe applicable for a later version of MHonArc than from the version of MHonArc the resource first came available.

> See Also

>   Links to any related resources.

### Resource list

ADD | ARCHIVE | AUTHORBEGIN | AUTHOREND
AUTHSORT | BOTLINKS | CHARSETCONVERTERS | CONLEN
DATEFIELDS | DAYBEGIN | DAYEND | DBFILE
DECODEHEADS | DEFINEDERIVED | DEFINEVAR | DEFRCFILE
DEFRCNAME | DOC | DOCURL | EDITIDX
EXCS | EXPIREAGE | EXPIREDATE | FIELDORDER
FIELDSBEG | FIELDSEND | FIELDSTYLES | FLDBEG
FLDEND | FOLREFS | FOLUPBEGIN | FOLUPEND
FOLUPLITXT | FOOTER | FORCE | FROMFIELDS
GENIDX | GMTDATEFMT | GZIPEXE | GZIPFILES
GZIPLINKS | HEADBODYSEP | HEADER | HTMLEXT
ICONS | IDXFNAME | IDXLABEL | IDXPGBEGIN
IDXPGEND | IDXPREFIX | IDXSIZE | INCLUDE
LABELBEG | LABELEND | LABELSTYLES | LISTBEGIN
LISTEND | LITEMPLATE | LOCALDATEFMT | LOCKDELAY
LOCKTRIES | MAILTO | MAILTOURL | MAIN
MAXSIZE | MHPATTERN | MIMEARGS | MIMEFILTERS
MODTIME | MONTHS | MONTHSABR | MSGBODYEND
MSGFOOT | MSGGMTDATEFMT | MSGHEAD | MSGIDLINK
MSGLOCALDATEFMT | MSGPGBEGIN | MSGPGEND | MSGPREFIX
MSGSEP | MULTIPG | NEWS | NEXTBUTTON
NEXTBUTTONIA | NEXTLINK | NEXTLINKIA | NEXTPGLINK
NEXTPGLINKIA | OTHERINDEXES | OUTDIR | PERLINC
PREVBUTTON | PREVBUTTONIA | PREVLINK | PREVLINKIA
PREVPGLINK | PREVPGLINKIA | QUIET | RCFILE
REFSBEGIN | REFSEND | REFSLITXT | REVERSE
RMM | SCAN | SINGLE | SORT
SUBJECTARTICLERXP | SUBJECTBEGIN | SUBJECTEND | SUBJECTHEADER
SUBJECTREPLYRXP | SUBSORT | TCONTBEGIN | TCONTEND
TFOOT | THEAD | THREAD | TIDXFNAME
TIDXLABEL | TIDXPGBEGIN | TIDXPGEND | TIDXPREFIX
TIMEZONES | TINDENTBEGIN | TINDENTEND | TITLE
TLEVELS | TLIEND | TLINONE | TLINONEEND
TLITXT | TNEXTBUTTON | TNEXTBUTTONIA | TNEXTLINK
TNEXTLINKIA | TNEXTPGLINK | TNEXTPGLINKIA | TOPLINKS
TPREVBUTTON | TPREVBUTTONIA | TPREVLINK | TPREVLINKIA
TPREVPGLINK | TPREVPGLINKIA | TREVERSE | TSINGLETXT
TSLICE | TSLICEBEG | TSLICEEND | TSORT
TSUBJECTBEG | TSUBJECTEND | TSUBLISTBEG | TSUBLISTEND
TSUBSORT | TTITLE | TTOPBEGIN | TTOPEND
UMASK | USINGLASTPG | WEEKDAYS | WEEKDAYSABR

[Prev][Next][TOC][FAQ][Bugs][Home]