projects / OpenSPARC-T2-DV / blame
? search:
summary | tags | clone url | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
Initial commit of OpenSPARC T2 design and verification files.
[OpenSPARC-T2-DV] / tools / perl-5.8.0 / doc / MHonArc / resources / notedir.html
CommitLineData
86530b38
AT		 1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML//EN">
2<html>
3<head>
4<title>MHonArc Resources: NOTEDIR</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="note.html">NOTE</a>]</td><td><nobr>[<a href="../resources.html#notedir">Resources</a>][<a href="../mhonarc.html">TOC</a>]</nobr></td><td align="right" width="50%">[Next:&nbsp;<a href="noteia.html">NOTEIA</a>]</td></tr></table>
10<!--/x-rc-nav-->
11<hr>
12<h1>NOTEDIR</h1>
13
14<!-- *************************************************************** -->
15<hr>
16<h2>Syntax</h2>
17
18<dl>
19
20<dt><strong>Envariable</strong></dt>
21<dd><p>
22<code>M2H_NOTEDIR=</code><var>pathname</var>
23</p>
24</dd>
25
26<dt><strong>Element</strong></dt>
27<dd><p>
28<code>&lt;NOTEDIR&gt;</code><br>
29<var>pathname</var><br>
30<code>&lt;/NOTEDIR&gt;</code><br>
31</p>
32</dd>
33
34<dt><strong>Command-line Option</strong></dt>
35<dd><p>
36<code>-notedir </code><var>pathname</var>
37</p>
38</dd>
39
40</dl>
41
42<!-- *************************************************************** -->
43<hr>
44<h2>Description</h2>
45
46<p>NOTEDIR defines the directory location to store annotation data
47for messages. If NOTEDIR is a relative pathname, it is treated
48relative to
49<a href="outdir.html">OUTDIR</a>. If NOTEDIR does not exist,
50MHonArc will attempt to create the directory when an annotation
51is added to a message.
52</p>
53
54<p>Each message's annotation is stored in a separate file within
55NOTEDIR. The filenames used for the annotations are the message-ids
56of the messages.
57</p>
58
59<table border=0 cellpadding=4>
60<tr valign=top>
61<td><strong>NOTE</strong></td>
62<td><p>This implies that your system supports long filenames. If
63your system does not, you cannot use the annotation facilities
64provided by MHonArc.
65</p>
66</td>
67</tr>
68</table>
69
70<p>Since message-ids are unique, it is possible to have a single
71notes directory for multiple archives. To do this, set NOTEDIR
72to the same absolute pathname for each archive. Having a shared
73location can be useful if you move or recreate archives (no
74need to re-annotate). Also, if the same message exists in
75multiple archives, the message will have the same annotation
76across the archives.
77</p>
78
79<p>MHonArc will assign
80message-ids to messages without message-ids. Therefore, annotations
81can be created for these message.
82</p>
83
84<!-- *************************************************************** -->
85<hr>
86<h2>Default Setting</h2>
87
88<pre>
89notes
90</pre>
91
92<!-- *************************************************************** -->
93<hr>
94<h2>Resource Variables</h2>
95
96<table border=1>
97<tr bgcolor="#C0C0C0">
98<th>Variable</th><th>Value</th>
99</tr>
100<tr valign=top>
101<td align=center><a name="BUTTON" href="../rcvars.html#BUTTON"><strong><code>$BUTTON$</code></strong></a></td>
102<td>Button markup linking to a message.</td>
103</tr>
104<tr valign=top>
105<td align=center><a name="DATE" href="../rcvars.html#DATE"><strong><code>$DATE$</code></strong></a></td>
106<td>The date of the message.</td>
107</tr>
108<tr valign=top>
109<td align=center><a name="DDMMYYYY" href="../rcvars.html#DDMMYYYY"><strong><code>$DDMMYYYY$</code></strong></a></td>
110<td>Message date in dd/mm/yyyy format.</td>
111</tr>
112<tr valign=top>
113<td align=center><a name="DOCURL" href="../rcvars.html#DOCURL"><strong><code>$DOCURL$</code></strong></a></td>
114<td>URL to documentation.</td>
115</tr>
116<tr valign=top>
117<td align=center><a name="ENV" href="../rcvars.html#ENV"><strong><code>$ENV$</code></strong></a></td>
118<td>Value of an environment variable.</td>
119</tr>
120<tr valign=top>
121<td align=center><a name="FROM" href="../rcvars.html#FROM"><strong><code>$FROM$</code></strong></a></td>
122<td>The complete text in the <tt>From:</tt> field of the message.</td>
123</tr>
124<tr valign=top>
125<td align=center><a name="FROMADDR" href="../rcvars.html#FROMADDR"><strong><code>$FROMADDR$</code></strong></a></td>
126<td>The e-mail address in the <tt>From:</tt> field of the message.</td>
127</tr>
128<tr valign=top>
129<td align=center><a name="FROMADDRDOMAIN" href="../rcvars.html#FROMADDRDOMAIN"><strong><code>$FROMADDRDOMAIN$</code></strong></a></td>
130<td>The e-mail address domain of the <tt>From:</tt> field of the message.</td>
131</tr>
132<tr valign=top>
133<td align=center><a name="FROMADDRNAME" href="../rcvars.html#FROMADDRNAME"><strong><code>$FROMADDRNAME$</code></strong></a></td>
134<td>The e-mail address "username" (or local-part) of the <tt>From:</tt> field of the message.</td>
135</tr>
136<tr valign=top>
137<td align=center><a name="FROMNAME" href="../rcvars.html#FROMNAME"><strong><code>$FROMNAME$</code></strong></a></td>
138<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>
139</tr>
140<tr valign=top>
141<td align=center><a name="GMTDATE" href="../rcvars.html#GMTDATE"><strong><code>$GMTDATE$</code></strong></a></td>
142<td>Current GMT date.</td>
143</tr>
144<tr valign=top>
145<td align=center><a name="ICON" href="../rcvars.html#ICON"><strong><code>$ICON$</code></strong></a></td>
146<td>The context-type sensitive icon.</td>
147</tr>
148<tr valign=top>
149<td align=center><a name="ICONURL" href="../rcvars.html#ICONURL"><strong><code>$ICONURL$</code></strong></a></td>
150<td>The URL to the context-type sensitive icon.</td>
151</tr>
152<tr valign=top>
153<td align=center><a name="IDXFNAME" href="../rcvars.html#IDXFNAME"><strong><code>$IDXFNAME$</code></strong></a></td>
154<td>Filename of main index page.</td>
155</tr>
156<tr valign=top>
157<td align=center><a name="IDXLABEL" href="../rcvars.html#IDXLABEL"><strong><code>$IDXLABEL$</code></strong></a></td>
158<td>Label for main index page.</td>
159</tr>
160<tr valign=top>
161<td align=center><a name="IDXPREFIX" href="../rcvars.html#IDXPREFIX"><strong><code>$IDXPREFIX$</code></strong></a></td>
162<td>Prefix of filenames of main index pages.</td>
163</tr>
164<tr valign=top>
165<td align=center><a name="IDXSIZE" href="../rcvars.html#IDXSIZE"><strong><code>$IDXSIZE$</code></strong></a></td>
166<td>Max number of messages that may be listed in index page.</td>
167</tr>
168<tr valign=top>
169<td align=center><a name="IDXTITLE" href="../rcvars.html#IDXTITLE"><strong><code>$IDXTITLE$</code></strong></a></td>
170<td>The title of the main index page.</td>
171</tr>
172<tr valign=top>
173<td align=center><a name="LINK" href="../rcvars.html#LINK"><strong><code>$LINK$</code></strong></a></td>
174<td>Link markup linking to a message.</td>
175</tr>
176<tr valign=top>
177<td align=center><a name="LOCALDATE" href="../rcvars.html#LOCALDATE"><strong><code>$LOCALDATE$</code></strong></a></td>
178<td>Current local date.</td>
179</tr>
180<tr valign=top>
181<td align=center><a name="MMDDYYYY" href="../rcvars.html#MMDDYYYY"><strong><code>$MMDDYYYY$</code></strong></a></td>
182<td>Message date in mm/dd/yyyy format.</td>
183</tr>
184<tr valign=top>
185<td align=center><a name="MSG" href="../rcvars.html#MSG"><strong><code>$MSG$</code></strong></a></td>
186<td>Filename of message.</td>
187</tr>
188<tr valign=top>
189<td align=center><a name="MSGGMTDATE" href="../rcvars.html#MSGGMTDATE"><strong><code>$MSGGMTDATE$</code></strong></a></td>
190<td>GMT date of current message.</td>
191</tr>
192<tr valign=top>
193<td align=center><a name="MSGID" href="../rcvars.html#MSGID"><strong><code>$MSGID$</code></strong></a></td>
194<td>The message-id of the message.</td>
195</tr>
196<tr valign=top>
197<td align=center><a name="MSGLOCALDATE" href="../rcvars.html#MSGLOCALDATE"><strong><code>$MSGLOCALDATE$</code></strong></a></td>
198<td>Local date of current message.</td>
199</tr>
200<tr valign=top>
201<td align=center><a name="MSGNUM" href="../rcvars.html#MSGNUM"><strong><code>$MSGNUM$</code></strong></a></td>
202<td>The message number assigned to the message by MHonArc (includes leading zeros).</td>
203</tr>
204<tr valign=top>
205<td align=center><a name="MSGPREFIX" href="../rcvars.html#MSGPREFIX"><strong><code>$MSGPREFIX$</code></strong></a></td>
206<td>Filename prefix for message files.</td>
207</tr>
208<tr valign=top>
209<td align=center><a name="MSGTORDNUM" href="../rcvars.html#MSGTORDNUM"><strong><code>$MSGTORDNUM$</code></strong></a></td>
210<td>The ordinal message number of the current discussion thread.</td>
211</tr>
212<tr valign=top>
213<td align=center><a name="NOTE" href="../rcvars.html#NOTE"><strong><code>$NOTE$</code></strong></a></td>
214<td>Message annotation.</td>
215</tr>
216<tr valign=top>
217<td align=center><a name="NUMFOLUP" href="../rcvars.html#NUMFOLUP"><strong><code>$NUMFOLUP$</code></strong></a></td>
218<td>Number of explicit follow-ups to the message.</td>
219</tr>
220<tr valign=top>
221<td align=center><a name="NUMOFMSG" href="../rcvars.html#NUMOFMSG"><strong><code>$NUMOFMSG$</code></strong></a></td>
222<td>Number of messages in the archive.</td>
223</tr>
224<tr valign=top>
225<td align=center><a name="NUMOFPAGES" href="../rcvars.html#NUMOFPAGES"><strong><code>$NUMOFPAGES$</code></strong></a></td>
226<td>Number of index pages.</td>
227</tr>
228<tr valign=top>
229<td align=center><a name="ORDNUM" href="../rcvars.html#ORDNUM"><strong><code>$ORDNUM$</code></strong></a></td>
230<td>The current listing number of the message.</td>
231</tr>
232<tr valign=top>
233<td align=center><a name="OUTDIR" href="../rcvars.html#OUTDIR"><strong><code>$OUTDIR$</code></strong></a></td>
234<td>Pathname of archive.</td>
235</tr>
236<tr valign=top>
237<td align=center><a name="PROG" href="../rcvars.html#PROG"><strong><code>$PROG$</code></strong></a></td>
238<td>Program name</td>
239</tr>
240<tr valign=top>
241<td align=center><a name="SUBJECT" href="../rcvars.html#SUBJECT"><strong><code>$SUBJECT$</code></strong></a></td>
242<td>The subject text of the message, and if no arguments, wrapped in an anchor element that hyperlinks to the message.</td>
243</tr>
244<tr valign=top>
245<td align=center><a name="SUBJECTNA" href="../rcvars.html#SUBJECTNA"><strong><code>$SUBJECTNA$</code></strong></a></td>
246<td>The subject text of the message without the anchor element.</td>
247</tr>
248<tr valign=top>
249<td align=center><a name="TIDXFNAME" href="../rcvars.html#TIDXFNAME"><strong><code>$TIDXFNAME$</code></strong></a></td>
250<td>Filename of thread index page.</td>
251</tr>
252<tr valign=top>
253<td align=center><a name="TIDXLABEL" href="../rcvars.html#TIDXLABEL"><strong><code>$TIDXLABEL$</code></strong></a></td>
254<td>Label for thread index page.</td>
255</tr>
256<tr valign=top>
257<td align=center><a name="TIDXPREFIX" href="../rcvars.html#TIDXPREFIX"><strong><code>$TIDXPREFIX$</code></strong></a></td>
258<td>Prefix of filenames of thread index pages.</td>
259</tr>
260<tr valign=top>
261<td align=center><a name="TIDXTITLE" href="../rcvars.html#TIDXTITLE"><strong><code>$TIDXTITLE$</code></strong></a></td>
262<td>Title of thread index.</td>
263</tr>
264<tr valign=top>
265<td align=center><a name="TLEVEL" href="../rcvars.html#TLEVEL"><strong><code>$TLEVEL$</code></strong></a></td>
266<td>Numeric level of message in thread, starting with 0.</td>
267</tr>
268<tr valign=top>
269<td align=center><a name="TSLICE" href="../rcvars.html#TSLICE"><strong><code>$TSLICE$</code></strong></a></td>
270<td>A <em>slice</em> of the thread listing relative to the current message. Size of slice determined by the TSLICE resource.</td>
271</tr>
272<tr valign=top>
273<td align=center><a name="VERSION" href="../rcvars.html#VERSION"><strong><code>$VERSION$</code></strong></a></td>
274<td>Program version.</td>
275</tr>
276<tr valign=top>
277<td align=center><a name="YYYYMMDD" href="../rcvars.html#YYYYMMDD"><strong><code>$YYYYMMDD$</code></strong></a></td>
278<td>Message date in yyyy/mm/dd format.</td>
279</tr>
280</table>
281
282<!-- *************************************************************** -->
283<hr>
284<h2>Examples</h2>
285
286<p>None.
287</p>
288
289<!-- *************************************************************** -->
290<hr>
291<h2>Version</h2>
292
293<p>2.3.0
294</p>
295
296<!-- *************************************************************** -->
297<hr>
298<h2>See Also</h2>
299
300<p>
301<a href="annotate.html">ANNOTATE</a>,
302<a href="note.html">NOTE</a>
303</p>
304
305<!-- *************************************************************** -->
306<hr>
307<!--x-rc-nav-->
308<table border=0><tr valign="top">
309<td align="left" width="50%">[Prev:&nbsp;<a href="note.html">NOTE</a>]</td><td><nobr>[<a href="../resources.html#notedir">Resources</a>][<a href="../mhonarc.html">TOC</a>]</nobr></td><td align="right" width="50%">[Next:&nbsp;<a href="noteia.html">NOTEIA</a>]</td></tr></table>
310<!--/x-rc-nav-->
311<hr>
312<address>
313$Date: 2002/07/27 05:13:11 $ <br>
314<img align="top" src="../monicon.png" alt="">
315<a href="http://www.mhonarc.org/"
316><strong>MHonArc</strong></a><br>
317Copyright &#169; 1998-1999, <a href="http://www.earlhood.com/"
318>Earl Hood</a>, <a href="mailto:mhonarc@mhonarc.org"
319>mhonarc@mhonarc.org</a><br>
320</address>
321
322</body>
323</html>
Full OpenSPARC design & verification tarball including full HDL.