Update of /cvsroot/mhonarc/mharc/doc
In directory subversions:/tmp/cvs-serv30284/doc
Modified Files:
index.html install.html
Log Message:
Doc cleanup.
Index: index.html
===================================================================
RCS file: /cvsroot/mhonarc/mharc/doc/index.html,v
retrieving revision 1.6
retrieving revision 1.7
diff -C2 -r1.6 -r1.7
*** index.html 29 Sep 2002 03:41:18 -0000 1.6
--- index.html 1 Oct 2002 23:47:05 -0000 1.7
***************
*** 43,57 ****
</p>
! <p>A problem with setting up mail archives is trying to configure
! the various tools to work together. For example, MHonArc provides
! no built-in searching, so you have to configure a third-party search
! engine and customize MHonArc's page layout to add a search
! form to archive pages. Various administrators have created
! their own set of scripts to perform this integration. </p>
- <p>Well, <b>mharc</b> eliminates this problem by providing
- a set of scripts integrating popular free software tools
- to provide you with robust mail archives. mharc provides
- the following features: </p>
<ul>
<li>Automatic processing of incoming mail
--- 43,52 ----
</p>
! <p>A hurdle in setting up robust mail archives is configuring the
! various tools (pre-processor, mail converter, search engine, et.al.) to
! work in tandem, which generally requires programming and system
! administration skills. <b>mharc</b> eliminates this time consuming
! and often frustrating task by providing the following features: </p>
<ul>
<li>Automatic processing of incoming mail
***************
*** 65,69 ****
(via <a href="http://www.namazu.org/";>Namazu</a>).
</li>
! <li>Raw mail archives.
</li>
<li>Page layout customization
--- 60,64 ----
(via <a href="http://www.namazu.org/";>Namazu</a>).
</li>
! <li>Raw mail archives to complement, and backup, the HTML-based archives.
</li>
<li>Page layout customization
Index: install.html
===================================================================
RCS file: /cvsroot/mhonarc/mharc/doc/install.html,v
retrieving revision 1.6
retrieving revision 1.7
diff -C2 -r1.6 -r1.7
*** install.html 29 Sep 2002 04:22:14 -0000 1.6
--- install.html 1 Oct 2002 23:47:05 -0000 1.7
***************
*** 4,7 ****
--- 4,13 ----
<link rel="stylesheet" type="text/css" href="docstyles.css">
<link rel="shortcut icon" type="image/x-icon" href="images/mharc-icon.ico">
+ <style type="text/css">
+ body {
+ background: #DDDDDD;
+ color: #000000;
+ }
+ </style>
</head>
<body>
***************
*** 115,130 ****
<h2><img src="images/mharc-icon.png" align="top" alt=""> <a name="intro">Introduction</a></h2>
- <p>mharc is designed to be independent of the mailing list management
- software. If changes are made to list management software, mharc
- is unaffected. The design also allows a division of labor on who manages
- the lists and who manages the archives. </p>
-
<p>The typical usage model for mharc is to have a special archive
account to perform all mharc-related duties. The account is
subscribed to all mailing lists you want archived. For example,
! say the account you use is "<tt>mailarch</tt>" and the
! mail address for the account is "<tt>mailarch(_at_)example(_dot_)com</tt>".
For each list you archive, the address
! "<tt>mailarch(_at_)example(_dot_)com</tt>" must be subscribed to each list. </p>
<table class="note">
--- 121,137 ----
<h2><img src="images/mharc-icon.png" align="top" alt=""> <a name="intro">Introduction</a></h2>
<p>The typical usage model for mharc is to have a special archive
account to perform all mharc-related duties. The account is
subscribed to all mailing lists you want archived. For example,
! say the account you use is <tt class="icode">mailarch</tt> and the
! mail address for the account is <tt class="icode">mailarch(_at_)example(_dot_)com</tt>.
For each list you archive, the address
! <tt class="icode">mailarch(_at_)example(_dot_)com</tt> must be subscribed to each list.
! </p>
!
! <p>This usage model allows mharc to be independent of the mailing
! list management software. If changes are made to list management
! software, mharc is unaffected. The model also allows a division of
! labor on who manages the lists and who manages the archives. </p>
<table class="note">
***************
*** 306,313 ****
Root URL for archives
(You can set this later in lib/config.sh): <b><i>/archives</i></b>
! Would you like to edit "lib/config.sh" with "<i>vim</i>"? ['y']
<i>... [edit session not shown] ...</i>
! Would you like to edit "lib/lists.def" with "<i>vim</i>"? ['y']
<i>... [edit session not shown] ...</i>
--- 313,320 ----
Root URL for archives
(You can set this later in lib/config.sh): <b><i>/archives</i></b>
! Would you like to edit "lib/config.sh" with "<i>vi</i>"? ['y']
<i>... [edit session not shown] ...</i>
! Would you like to edit "lib/lists.def" with "<i>vi</i>"? ['y']
<i>... [edit session not shown] ...</i>
***************
*** 341,344 ****
--- 348,352 ----
</td></tr></table>
<p></p>
+
<table class="note" width="100%">
<tr valign="baseline">
***************
*** 349,352 ****
--- 357,374 ----
</p>
</td></tr></table>
+ <p></p>
+
+ <table class="tip" width="100%">
+ <tr valign="baseline">
+ <td><strong>TIP:</strong></td>
+ <td width="100%"><p>If you get stuck in <tt>vi</tt>, you can
+ type the following key strokes to abandon any changes and exit:
+ <tt class="ishell"><Esc><b>:q!</b><Enter></tt>, where
+ <tt class="ishell"><Esc></tt> represents the Esc key and
+ <tt class="ishell"><Enter></tt> represents the Enter key.
+ Type the following if you want to save any changes before exiting:
+ <tt class="ishell"><Esc><b>:wq</b><Enter></tt>, where
+ </p>
+ </td></tr></table>
<!-- ====================================================================== -->
***************
*** 370,373 ****
--- 392,396 ----
edits as needed. Run the following command
to have your changes applied: </p>
+
<table border=1 width="100%"><tr><td><pre class="shell">
prompt> <b>make configure</b>
***************
*** 387,392 ****
</pre></td></tr></table>
! <p>In general, when you make changes to <a
! href="file/config.sh.txt"><tt>lib/config.sh</tt></a>, make sure to
run <tt class="ishell"><b>make configure</b></tt>. </p>
--- 410,426 ----
</pre></td></tr></table>
! <p></p>
! <table class="note" width="100%">
! <tr valign="baseline">
! <td><strong>NOTE:</strong></td>
! <td width="100%"><p>If you edited
! <a href="file/config.sh.txt"><tt>lib/config.sh</tt></a> while
! running <a href="#install"><tt>install.pl</tt></a>, then any changes
! you made then would have already been applied.
! </p>
! </td></tr></table>
!
! <p>In general, when you make changes to
! <a href="file/config.sh.txt"><tt>lib/config.sh</tt></a>, make sure to
run <tt class="ishell"><b>make configure</b></tt>. </p>
---------------------------------------------------------------------
To sign-off this list, send email to majordomo(_at_)mhonarc(_dot_)org with the
message text UNSUBSCRIBE MHONARC-DEV