Initial commit of OpenSPARC T2 design and verification files.
[OpenSPARC-T2-DV] / tools / perl-5.8.0 / doc / MHonArc / resources / expiredate.html
CommitLineData
86530b38
AT
1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML//EN">
2<html>
3<head>
4<title>MHonArc Resources: EXPIREDATE</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="expireage.html">EXPIREAGE</a>]</td><td><nobr>[<a href="../resources.html#expiredate">Resources</a>][<a href="../mhonarc.html">TOC</a>]</nobr></td><td align="right" width="50%">[Next:&nbsp;<a href="fieldorder.html">FIELDORDER</a>]</td></tr></table>
10<!--/x-rc-nav-->
11<hr>
12<h1>EXPIREDATE</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_EXPIREDATE=</code><var>date</var>
23</p>
24</dd>
25
26<dt><strong>Element</strong></dt>
27<dd><p>
28<code>&lt;EXPIREDATE&gt;<br></code>
29<var>date</var><br>
30<code>&lt;/EXPIREDATE&gt;<br></code>
31</p>
32</dd>
33
34<dt><strong>Command-line Option</strong></dt>
35<dd><p>
36<code>-expiredate </code><var>date</var>
37</p>
38</dd>
39
40</dl>
41
42<!-- *************************************************************** -->
43<hr>
44<h2>Description</h2>
45
46<p>If defined, EXPIREDATE sets the expiration date for messages
47in an archive. During an archive update, any messages with
48dates less than the EXPIREDATE are automatically removed. If
49a message to be added is older than EXPIREDATE, it is not added.
50</p>
51
52<p>The syntax for EXPIREDATE is as follows:
53</p>
54
55<blockquote>
56<p><var>DD</var><tt> </tt><var>Mon</var><tt> </tt><var>YY</var><tt> </tt><var>HH</var><tt>:</tt><var>MM</var><tt>:</tt><var>SS</var><tt> </tt><var>Zone</var>
57</p>
58</blockquote>
59
60<p>24 hour time must be used.
61The timezone is optional. If non-existent, the local zone is used.
62If a symbolic timezone is used (eg: "EST"), make sure it is defined
63in the
64<a href="timezones.html">TIMEZONES</a> resource.
65</p>
66
67<!-- *************************************************************** -->
68<hr>
69<h2>Default Setting</h2>
70
71<p>Nil.
72</p>
73
74<!-- *************************************************************** -->
75<hr>
76<h2>Resource Variables</h2>
77
78<p>N/A
79</p>
80
81<!-- *************************************************************** -->
82<hr>
83<h2>Examples</h2>
84
85<p>EXPIREDATE is useful if you want to insure messages older
86than a specified date do not get archived. For example, if
87you want to make sure that no message before 1997 is added, then
88define EXPIREDATE as follows:
89</p>
90
91<pre>
92<b>&lt;ExpireDate&gt;</b>
931 Jan 1997 00:00:00
94<b>&lt;/ExpireDate&gt;</b>
95</pre>
96
97<p>However, this specifies local time. It is possible that some
98message can get excluded that have a 1997 date (depending on
99what timezone you are in). The following
100is more accurate:
101</p>
102
103<pre>
104<b>&lt;ExpireDate&gt;</b>
1051 Jan 1997 00:00:00 +0000
106<b>&lt;/ExpireDate&gt;</b>
107</pre>
108
109<p>Or,</p>
110
111<pre>
112<b>&lt;ExpireDate&gt;</b>
1131 Jan 1997 00:00:00 GMT
114<b>&lt;/ExpireDate&gt;</b>
115</pre>
116
117<!-- *************************************************************** -->
118<hr>
119<h2>Version</h2>
120
121<p>2.0
122</p>
123
124<!-- *************************************************************** -->
125<hr>
126<h2>See Also</h2>
127
128<p>
129<a href="expireage.html">EXPIREAGE</a>,
130<a href="timezones.html">TIMEZONES</a>
131</p>
132
133<!-- *************************************************************** -->
134<hr>
135<!--x-rc-nav-->
136<table border=0><tr valign="top">
137<td align="left" width="50%">[Prev:&nbsp;<a href="expireage.html">EXPIREAGE</a>]</td><td><nobr>[<a href="../resources.html#expiredate">Resources</a>][<a href="../mhonarc.html">TOC</a>]</nobr></td><td align="right" width="50%">[Next:&nbsp;<a href="fieldorder.html">FIELDORDER</a>]</td></tr></table>
138<!--/x-rc-nav-->
139<hr>
140<address>
141$Date: 2002/07/27 05:13:10 $ <br>
142<img align="top" src="../monicon.png" alt="">
143<a href="http://www.mhonarc.org/"
144><strong>MHonArc</strong></a><br>
145Copyright &#169; 1997-1998, <a href="http://www.earlhood.com/"
146>Earl Hood</a>, <a href="mailto:mhonarc@mhonarc.org"
147>mhonarc@mhonarc.org</a><br>
148</address>
149
150</body>
151</html>