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

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

Resource NameDescription
ADDAdd messages to the archive.
AFSSkip archive directory permission check.
ANNOTATEAdd/set annotation for message(s).
ARCHIVECreate archive.
AUTHORBEGINMarkup at the start of a author group.
AUTHORENDMarkup at the end of a author group.
AUTHSORTSort main index by author.
BOTLINKSLinks markup at the bottom of message pages.
CHARSETCONVERTERSCharater set filter functions.
CONLENUse Content-Length value.
DATEFIELDSList of fields to extract date of message.
DAYBEGINMarkup at the start of a day group.
DAYENDMarkup at the end of a day group.
DBFILEName of archive database file.
DECODEHEADSStore "decode-only" characters sets in raw form.
DEFINEDERIVEDDefine extra file(s) to generate for each message page.
DEFINEVARDefine a custom resource variable.
DEFRCFILEPathname of default resource file.
DEFRCNAMEName of default resource file.
DOCAdd link to documentation.
DOCURLURL to documentation
EDITIDXModify archive with new resource settings.
EXCSList of header fields to exclude.
EXPIREAGELength of time to keep a message in an archive.
EXPIREDATEExpiration of date of message.
FIELDORDEROrder to display message header fields.
FIELDSBEGBeginning markup of message header.
FIELDSENDEnding markup of message header.
FIELDSTYLESDefine HTML elements that wrap field text of message headers.
FLDBEGMarkup before field text.
FLDENDMarkup after field text.
FOLREFSPrint links links to explicit follow-ups and references.
FOLUPBEGINBeginning markup of follow-up links in message pages.
FOLUPENDEnding markup of follow-up links in message pages.
FOLUPLITXTMarkup for a follow-up link.
FOOTERFile to include at the foot of main index pages.
FORCEForce archive operation even if lock cannot be obtained.
FROMFIELDSList of fields to extract author of a message.
GENIDXGenerate a message index to standard output.
GMTDATEFMTConversion specification for GMT dates.
GZIPEXEPathname to gzip executable.
GZIPFILESGzip files.
GZIPLINKSAssume files are gzipped when creating links.
HEADBODYSEPMarkup separating the message head from the body.
HEADERFile to include at the top of main index pages.
HTMLEXTExtension to use for HTML files.
ICONSContent-type to icon mapping.
IDXFNAMEFilename for main (first) index page.
IDXLABELLabel for main index.
IDXPGBEGINBeginning markup for main index pages.
IDXPGENDEnding markup for main index pages.
IDXPREFIXFilename prefix for multi-page main index.
IDXSIZESize of each index page.
INCLUDEInclude a resource file.
LABELBEGBeginning markup of the label text of a message field.
LABELENDEnd markup of the label text of a message field.
LABELSTYLESDefine HTML elements to wrap message header field labels.
LISTBEGINMarkup to begin main index message listing.
LISTENDMarkup to end main index message listing.
LITEMPLATEMarkup for an entry in the main index message list.
LOCALDATEFMTConversion specification for printing local date.
LOCKPerform a lock on the archive.
LOCKDELAYWait time between lock attempts.
LOCKFILEName of the lock file.
LOCKTRIESTotal number of time to attempt a lock before failing.
MAILTOConvert email addresses in message headers to hyperlinks.
MAILTOURLURL template to use when MAILTO is set.
MAINCreate main index.
MAXSIZEMaximum number of messages in an archive.
MHPATTERNRegex for matching message files in an MH folder (directory).
MIMEARGSArguments to MIME filters.
MIMEFILTERSMapping of MIME filters to content-types.
MODTIMESet modification time on message files to message dates.
MONTHSMonth names.
MONTHSABRAbbreviated month names.
MSGBODYENDMarkup after the message body.
MSGFOOTMarkup at the foot of each message page.
MSGGMTDATEFMTGMT conversion specification for message dates.
MSGHEADMarkup at the head of each message page.
MSGIDLINKHyperlink markup for embedded message-ids in message pages.
MSGLOCALDATEFMTLocal conversion specification for message dates.
MSGPGBEGINStarting markup for each message page.
MSGPGENDEnding markup for each message page.
MSGPGSPrint message pages.
MSGPREFIXPrefix for message page filenames.
MSGSEPRegex for matching message separator in mailbox files.
MULTIPGCreate multi-page indexes.
NEWSHyperlink newsgroups in message headers.
NEXTBUTTONButton markup for next message by main index.
NEXTBUTTONIAInactive button markup for next message by main index.
NEXTLINKLink markup for next message by main index.
NEXTLINKIAInactive link markup for next message by main index.
NEXTPGLINKLink markup for next page of main index.
NEXTPGLINKIAInactive link markup for next page of main index.
NOTEMarkup for representing the annotation of a message.
NOTEDIRDirectory to store annotations.
NOTEIAMarkup when no annotation is available for a message.
NOTETEXTAnnotation text.
OTHERINDEXESList of alternate indexes to create for an archive.
OUTDIRLocation of archive.
PERLINCAdditional Perl include paths.
PREVBUTTONButton markup for previous message by main index.
PREVBUTTONIAInactive button markup for previous message by main index.
PREVLINKLink markup for previous message by main index.
PREVLINKIAInactive link markup for previous message by main index.
PREVPGLINKLink markup for previous page of main index.
PREVPGLINKIAInactive link markup for previous page of main index.
QUIETDo not output status.
RCFILEResource file to read before processing input.
REFSBEGINBeginning markup for explicit reference links in message pages.
REFSENDEnding markup for explicit reference links in message pages.
REFSLITXTMarkup representing a reference entry in explicit reference links.
REVERSEReverse the listing order in the main index.
RMMRemove specified messages from an archive.
SCANList archive messages to standard output.
SINGLEProcess a single message.
SORTList messages by date in main index.
SUBJECTARTICLERXPRegex for matching leading articles in message subjects.
SUBJECTBEGINBeginning markup for a subject group in the main index.
SUBJECTENDEnding markup for a subject group in the main index.
SUBJECTHEADERMain subject line markup above message header.
SUBJECTREPLYRXPRegex for matching subject text denoting a reply message.
SUBJECTSTRIPCODEPerl expressions to strip subject text while reading messages.
SUBSORTList messages by subjext in main index.
TCONTBEGINMarkup before the continuation of a broken thread.
TCONTENDMarkup after the continuation of a broken thread.
TFOOTFooter markup for thread index page.
THEADHeader markup for thread index page.
THREADCreate thread index.
TIDXFNAMEFilename of first thread index page.
TIDXLABELLabel string for the thread index.
TIDXPGBEGINBeginning markup for the thread index pages.
TIDXPGENDEnding markup for the thread index pages.
TIDXPREFIXFilename prefix for thread index pages beyond the first page.
TIMEZONESHour offsets for timezones.
TINDENTBEGINMarkup for opening a level when continuing a broken thread.
TINDENTENDMarkup for closing a level when continuing a broken thread.
TITLETitle for main index.
TLEVELSMaximum number of levels to indent in thread index.
TLIENDEnding markup for a thread index message listing.
TLINONEMarkup for a missing message in thread index.
TLINONEENDEnding markup for a missing message in thread index.
TLITXTMarkup for a thread index message listing.
TNEXTBUTTONButton markup for next message by thread.
TNEXTBUTTONIAInactive button markup for next message by thread.
TNEXTLINKLink markup for next message by thread.
TNEXTLINKIAInactive link markup for next message by thread.
TNEXTPGLINKLink markup for next page in thread index.
TNEXTPGLINKIAInactive link markup for next page in thread index.
TOPLINKSMarkup for top navigational links of a message page.
TPREVBUTTONButton markup for previous message by thread.
TPREVBUTTONIAInactive button markup for previous message by thread.
TPREVLINKLink markup for previous message by thread.
TPREVLINKIAInactive link markup for previous message by thread.
TPREVPGLINKLink markup for previous page in thread index.
TPREVPGLINKIAInactive link markup for previous page in thread index.
TREVERSEList thread in reverse order.
TSINGLETXTMarkup for a thread listing with no follow-ups.
TSLICESize of thread listing slice for message pages.
TSLICEBEGMarkup for the start of a thread slice.
TSLICEENDMarkup for the end of a thread slice.
TSORTList threads by date.
TSUBJECTBEGMarkup before a subject based thread listing.
TSUBJECTENDMarkup after a subject based thread listing.
TSUBLISTBEGMarkup for starting a sub-thread.
TSUBLISTENDMarkup for ending a sub-thread.
TSUBSORTList threads by subject.
TTITLETitle of thread index.
TTOPBEGINMarkup for the root/start of a thread.
TTOPENDMarkup for the end of a thread.
UMASKUmask value for the MHonArc process.
USELOCALTIMEUse local time to determine day groups in main index listing.
USINGLASTPG$LASTPG$ is used in resource values.
WEEKDAYSWeekday names.
WEEKDAYSABRAbbreviated weekday names.

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


98/10/10 15:42:33
MHonArc
Copyright © 1997-1998, Earl Hood, earlhood@usa.net