File: resources.html

package info (click to toggle)
mhonarc 2.1-1
  • links: PTS
  • area: main
  • in suites: hamm, slink
  • size: 1,932 kB
  • ctags: 2,849
  • sloc: perl: 7,329; makefile: 51
file content (408 lines) | stat: -rw-r--r-- 16,631 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML//EN">
<html>
<head>
<title>MHonArc -- Resources</title>
</head>
<body>

<!--X-NavButtons-Start-->
<p align=center>
[<a href="layout.html">Prev</a>][<a href="diagnos.html">Next</a>][<a href="mhonarc.html">TOC</a>][<a href="http://www.oac.uci.edu/indiv/ehood/MHonArc/faq/faq.html">FAQ</a>][<a href="bugs.html">Bugs</a>][<a href="http://www.oac.uci.edu/indiv/ehood/mhonarc.html">Home</a>]
</p>
<!--X-NavButtons-End-->
<hr>
<h1><a name="resources">Resources</a></h1>

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

<!-- *************************************************************** -->
<hr>
<h2><a name="types">Resource Types</a></h2>

<p>There are four basic types of resources:
</p>

<dl>
<dt><strong>boolean</strong>
<dd><p>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.
</p>
</dd>
<dt><strong>string</strong>
<dd><p>The resource represents a string value.  How the
string value is used depends on the resource.
</p>
</dd>
<dt><strong>list</strong>
<dd><p>The resource is a list of values.  How the list
is used depends on the resource.
</p>
</dd>
<dt><strong>one-shot</strong>
<dd><p>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.
</p>
</dd>

</dl>

<p>A resource's type can be determined by reading the description
for the resource.
</p>

<p>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.
</p>

<!-- *************************************************************** -->
<hr>
<h2><a name="index">Resource Index</a></h2>

<p>Each resource is described on its own page.
Each resource page uses the following template:
</p>

<blockquote>
<dl>
<dt><strong>Syntax</strong></dt>
<dd><p>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 ("<em>envariables</em>" for short).  See
<a href="resources/rcfile.html">RCFILE</a> for more information
on how resources are defined in a resource file.  See
your system's documentation on how to define
envariables.</p>
</dd>
<dt><strong>Description</strong></dt>
<dd><p>Description of the resource.
</p></dd>
<dt><strong>Default Setting</strong></dt>
<dd><p>The default value of the resource, if applicable.
</p></dd>
<dt><strong>Resource Variables</strong></dt>
<dd><p>Applicable resource variables that can be used for the resource.
See <a href="resources/rcfile.html">RCFILE</a> for information on
the usage of resource variables.
</p></dd>
<dt><strong>Examples</strong></dt>
<dd><p>Example uses of the resource.
</p></dd>
<dt><strong>Version</strong></dt>
<dd><p>The version of MHonArc the resource became available.
</p></dd>
<dt><strong>See Also</strong></dt>
<dd><p>Links to any related resources.
</p></dd>
</dl>
</blockquote>

<h3>Resource list</h3>

<!--X-Resource-Index-Start-->
<table border=0 cellpadding=5>
<tbody>
<tr>
<td colspan=3><hr noshade size=0></td>
</tr>
<tr>
<td><a name="add" href="resources/add.html">ADD</a></td>
<td><a name="authorbegin" href="resources/authorbegin.html">AUTHORBEGIN</a></td>
<td><a name="authorend" href="resources/authorend.html">AUTHOREND</a></td>
</tr>
<tr>
<td><a name="authsort" href="resources/authsort.html">AUTHSORT</a></td>
<td><a name="botlinks" href="resources/botlinks.html">BOTLINKS</a></td>
<td><a name="charsetconverters" href="resources/charsetconverters.html">CHARSETCONVERTERS</a></td>
</tr>
<tr>
<td><a name="conlen" href="resources/conlen.html">CONLEN</a></td>
<td><a name="daybegin" href="resources/daybegin.html">DAYBEGIN</a></td>
<td><a name="dayend" href="resources/dayend.html">DAYEND</a></td>
</tr>
<tr>
<td><a name="dbfile" href="resources/dbfile.html">DBFILE</a></td>
<td><a name="decodeheads" href="resources/decodeheads.html">DECODEHEADS</a></td>
<td><a name="definederived" href="resources/definederived.html">DEFINEDERIVED</a></td>
</tr>
<tr>
<td><a name="definevar" href="resources/definevar.html">DEFINEVAR</a></td>
<td><a name="defrcfile" href="resources/defrcfile.html">DEFRCFILE</a></td>
<td><a name="defrcname" href="resources/defrcname.html">DEFRCNAME</a></td>
</tr>
<tr>
<td><a name="doc" href="resources/doc.html">DOC</a></td>
<td><a name="docurl" href="resources/docurl.html">DOCURL</a></td>
<td><a name="editidx" href="resources/editidx.html">EDITIDX</a></td>
</tr>
<tr>
<td><a name="excs" href="resources/excs.html">EXCS</a></td>
<td><a name="expireage" href="resources/expireage.html">EXPIREAGE</a></td>
<td><a name="expiredate" href="resources/expiredate.html">EXPIREDATE</a></td>
</tr>
<tr>
<td><a name="fieldorder" href="resources/fieldorder.html">FIELDORDER</a></td>
<td><a name="fieldsbeg" href="resources/fieldsbeg.html">FIELDSBEG</a></td>
<td><a name="fieldsend" href="resources/fieldsend.html">FIELDSEND</a></td>
</tr>
<tr>
<td><a name="fieldstyles" href="resources/fieldstyles.html">FIELDSTYLES</a></td>
<td><a name="fldbeg" href="resources/fldbeg.html">FLDBEG</a></td>
<td><a name="fldend" href="resources/fldend.html">FLDEND</a></td>
</tr>
<tr>
<td><a name="folrefs" href="resources/folrefs.html">FOLREFS</a></td>
<td><a name="folupbegin" href="resources/folupbegin.html">FOLUPBEGIN</a></td>
<td><a name="folupend" href="resources/folupend.html">FOLUPEND</a></td>
</tr>
<tr>
<td><a name="foluplitxt" href="resources/foluplitxt.html">FOLUPLITXT</a></td>
<td><a name="footer" href="resources/footer.html">FOOTER</a></td>
<td><a name="force" href="resources/force.html">FORCE</a></td>
</tr>
<tr>
<td><a name="genidx" href="resources/genidx.html">GENIDX</a></td>
<td><a name="gmtdatefmt" href="resources/gmtdatefmt.html">GMTDATEFMT</a></td>
<td><a name="gzipexe" href="resources/gzipexe.html">GZIPEXE</a></td>
</tr>
<tr>
<td><a name="gzipfiles" href="resources/gzipfiles.html">GZIPFILES</a></td>
<td><a name="gziplinks" href="resources/gziplinks.html">GZIPLINKS</a></td>
<td><a name="headbodysep" href="resources/headbodysep.html">HEADBODYSEP</a></td>
</tr>
<tr>
<td><a name="header" href="resources/header.html">HEADER</a></td>
<td><a name="htmlext" href="resources/htmlext.html">HTMLEXT</a></td>
<td><a name="icons" href="resources/icons.html">ICONS</a></td>
</tr>
<tr>
<td><a name="idxfname" href="resources/idxfname.html">IDXFNAME</a></td>
<td><a name="idxlabel" href="resources/idxlabel.html">IDXLABEL</a></td>
<td><a name="idxpgbegin" href="resources/idxpgbegin.html">IDXPGBEGIN</a></td>
</tr>
<tr>
<td><a name="idxpgend" href="resources/idxpgend.html">IDXPGEND</a></td>
<td><a name="idxprefix" href="resources/idxprefix.html">IDXPREFIX</a></td>
<td><a name="idxsize" href="resources/idxsize.html">IDXSIZE</a></td>
</tr>
<tr>
<td><a name="include" href="resources/include.html">INCLUDE</a></td>
<td><a name="labelbeg" href="resources/labelbeg.html">LABELBEG</a></td>
<td><a name="labelend" href="resources/labelend.html">LABELEND</a></td>
</tr>
<tr>
<td><a name="labelstyles" href="resources/labelstyles.html">LABELSTYLES</a></td>
<td><a name="listbegin" href="resources/listbegin.html">LISTBEGIN</a></td>
<td><a name="listend" href="resources/listend.html">LISTEND</a></td>
</tr>
<tr>
<td><a name="litemplate" href="resources/litemplate.html">LITEMPLATE</a></td>
<td><a name="localdatefmt" href="resources/localdatefmt.html">LOCALDATEFMT</a></td>
<td><a name="lockdelay" href="resources/lockdelay.html">LOCKDELAY</a></td>
</tr>
<tr>
<td><a name="locktries" href="resources/locktries.html">LOCKTRIES</a></td>
<td><a name="mailto" href="resources/mailto.html">MAILTO</a></td>
<td><a name="mailtourl" href="resources/mailtourl.html">MAILTOURL</a></td>
</tr>
<tr>
<td><a name="main" href="resources/main.html">MAIN</a></td>
<td><a name="maxsize" href="resources/maxsize.html">MAXSIZE</a></td>
<td><a name="mhpattern" href="resources/mhpattern.html">MHPATTERN</a></td>
</tr>
<tr>
<td><a name="mimeargs" href="resources/mimeargs.html">MIMEARGS</a></td>
<td><a name="mimefilters" href="resources/mimefilters.html">MIMEFILTERS</a></td>
<td><a name="modtime" href="resources/modtime.html">MODTIME</a></td>
</tr>
<tr>
<td><a name="months" href="resources/months.html">MONTHS</a></td>
<td><a name="monthsabr" href="resources/monthsabr.html">MONTHSABR</a></td>
<td><a name="msgbodyend" href="resources/msgbodyend.html">MSGBODYEND</a></td>
</tr>
<tr>
<td><a name="msgfoot" href="resources/msgfoot.html">MSGFOOT</a></td>
<td><a name="msggmtdatefmt" href="resources/msggmtdatefmt.html">MSGGMTDATEFMT</a></td>
<td><a name="msghead" href="resources/msghead.html">MSGHEAD</a></td>
</tr>
<tr>
<td><a name="msglocaldatefmt" href="resources/msglocaldatefmt.html">MSGLOCALDATEFMT</a></td>
<td><a name="msgpgbegin" href="resources/msgpgbegin.html">MSGPGBEGIN</a></td>
<td><a name="msgpgend" href="resources/msgpgend.html">MSGPGEND</a></td>
</tr>
<tr>
<td><a name="msgprefix" href="resources/msgprefix.html">MSGPREFIX</a></td>
<td><a name="msgsep" href="resources/msgsep.html">MSGSEP</a></td>
<td><a name="multipg" href="resources/multipg.html">MULTIPG</a></td>
</tr>
<tr>
<td><a name="news" href="resources/news.html">NEWS</a></td>
<td><a name="nextbutton" href="resources/nextbutton.html">NEXTBUTTON</a></td>
<td><a name="nextbuttonia" href="resources/nextbuttonia.html">NEXTBUTTONIA</a></td>
</tr>
<tr>
<td><a name="nextlink" href="resources/nextlink.html">NEXTLINK</a></td>
<td><a name="nextlinkia" href="resources/nextlinkia.html">NEXTLINKIA</a></td>
<td><a name="nextpglink" href="resources/nextpglink.html">NEXTPGLINK</a></td>
</tr>
<tr>
<td><a name="nextpglinkia" href="resources/nextpglinkia.html">NEXTPGLINKIA</a></td>
<td><a name="otherindexes" href="resources/otherindexes.html">OTHERINDEXES</a></td>
<td><a name="outdir" href="resources/outdir.html">OUTDIR</a></td>
</tr>
<tr>
<td><a name="perlinc" href="resources/perlinc.html">PERLINC</a></td>
<td><a name="prevbutton" href="resources/prevbutton.html">PREVBUTTON</a></td>
<td><a name="prevbuttonia" href="resources/prevbuttonia.html">PREVBUTTONIA</a></td>
</tr>
<tr>
<td><a name="prevlink" href="resources/prevlink.html">PREVLINK</a></td>
<td><a name="prevlinkia" href="resources/prevlinkia.html">PREVLINKIA</a></td>
<td><a name="prevpglink" href="resources/prevpglink.html">PREVPGLINK</a></td>
</tr>
<tr>
<td><a name="prevpglinkia" href="resources/prevpglinkia.html">PREVPGLINKIA</a></td>
<td><a name="quiet" href="resources/quiet.html">QUIET</a></td>
<td><a name="rcfile" href="resources/rcfile.html">RCFILE</a></td>
</tr>
<tr>
<td><a name="refsbegin" href="resources/refsbegin.html">REFSBEGIN</a></td>
<td><a name="refsend" href="resources/refsend.html">REFSEND</a></td>
<td><a name="refslitxt" href="resources/refslitxt.html">REFSLITXT</a></td>
</tr>
<tr>
<td><a name="reverse" href="resources/reverse.html">REVERSE</a></td>
<td><a name="rmm" href="resources/rmm.html">RMM</a></td>
<td><a name="scan" href="resources/scan.html">SCAN</a></td>
</tr>
<tr>
<td><a name="single" href="resources/single.html">SINGLE</a></td>
<td><a name="sort" href="resources/sort.html">SORT</a></td>
<td><a name="subjectbegin" href="resources/subjectbegin.html">SUBJECTBEGIN</a></td>
</tr>
<tr>
<td><a name="subjectend" href="resources/subjectend.html">SUBJECTEND</a></td>
<td><a name="subjectheader" href="resources/subjectheader.html">SUBJECTHEADER</a></td>
<td><a name="subsort" href="resources/subsort.html">SUBSORT</a></td>
</tr>
<tr>
<td><a name="tcontbegin" href="resources/tcontbegin.html">TCONTBEGIN</a></td>
<td><a name="tcontend" href="resources/tcontend.html">TCONTEND</a></td>
<td><a name="tfoot" href="resources/tfoot.html">TFOOT</a></td>
</tr>
<tr>
<td><a name="thead" href="resources/thead.html">THEAD</a></td>
<td><a name="thread" href="resources/thread.html">THREAD</a></td>
<td><a name="tidxfname" href="resources/tidxfname.html">TIDXFNAME</a></td>
</tr>
<tr>
<td><a name="tidxlabel" href="resources/tidxlabel.html">TIDXLABEL</a></td>
<td><a name="tidxpgbegin" href="resources/tidxpgbegin.html">TIDXPGBEGIN</a></td>
<td><a name="tidxpgend" href="resources/tidxpgend.html">TIDXPGEND</a></td>
</tr>
<tr>
<td><a name="tidxprefix" href="resources/tidxprefix.html">TIDXPREFIX</a></td>
<td><a name="timezones" href="resources/timezones.html">TIMEZONES</a></td>
<td><a name="tindentbegin" href="resources/tindentbegin.html">TINDENTBEGIN</a></td>
</tr>
<tr>
<td><a name="tindentend" href="resources/tindentend.html">TINDENTEND</a></td>
<td><a name="title" href="resources/title.html">TITLE</a></td>
<td><a name="tlevels" href="resources/tlevels.html">TLEVELS</a></td>
</tr>
<tr>
<td><a name="tliend" href="resources/tliend.html">TLIEND</a></td>
<td><a name="tlinone" href="resources/tlinone.html">TLINONE</a></td>
<td><a name="tlinoneend" href="resources/tlinoneend.html">TLINONEEND</a></td>
</tr>
<tr>
<td><a name="tlitxt" href="resources/tlitxt.html">TLITXT</a></td>
<td><a name="tnextbutton" href="resources/tnextbutton.html">TNEXTBUTTON</a></td>
<td><a name="tnextbuttonia" href="resources/tnextbuttonia.html">TNEXTBUTTONIA</a></td>
</tr>
<tr>
<td><a name="tnextlink" href="resources/tnextlink.html">TNEXTLINK</a></td>
<td><a name="tnextlinkia" href="resources/tnextlinkia.html">TNEXTLINKIA</a></td>
<td><a name="tnextpglink" href="resources/tnextpglink.html">TNEXTPGLINK</a></td>
</tr>
<tr>
<td><a name="tnextpglinkia" href="resources/tnextpglinkia.html">TNEXTPGLINKIA</a></td>
<td><a name="toplinks" href="resources/toplinks.html">TOPLINKS</a></td>
<td><a name="tprevbutton" href="resources/tprevbutton.html">TPREVBUTTON</a></td>
</tr>
<tr>
<td><a name="tprevbuttonia" href="resources/tprevbuttonia.html">TPREVBUTTONIA</a></td>
<td><a name="tprevlink" href="resources/tprevlink.html">TPREVLINK</a></td>
<td><a name="tprevlinkia" href="resources/tprevlinkia.html">TPREVLINKIA</a></td>
</tr>
<tr>
<td><a name="tprevpglink" href="resources/tprevpglink.html">TPREVPGLINK</a></td>
<td><a name="tprevpglinkia" href="resources/tprevpglinkia.html">TPREVPGLINKIA</a></td>
<td><a name="treverse" href="resources/treverse.html">TREVERSE</a></td>
</tr>
<tr>
<td><a name="tsingletxt" href="resources/tsingletxt.html">TSINGLETXT</a></td>
<td><a name="tsort" href="resources/tsort.html">TSORT</a></td>
<td><a name="tsubjectbeg" href="resources/tsubjectbeg.html">TSUBJECTBEG</a></td>
</tr>
<tr>
<td><a name="tsubjectend" href="resources/tsubjectend.html">TSUBJECTEND</a></td>
<td><a name="tsublistbeg" href="resources/tsublistbeg.html">TSUBLISTBEG</a></td>
<td><a name="tsublistend" href="resources/tsublistend.html">TSUBLISTEND</a></td>
</tr>
<tr>
<td><a name="tsubsort" href="resources/tsubsort.html">TSUBSORT</a></td>
<td><a name="ttitle" href="resources/ttitle.html">TTITLE</a></td>
<td><a name="ttopbegin" href="resources/ttopbegin.html">TTOPBEGIN</a></td>
</tr>
<tr>
<td><a name="ttopend" href="resources/ttopend.html">TTOPEND</a></td>
<td><a name="umask" href="resources/umask.html">UMASK</a></td>
<td><a name="weekdays" href="resources/weekdays.html">WEEKDAYS</a></td>
</tr>
<tr>
<td><a name="weekdaysabr" href="resources/weekdaysabr.html">WEEKDAYSABR</a></td>
<td></td>
<td></td>
</tr>
<tr>
<td colspan=3><hr noshade size=0></td>
</tr>
</tbody>
</table>
<!--X-Resource-Index-End-->

<!-- *************************************************************** -->
<hr>
<!--X-NavButtons-Start-->
<p align=center>
[<a href="layout.html">Prev</a>][<a href="diagnos.html">Next</a>][<a href="mhonarc.html">TOC</a>][<a href="http://www.oac.uci.edu/indiv/ehood/MHonArc/faq/faq.html">FAQ</a>][<a href="bugs.html">Bugs</a>][<a href="http://www.oac.uci.edu/indiv/ehood/mhonarc.html">Home</a>]
</p>
<!--X-NavButtons-End-->

<!-- *************************************************************** -->
<hr>
<address>
97/06/05 17:59:00<br>
<img align="top" src="monicon.gif" alt="">
<a href="http://www.oac.uci.edu/indiv/ehood/mhonarc.html"
><strong>MHonArc</strong></a><br>
Copyright &#169; 1997, <a href="http://www.oac.uci.edu/indiv/ehood/"
>Earl Hood</a>, <a href="mailto:ehood@medusa.acs.uci.edu"
>ehood@medusa.acs.uci.edu</a><br>
</address>

</body>
</html>