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
|
<html>
<head>
<title>MHonArc Resources: DEFINEVAR</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="definederived.html">DEFINEDERIVED</a>]</td><td><nobr>[<a href="../resources.html#definevar">Resources</a>][<a href="../mhonarc.html">TOC</a>]</nobr></td><td align="right" width="50%">[Next: <a href="defrcfile.html">DEFRCFILE</a>]</td></tr></table>
<!--/x-rc-nav-->
<hr>
<h1>DEFINEVAR</h1>
<!--X-TOC-Start-->
<ul>
<li><a href="#syntax">Syntax</a>
<li><a href="#description">Description</a>
<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>N/A
</p>
</dd>
<dt><strong>Element</strong></dt>
<dd><p>
<code><DEFINEVAR><br></code>
<var>variable-name</var><br>
<var>value ...</var><br>
<code></DEFINEVAR><br></code>
</p>
</dd>
<dt><strong>Command-line Option</strong></dt>
<dd><p>
<code>-definevar </code><var>variable-specification-list</var>
</p>
</dd>
</dl>
<!-- *************************************************************** -->
<hr>
<h2><a name="description">Description</a></h2>
<p>DEFINEVAR is used for creating user-defined resource variables.
DEFINEVAR can be defined on the command-line or in the resource file.
</p>
<p>On the command-line, the option is called <code>-definevar</code>
The following argument after <code>-definevar</code>
is treated as a variable specification list. The specification list
is a string containing name/value pairs with the following format: </p>
<p><var>NAME</var><code>=</code><var>VALUE</var></p>
<p>Multiple name/value pairs are separated
by whitespace.
If <var>VALUE</var> contains whitespace, then it must be surrounded
by quotes to prevent the command shell from treating the string
as multiple arguments.
Multiple <code>-definevar</code> options can be specified on the
command-line. This can help reduce the ugliness of specify mutliple
variable definitions with a single option.
</p>
<table class="note" width="100%">
<tr valign=top>
<td><strong>NOTE:</strong></td>
<td width="100%"><p>If you intend to include resource variables as part of the
<var>VALUE</var>, you may need to escape the '$' characters (and possible
other characters) to
prevent interpolation by the command shell. See your command
shell documentation for more information.
</p>
</td>
</tr>
</table>
<p>In a resource file the <DEFINEVAR> element may occur mutliple times
to define multiple variables. The first line of the <DEFINEVAR>
element is the name of the variables. All subsequent lines represent
the content of the variable. If you do not want
the last newline of a <DEFINEVAR> element content to be part of
the defined
variable content, then specify the <b><tt>chop</tt></b> attribute.
</p>
<!-- *************************************************************** -->
<hr>
<h2><a name="default">Default Setting</a></h2>
<p>N/A
</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 is a simple example of defining a variable to
represent the base text for the title of an archive:
</p>
<pre class="code">
<b><DefineVar chop></b>
MAIN-TITLE
Comp.lang.perl.misc
<b></DefineVar></b>
</pre>
<p>Now, the variable can be refernced as follows:
</p>
<pre class="code">
<b><<a href="ttitle.html">TTitle</a> chop></b>
$MAIN-TITLE$ (thread)
<b></TTitle></b>
</pre>
<p>If you wanted to use the same resource file for multiple arcvhives
it may better to define <code>$MAIN-TITLE$</code> on the command-line
as follows:
</p>
<table border=1 width="100%"><tr><td><pre class="shell">
prompt> <b>mhonarc -definevar MAIN-TITLE='mhonarc mailing list'</b> ...
</pre></td></tr></table>
<!-- *************************************************************** -->
<hr>
<h2><a name="version">Version</a></h2>
<p>2.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="definederived.html">DEFINEDERIVED</a>]</td><td><nobr>[<a href="../resources.html#definevar">Resources</a>][<a href="../mhonarc.html">TOC</a>]</nobr></td><td align="right" width="50%">[Next: <a href="defrcfile.html">DEFRCFILE</a>]</td></tr></table>
<!--/x-rc-nav-->
<hr>
<address>
$Date: 2003/10/06 22:04:16 $ <br>
<img align="top" src="../monicon.png" alt="">
<a href="http://www.mhonarc.org/"><strong>MHonArc</strong></a><br>
Copyright © 1997-1998, <a href="http://www.earlhood.com/">Earl Hood</a>, <a href="mailto:mhonarc%40mhonarc.org">mhonarc<!--
-->@<!--
-->mhonarc.org</a><br>
</address>
</body>
</html>
|
