Commit | Line | Data |
---|---|---|
86530b38 AT |
1 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML//EN"> |
2 | <HTML> | |
3 | <HEAD> | |
4 | <TITLE>MHonArc v2.5 -- Common Tasks</TITLE> | |
5 | </HEAD> | |
6 | <!-- | |
7 | <BODY background="ssbg75.jpg" | |
8 | text="#000000" link="#0000ee" vlink="#551a8b" alink="ff0000"> | |
9 | --> | |
10 | <BODY> | |
11 | ||
12 | <!--X-NavButtons-Start--> | |
13 | <table width="100%"> | |
14 | <tr valign="top"> | |
15 | <td align="left"><nobr><a href="quickstart.html"><img src="prev.png"border=0 alt="[Prev]"></a> </nobr></td><td align="center" width="99%"><a href="mhonarc.html"><img src="up.png" border=0 alt="[TOC]"></a><a href="faq/faq.html"><img src="faq.png" border=0 alt="[FAQ]"></a><a href="app-bugs.html"><img src="bug.png" border=0 alt="[Bugs]"></a><a href="http://www.mhonarc.org/"><img src="home.png" border=0 alt="[Home]"></a></td><td align="right"><nobr> <a href="layout.html"><img src="next.png" border=0 alt="[Next]"></a></nobr></td></tr></table> | |
16 | <!--X-NavButtons-End--> | |
17 | ||
18 | <!-- *************************************************************** --> | |
19 | <HR> | |
20 | <H1><a name="commontasks">Common Tasks</a></H1> | |
21 | ||
22 | <p>The following section describes how to perform some common tasks with | |
23 | MHonArc archives beyond those mentioned in | |
24 | <a href="quickstart.html">Quick Start</a>. To get a complete picture | |
25 | of what you can do with MHonArc, see the section | |
26 | on <a href="resources.html">Resources</a>. | |
27 | </p> | |
28 | ||
29 | <!--X-TOC-Start--> | |
30 | <ul> | |
31 | <li><a href="#chgtitle">Setting the Index Title</a> | |
32 | <li><a href="#chg-idx-order">Changing Index Listing Order</a> | |
33 | <li><a href="#rmm">Removing Messages</a> | |
34 | <ul> | |
35 | <li><small><a href="#autormm">Automatic Removal</a></small> | |
36 | <li><small><a href="#manualrmm">Manual Removal</a></small> | |
37 | </ul> | |
38 | <li><a href="#layout">Customizing Page Layout</a> | |
39 | </ul> | |
40 | <!--X-TOC-End--> | |
41 | ||
42 | <!-- *************************************************************** --> | |
43 | <hr> | |
44 | <h2><a name="chgtitle">Setting the Index Title</a></h2> | |
45 | ||
46 | <p>If you read the <a href="quickstart.html">Quick Start</a> | |
47 | section and ran MHonArc on some of your mail, | |
48 | you have may have noticed that the titles of the main (date) | |
49 | and thread index pages are not very descriptive: "Mail Index" | |
50 | and "Mail Thread Index". It would be much nicer if the the | |
51 | titles reflect what type of mail is in the archive. For example, | |
52 | if the archive contains messages from a mailing list, the name | |
53 | of the list should probably be in the title. | |
54 | </p> | |
55 | <p>MHonArc allows you to change the titles via the | |
56 | <a href="resources/title.html"><tt>-title</tt></a> and | |
57 | <a href="resources/ttitle.html"><tt>-ttitle</tt></a> options. | |
58 | The <a href="resources/title.html"><tt>-title</tt></a> option sets | |
59 | main index title, and the | |
60 | <a href="resources/ttitle.html"><tt>-ttitle</tt></a> option sets | |
61 | the thread index title. Example: | |
62 | </p> | |
63 | <pre> | |
64 | shell> <b>mhonarc <a href="resources/title.html">-title</a> "The Widget List Archive" \ | |
65 | <a href="resources/ttitle.html">-ttitle</a> "The Widget List Thread Archive"</b> ... | |
66 | </pre> | |
67 | ||
68 | <!-- *************************************************************** --> | |
69 | <hr> | |
70 | <h2><a name="chg-idx-order">Changing Index Listing Order</a></h2> | |
71 | ||
72 | <p>By default, messages get listed in chronological order on | |
73 | the main/non-thread and thread index pages. | |
74 | </p> | |
75 | <table border=0 cellpadding=4> | |
76 | <tr valign=top> | |
77 | <td><strong>NOTE</strong></td> | |
78 | <td><p>The chronological order in the thread index is based on | |
79 | the root messages of each thread. | |
80 | </p> | |
81 | </td> | |
82 | </tr> | |
83 | </table> | |
84 | <p>For many, the default listing order is | |
85 | not what is desired. A common desire is to have | |
86 | messages in the main index listed in reverse chronological order; | |
87 | ie. the most recent messages are listed first while the oldest | |
88 | are listed last. Or, one may want to list messages by author | |
89 | since the target audience is more interested in looking up messages | |
90 | by certain authors than by date. | |
91 | </p> | |
92 | <p>Following is the list options available for changing the | |
93 | listing order on index pages: | |
94 | </p> | |
95 | ||
96 | <table border=0> | |
97 | <tr> | |
98 | <td align="right"><b>Option</b> </td><td><b>Description</b></td> | |
99 | </tr> | |
100 | <tr valign="top"><td align="right"><b><a name="authsort" href="resources/authsort.html"><tt>-authsort</tt></a></b> </td><td>Sort main index by author.</td></tr> | |
101 | <tr valign="top"><td align="right"><b><a name="reverse" href="resources/reverse.html"><tt>-reverse</tt></a></b> </td><td>Reverse the listing order in the main index.</td></tr> | |
102 | <tr valign="top"><td align="right"><b><a name="sort" href="resources/sort.html"><tt>-sort</tt></a></b> </td><td>List messages by date in main index.</td></tr> | |
103 | <tr valign="top"><td align="right"><b><a name="subsort" href="resources/subsort.html"><tt>-subsort</tt></a></b> </td><td>List messages by subject in main index.</td></tr> | |
104 | <tr valign="top"><td align="right"><b><a name="treverse" href="resources/treverse.html"><tt>-treverse</tt></a></b> </td><td>List thread in reverse order.</td></tr> | |
105 | <tr valign="top"><td align="right"><b><a name="tsort" href="resources/tsort.html"><tt>-tsort</tt></a></b> </td><td>List threads by date.</td></tr> | |
106 | <tr valign="top"><td align="right"><b><a name="tsubsort" href="resources/tsubsort.html"><tt>-tsubsort</tt></a></b> </td><td>List threads by subject.</td></tr> | |
107 | </table> | |
108 | ||
109 | <p>For example, to get a reverse chronological listing, | |
110 | do something like the following: | |
111 | </p> | |
112 | <pre> | |
113 | shell> <b>mhonarc <a href="resources/sort.html">-sort</a> <a href="resources/reverse.html">-reverse</a></b> ... | |
114 | </pre> | |
115 | ||
116 | <!-- *************************************************************** --> | |
117 | <hr> | |
118 | <h2><a name="rmm">Removing Messages</a></h2> | |
119 | ||
120 | <p>There are two ways to delete messages from an archive: | |
121 | automatic and manual. | |
122 | </p> | |
123 | ||
124 | <h3><a name="autormm">Automatic Removal</a></h3> | |
125 | ||
126 | <p>MHonArc supports the ability to automatically remove archive messages | |
127 | that are older than a specified time period, are older than | |
128 | a specified date/time, or the number of messages have reached the maximum | |
129 | number specified. | |
130 | </p> | |
131 | ||
132 | </p>For example, if you want an archive to only | |
133 | contain messages that are less than a month, you can do something | |
134 | like the following: | |
135 | </p> | |
136 | <pre> | |
137 | shell> <b>mhonarc <a href="resources/expireage.html">-expireage</a> 2635200 <a href="resources/add.html">-add</a> <a href="resources/outdir.html">-outdir</a> /path/to/archive mailbox</b> | |
138 | </pre> | |
139 | <p>Here, we used the <a href="resources/expireage.html"><tt>-expireage</tt></a> | |
140 | option | |
141 | to tell MHonArc to remove messages older than 2635200 seconds (30.5 days) when | |
142 | adding new messages. | |
143 | I know, having to use seconds to specify the expiration age seems cumbersome. | |
144 | A table is provided in the <a href="resources/expireage.html">EXPIREAGE</a> | |
145 | reference page listing common time periods to their equivalence in seconds. | |
146 | </p> | |
147 | ||
148 | <p>A less used option that will cause automatic deletion is the | |
149 | <a href="resources/expiredate.html"><tt>-expiredate</tt></a> option. | |
150 | This allows | |
151 | you to specify an exact date/time where any messages older than the | |
152 | given date/time, will be automatically removed. For example: | |
153 | </p> | |
154 | <pre> | |
155 | shell> <b>mhonarc <a href="resources/expiredate.html">-expiredate</a> "1 Jan 1999 00:00:00" <a href="resources/add.html">-add</a> <a href="resources/outdir.html">-outdir</a> /path/to/archive mailbox</b> | |
156 | </pre> | |
157 | <p>In this example, before MHonArc adds any new messages, it will delete | |
158 | any messages with a date earlier than January 1, 1999. See the | |
159 | <a href="resources/expiredate.html">EXPIREDATE</a> reference page for | |
160 | more information and for the correct expiration date syntax. | |
161 | </p> | |
162 | ||
163 | <p>An archive can also have a maximum number of messages limit. | |
164 | When the maximum number is reached, the oldest messages are automatically | |
165 | removed. The following is an example of setting the maximum size | |
166 | of an archive: | |
167 | </p> | |
168 | <pre> | |
169 | shell> <b>mhonarc <a href="resources/maxsize.html">-maxsize</a> 500 <a href="resources/add.html">-add</a> <a href="resources/outdir.html">-outdir</a> /path/to/archive mailbox</b> | |
170 | </pre> | |
171 | ||
172 | <h3><a name="manualrmm">Manual Removal</a></h3> | |
173 | ||
174 | <p>Sometimes it becomes necessary to remove specific messages from archive. | |
175 | For example, their may be some spam messages and you do not want them | |
176 | cluttering your archive (and providing free advertising). Or, there | |
177 | may be archived messages that you believe are not appropriate for | |
178 | the archive's intended audience. | |
179 | </p> | |
180 | <p>To remove specific messages, use the | |
181 | <a href="resources/rmm.html"><tt>-rmm</tt></a> option. For example: | |
182 | </p> | |
183 | <pre> | |
184 | shell> <b>mhonarc <a href="resources/rmm.html">-rmm</a> 24 28 39 48</b> | |
185 | </pre> | |
186 | <p>will delete messages 24, 28, 39, and 48. | |
187 | </p> | |
188 | <p>You are now asking, "How do I know what a message's number is?". One | |
189 | way is to look at the number in the message's filename. I.e. Each | |
190 | converted message is writting to a filename containing the number of | |
191 | message. For example, <tt>msg00024.html</tt>, | |
192 | <tt>msg00028.html</tt>, <tt>msg00039.html</tt>, and <tt>msg00048.html</tt> | |
193 | denote messages 24, 28, 39, and 48. | |
194 | </p> | |
195 | <p>Checking filenames can be awkward, so one alternative is to use | |
196 | the <a href="resources/scan.html"><tt>-scan</tt></a> option. For example: | |
197 | </p> | |
198 | <pre> | |
199 | shell> <b>mhonarc <a href="resources/scan.html">-scan</a> <a href="resources/outdir.html">-outdir</a> /home/ehood/html/archive</b> | |
200 | Reading database ... | |
201 | 117 messages in /home/ehood/html/archive: | |
202 | ||
203 | Msg # YYYY/MM/DD From Subject | |
204 | ----- ---------- --------------- ------------------------------------------- | |
205 | 62 1996/07/30 Kwin Kramer Reading STDIN not from keyboard -- or, Syst | |
206 | 23 1996/07/31 Christopher M. Re: Setting @INC to include my own modules | |
207 | 9 1996/08/01 Dan Kirkwood object as hash key loses methods | |
208 | 2 1996/08/01 James F'jord Ly Re: We're HIRING hot hackers! | |
209 | 1 1996/08/01 Christopher Cha Curious Multi-Dimensional array behavior | |
210 | 14 1996/08/01 I R A Aggie Re: Patch for arithmetic bug in 5.003 ? | |
211 | 3 1996/08/01 Bernard Bellon Re: How do you grab a URL in perl? | |
212 | 38 1996/08/01 Mohammed Dewan Help needed badly win3.1 and perl. | |
213 | 59 1996/08/01 Mohammed Dewan Using file in perl. | |
214 | 4 1996/08/01 Dan Gildor Re: Threaded Discusion groups embeded in We | |
215 | 5 1996/08/01 kendall shaw addicted to emacs lisp | |
216 | 6 1996/08/01 Ye He Q: Sybase extension to Perl | |
217 | 83 1996/08/01 I R A Aggie Re: Browser/Page matching CGI script | |
218 | 7 1996/08/01 Chris Schleiche Re: Simple program looks good, but gives er | |
219 | 13 1996/08/01 Steve McCullagh Perl 5.002 and $| errors | |
220 | ... | |
221 | </pre> | |
222 | ||
223 | <p>With <a href="resources/scan.html">-scan</a>, you can get a listing | |
224 | of an archive to your terminal. The listing can be used to determine | |
225 | the message number for a message if you know the message's subject and | |
226 | author. | |
227 | </p> | |
228 | ||
229 | <p>The <a href="resources/rmm.html"><tt>-rmm</tt></a> also supports | |
230 | the ability to specify message number ranges and message-ids. See | |
231 | the <a href="resources/rmm.html">RMM</a> reference page for | |
232 | more information and examples. | |
233 | </p> | |
234 | ||
235 | ||
236 | <!-- *************************************************************** --> | |
237 | <hr> | |
238 | <h2><a name="layout">Customizing Page Layout</a></h2> | |
239 | ||
240 | <p>One of the most powerful features of MHonArc is the ability to | |
241 | customize the layout of pages generated by MHonArc. Here, we give | |
242 | a quick introduction on how customization can be done. For more | |
243 | information, see the <cite><a href="layout.html">Page Layout</a></cite> | |
244 | section. | |
245 | </p> | |
246 | ||
247 | <p>In this introduction, the task we will be performing is to | |
248 | add a footer at the bottom of each page in the archive to | |
249 | contain the following markup: | |
250 | </p> | |
251 | <pre> | |
252 | <hr> | |
253 | Please visit <a href="http://www.mhonarc.org">www.mhonarc.org</a>. | |
254 | </pre> | |
255 | ||
256 | <p>To modify page layout, we will need to create a | |
257 | <a href="resources/rcfile.html">resource file</a> and give it a | |
258 | filename "<tt>myresource.mrc</tt>". The name we give the file is | |
259 | completely arbitrary. There is nothing special about the name | |
260 | "<tt>myresource.mrc</tt>". | |
261 | </p> | |
262 | ||
263 | <p>Within <tt>myresource.mrc</tt>, | |
264 | we add the following to tell MHonArc to include our footer at the | |
265 | bottom of each page: | |
266 | </p> | |
267 | <blockquote><pre> | |
268 | <!-- Define a custom resource variable representing our link. --> | |
269 | <b><a href="resources/definevar.html"><DefineVar></a></b> | |
270 | MY-FOOTER-LINK | |
271 | <hr> | |
272 | Please visit <a href="http://www.mhonarc.org">www.mhonarc.org</a>. | |
273 | <b></DefineVar></b> | |
274 | ||
275 | <!-- Modify appropriate resources to print our link at the bottom | |
276 | of MHonArc generated pages. Notice how the custom resource | |
277 | variable defined above can be used to include our link. --> | |
278 | ||
279 | <!-- Main index pages --> | |
280 | <b><a href="resources/idxpgend.html"><IdxPgEnd></a></b> | |
281 | $MY-FOOTER-LINK$ | |
282 | </body> | |
283 | </html> | |
284 | <b></IdxPgEnd></b> | |
285 | ||
286 | <!-- Thread index pages --> | |
287 | <b><a href="resources/tidxpgend.html"><TIdxPgEnd></a></b> | |
288 | $MY-FOOTER-LINK$ | |
289 | </body> | |
290 | </html> | |
291 | <b></TIdxPgEnd></b> | |
292 | ||
293 | <!-- Message pages --> | |
294 | <b><a href="resources/msgpgend.html"><MsgPgEnd></a></b> | |
295 | $MY-FOOTER-LINK$ | |
296 | </body> | |
297 | </html> | |
298 | <b></MsgPgEnd></b> | |
299 | </pre></blockquote> | |
300 | ||
301 | <p>Now, when we invoke <tt>mhonarc</tt>, we tell it about our resource | |
302 | file so our footer will show up: | |
303 | </p> | |
304 | <pre> | |
305 | shell> <b>mhonarc <a href="resources/rcfile.html">-rcfile</a> myresource.mrc</b> ... | |
306 | </pre> | |
307 | ||
308 | <!-- *************************************************************** --> | |
309 | <HR> | |
310 | <!--X-NavButtons-Start--> | |
311 | <table width="100%"> | |
312 | <tr valign="top"> | |
313 | <td align="left"><nobr><a href="quickstart.html"><img src="prev.png"border=0 alt="[Prev]"></a> </nobr></td><td align="center" width="99%"><a href="mhonarc.html"><img src="up.png" border=0 alt="[TOC]"></a><a href="faq/faq.html"><img src="faq.png" border=0 alt="[FAQ]"></a><a href="app-bugs.html"><img src="bug.png" border=0 alt="[Bugs]"></a><a href="http://www.mhonarc.org/"><img src="home.png" border=0 alt="[Home]"></a></td><td align="right"><nobr> <a href="layout.html"><img src="next.png" border=0 alt="[Next]"></a></nobr></td></tr></table> | |
314 | <!--X-NavButtons-End--> | |
315 | ||
316 | <!-- *************************************************************** --> | |
317 | <hr> | |
318 | <address> | |
319 | $Date: 2002/06/07 17:38:04 $ <br> | |
320 | <img align="top" src="monicon.png" alt=""> | |
321 | <a href="http://www.mhonarc.org/"><strong>MHonArc</strong></a><br> | |
322 | Copyright © 1997-1999, <a href="http://www.mhonarc.org/~ehood/" | |
323 | >Earl Hood</a>, <a href="mailto:mhonarc@mhonarc.org" | |
324 | >mhonarc@mhonarc.org</a><br> | |
325 | </address> | |
326 | ||
327 | </BODY> | |
328 | </HTML> |