Initial commit of OpenSPARC T2 design and verification files.
[OpenSPARC-T2-DV] / tools / perl-5.8.0 / doc / MHonArc / resources / msghead.html
CommitLineData
86530b38
AT
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML//EN">
2<html>
3<head>
4<title>MHonArc Resources: MSGHEAD</title>
5</head>
6<body>
7<!--x-rc-nav-->
8<table border=0><tr valign="top">
9<td align="left" width="50%">[Prev:&nbsp;<a href="msggmtdatefmt.html">MSGGMTDATEFMT</a>]</td><td><nobr>[<a href="../resources.html#msghead">Resources</a>][<a href="../mhonarc.html">TOC</a>]</nobr></td><td align="right" width="50%">[Next:&nbsp;<a href="msgidlink.html">MSGIDLINK</a>]</td></tr></table>
10<!--/x-rc-nav-->
11<hr>
12<h1>MSGHEAD</h1>
13
14<!-- *************************************************************** -->
15<hr>
16<h2>Syntax</h2>
17
18<dl>
19
20<dt><strong>Envariable</strong></dt>
21<dd><p>N/A
22</p>
23</dd>
24
25<dt><strong>Element</strong></dt>
26<dd><p>
27<code>&lt;MSGHEAD&gt;<br></code>
28<var>markup ...</var><br>
29<code>&lt;/MSGHEAD&gt;<br></code>
30</p>
31</dd>
32
33<dt><strong>Command-line Option</strong></dt>
34<dd><p>N/A
35</p>
36</dd>
37
38</dl>
39
40<!-- *************************************************************** -->
41<hr>
42<h2>Description</h2>
43
44<p>MSGHEAD defines the markup to occur at the head of each
45converted message page.
46</p>
47
48<!-- *************************************************************** -->
49<hr>
50<h2>Default Setting</h2>
51
52<p>Nil
53</p>
54
55<!-- *************************************************************** -->
56<hr>
57<h2>Resource Variables</h2>
58
59<table border=1>
60<tr bgcolor="#C0C0C0">
61<th>Variable</th><th>Value</th>
62</tr>
63<tr valign=top>
64<td align=center><a name="BUTTON" href="../rcvars.html#BUTTON"><strong><code>$BUTTON$</code></strong></a></td>
65<td>Button markup linking to a message.</td>
66</tr>
67<tr valign=top>
68<td align=center><a name="DATE" href="../rcvars.html#DATE"><strong><code>$DATE$</code></strong></a></td>
69<td>The date of the message.</td>
70</tr>
71<tr valign=top>
72<td align=center><a name="DDMMYYYY" href="../rcvars.html#DDMMYYYY"><strong><code>$DDMMYYYY$</code></strong></a></td>
73<td>Message date in dd/mm/yyyy format.</td>
74</tr>
75<tr valign=top>
76<td align=center><a name="DOCURL" href="../rcvars.html#DOCURL"><strong><code>$DOCURL$</code></strong></a></td>
77<td>URL to documentation.</td>
78</tr>
79<tr valign=top>
80<td align=center><a name="ENV" href="../rcvars.html#ENV"><strong><code>$ENV$</code></strong></a></td>
81<td>Value of an environment variable.</td>
82</tr>
83<tr valign=top>
84<td align=center><a name="FROM" href="../rcvars.html#FROM"><strong><code>$FROM$</code></strong></a></td>
85<td>The complete text in the <tt>From:</tt> field of the message.</td>
86</tr>
87<tr valign=top>
88<td align=center><a name="FROMADDR" href="../rcvars.html#FROMADDR"><strong><code>$FROMADDR$</code></strong></a></td>
89<td>The e-mail address in the <tt>From:</tt> field of the message.</td>
90</tr>
91<tr valign=top>
92<td align=center><a name="FROMADDRDOMAIN" href="../rcvars.html#FROMADDRDOMAIN"><strong><code>$FROMADDRDOMAIN$</code></strong></a></td>
93<td>The e-mail address domain of the <tt>From:</tt> field of the message.</td>
94</tr>
95<tr valign=top>
96<td align=center><a name="FROMADDRNAME" href="../rcvars.html#FROMADDRNAME"><strong><code>$FROMADDRNAME$</code></strong></a></td>
97<td>The e-mail address "username" (or local-part) of the <tt>From:</tt> field of the message.</td>
98</tr>
99<tr valign=top>
100<td align=center><a name="FROMNAME" href="../rcvars.html#FROMNAME"><strong><code>$FROMNAME$</code></strong></a></td>
101<td>The human name of the person in the <tt>From:</tt> field of the message. If no human name is found, the username specified in the e-mail address is used.</td>
102</tr>
103<tr valign=top>
104<td align=center><a name="GMTDATE" href="../rcvars.html#GMTDATE"><strong><code>$GMTDATE$</code></strong></a></td>
105<td>Current GMT date.</td>
106</tr>
107<tr valign=top>
108<td align=center><a name="ICON" href="../rcvars.html#ICON"><strong><code>$ICON$</code></strong></a></td>
109<td>The context-type sensitive icon.</td>
110</tr>
111<tr valign=top>
112<td align=center><a name="ICONURL" href="../rcvars.html#ICONURL"><strong><code>$ICONURL$</code></strong></a></td>
113<td>The URL to the context-type sensitive icon.</td>
114</tr>
115<tr valign=top>
116<td align=center><a name="IDXFNAME" href="../rcvars.html#IDXFNAME"><strong><code>$IDXFNAME$</code></strong></a></td>
117<td>Filename of main index page.</td>
118</tr>
119<tr valign=top>
120<td align=center><a name="IDXLABEL" href="../rcvars.html#IDXLABEL"><strong><code>$IDXLABEL$</code></strong></a></td>
121<td>Label for main index page.</td>
122</tr>
123<tr valign=top>
124<td align=center><a name="IDXPREFIX" href="../rcvars.html#IDXPREFIX"><strong><code>$IDXPREFIX$</code></strong></a></td>
125<td>Prefix of filenames of main index pages.</td>
126</tr>
127<tr valign=top>
128<td align=center><a name="IDXSIZE" href="../rcvars.html#IDXSIZE"><strong><code>$IDXSIZE$</code></strong></a></td>
129<td>Max number of messages that may be listed in index page.</td>
130</tr>
131<tr valign=top>
132<td align=center><a name="IDXTITLE" href="../rcvars.html#IDXTITLE"><strong><code>$IDXTITLE$</code></strong></a></td>
133<td>The title of the main index page.</td>
134</tr>
135<tr valign=top>
136<td align=center><a name="LINK" href="../rcvars.html#LINK"><strong><code>$LINK$</code></strong></a></td>
137<td>Link markup linking to a message.</td>
138</tr>
139<tr valign=top>
140<td align=center><a name="LOCALDATE" href="../rcvars.html#LOCALDATE"><strong><code>$LOCALDATE$</code></strong></a></td>
141<td>Current local date.</td>
142</tr>
143<tr valign=top>
144<td align=center><a name="MMDDYYYY" href="../rcvars.html#MMDDYYYY"><strong><code>$MMDDYYYY$</code></strong></a></td>
145<td>Message date in mm/dd/yyyy format.</td>
146</tr>
147<tr valign=top>
148<td align=center><a name="MSG" href="../rcvars.html#MSG"><strong><code>$MSG$</code></strong></a></td>
149<td>Filename of message.</td>
150</tr>
151<tr valign=top>
152<td align=center><a name="MSGGMTDATE" href="../rcvars.html#MSGGMTDATE"><strong><code>$MSGGMTDATE$</code></strong></a></td>
153<td>GMT date of current message.</td>
154</tr>
155<tr valign=top>
156<td align=center><a name="MSGID" href="../rcvars.html#MSGID"><strong><code>$MSGID$</code></strong></a></td>
157<td>The message-id of the message.</td>
158</tr>
159<tr valign=top>
160<td align=center><a name="MSGLOCALDATE" href="../rcvars.html#MSGLOCALDATE"><strong><code>$MSGLOCALDATE$</code></strong></a></td>
161<td>Local date of current message.</td>
162</tr>
163<tr valign=top>
164<td align=center><a name="MSGNUM" href="../rcvars.html#MSGNUM"><strong><code>$MSGNUM$</code></strong></a></td>
165<td>The message number assigned to the message by MHonArc (includes leading zeros).</td>
166</tr>
167<tr valign=top>
168<td align=center><a name="MSGPREFIX" href="../rcvars.html#MSGPREFIX"><strong><code>$MSGPREFIX$</code></strong></a></td>
169<td>Filename prefix for message files.</td>
170</tr>
171<tr valign=top>
172<td align=center><a name="MSGTORDNUM" href="../rcvars.html#MSGTORDNUM"><strong><code>$MSGTORDNUM$</code></strong></a></td>
173<td>The ordinal message number of the current discussion thread.</td>
174</tr>
175<tr valign=top>
176<td align=center><a name="NOTE" href="../rcvars.html#NOTE"><strong><code>$NOTE$</code></strong></a></td>
177<td>Message annotation.</td>
178</tr>
179<tr valign=top>
180<td align=center><a name="NUMFOLUP" href="../rcvars.html#NUMFOLUP"><strong><code>$NUMFOLUP$</code></strong></a></td>
181<td>Number of explicit follow-ups to the message.</td>
182</tr>
183<tr valign=top>
184<td align=center><a name="NUMOFMSG" href="../rcvars.html#NUMOFMSG"><strong><code>$NUMOFMSG$</code></strong></a></td>
185<td>Number of messages in the archive.</td>
186</tr>
187<tr valign=top>
188<td align=center><a name="NUMOFPAGES" href="../rcvars.html#NUMOFPAGES"><strong><code>$NUMOFPAGES$</code></strong></a></td>
189<td>Number of index pages.</td>
190</tr>
191<tr valign=top>
192<td align=center><a name="ORDNUM" href="../rcvars.html#ORDNUM"><strong><code>$ORDNUM$</code></strong></a></td>
193<td>The current listing number of the message.</td>
194</tr>
195<tr valign=top>
196<td align=center><a name="OUTDIR" href="../rcvars.html#OUTDIR"><strong><code>$OUTDIR$</code></strong></a></td>
197<td>Pathname of archive.</td>
198</tr>
199<tr valign=top>
200<td align=center><a name="PROG" href="../rcvars.html#PROG"><strong><code>$PROG$</code></strong></a></td>
201<td>Program name</td>
202</tr>
203<tr valign=top>
204<td align=center><a name="SUBJECT" href="../rcvars.html#SUBJECT"><strong><code>$SUBJECT$</code></strong></a></td>
205<td>The subject text of the message, and if no arguments, wrapped in an anchor element that hyperlinks to the message.</td>
206</tr>
207<tr valign=top>
208<td align=center><a name="SUBJECTNA" href="../rcvars.html#SUBJECTNA"><strong><code>$SUBJECTNA$</code></strong></a></td>
209<td>The subject text of the message without the anchor element.</td>
210</tr>
211<tr valign=top>
212<td align=center><a name="TIDXFNAME" href="../rcvars.html#TIDXFNAME"><strong><code>$TIDXFNAME$</code></strong></a></td>
213<td>Filename of thread index page.</td>
214</tr>
215<tr valign=top>
216<td align=center><a name="TIDXLABEL" href="../rcvars.html#TIDXLABEL"><strong><code>$TIDXLABEL$</code></strong></a></td>
217<td>Label for thread index page.</td>
218</tr>
219<tr valign=top>
220<td align=center><a name="TIDXPREFIX" href="../rcvars.html#TIDXPREFIX"><strong><code>$TIDXPREFIX$</code></strong></a></td>
221<td>Prefix of filenames of thread index pages.</td>
222</tr>
223<tr valign=top>
224<td align=center><a name="TIDXTITLE" href="../rcvars.html#TIDXTITLE"><strong><code>$TIDXTITLE$</code></strong></a></td>
225<td>Title of thread index.</td>
226</tr>
227<tr valign=top>
228<td align=center><a name="TLEVEL" href="../rcvars.html#TLEVEL"><strong><code>$TLEVEL$</code></strong></a></td>
229<td>Numeric level of message in thread, starting with 0.</td>
230</tr>
231<tr valign=top>
232<td align=center><a name="TSLICE" href="../rcvars.html#TSLICE"><strong><code>$TSLICE$</code></strong></a></td>
233<td>A <em>slice</em> of the thread listing relative to the current message. Size of slice determined by the TSLICE resource.</td>
234</tr>
235<tr valign=top>
236<td align=center><a name="VERSION" href="../rcvars.html#VERSION"><strong><code>$VERSION$</code></strong></a></td>
237<td>Program version.</td>
238</tr>
239<tr valign=top>
240<td align=center><a name="YYYYMMDD" href="../rcvars.html#YYYYMMDD"><strong><code>$YYYYMMDD$</code></strong></a></td>
241<td>Message date in yyyy/mm/dd format.</td>
242</tr>
243</table>
244
245<!-- *************************************************************** -->
246<hr>
247<h2>Examples</h2>
248
249<p>None.
250</p>
251
252<!-- *************************************************************** -->
253<hr>
254<h2>Version</h2>
255
256<p>1.1.0
257</p>
258
259<!-- *************************************************************** -->
260<hr>
261<h2>See Also</h2>
262
263<p>
264<a href="msgfoot.html">MSGFOOT</a>,
265<a href="msgpgbegin.html">MSGPGBEGIN</a>,
266<a href="msgpgend.html">MSGPGEND</a>
267</p>
268<p>
269<a href="../layout.html"><strong>Page Layout</strong></a>
270</p>
271
272<!-- *************************************************************** -->
273<hr>
274<!--x-rc-nav-->
275<table border=0><tr valign="top">
276<td align="left" width="50%">[Prev:&nbsp;<a href="msggmtdatefmt.html">MSGGMTDATEFMT</a>]</td><td><nobr>[<a href="../resources.html#msghead">Resources</a>][<a href="../mhonarc.html">TOC</a>]</nobr></td><td align="right" width="50%">[Next:&nbsp;<a href="msgidlink.html">MSGIDLINK</a>]</td></tr></table>
277<!--/x-rc-nav-->
278<hr>
279<address>
280$Date: 2002/07/27 05:13:10 $ <br>
281<img align="top" src="../monicon.png" alt="">
282<a href="http://www.mhonarc.org/"><strong>MHonArc</strong></a><br>
283Copyright &#169; 1997-1998, <a href="http://www.earlhood.com/">Earl Hood</a>, <a href="mailto:mhonarc@mhonarc.org">mhonarc@mhonarc.org</a><br>
284</address>
285
286</body>
287</html>