Update of /cvsroot/mhonarc/mharc/doc
In directory subversions:/tmp/cvs-serv22810
Modified Files:
docstyles.css index.html install.html tools.html
Log Message:
Documentation updates, mainly with install.html to reflect new installation
process.
Index: docstyles.css
===================================================================
RCS file: /cvsroot/mhonarc/mharc/doc/docstyles.css,v
retrieving revision 1.1
retrieving revision 1.2
diff -C2 -r1.1 -r1.2
*** docstyles.css 13 Sep 2002 07:22:18 -0000 1.1
--- docstyles.css 24 Sep 2002 06:39:46 -0000 1.2
***************
*** 20,29 ****
}
pre.shell {
! background: black;
color: white;
padding: 0.25em;
}
tt.ishell {
! background: black;
color: white;
padding-left: 0.25em;
--- 20,29 ----
}
pre.shell {
! background: #337733;
color: white;
padding: 0.25em;
}
tt.ishell {
! background: #337733;
color: white;
padding-left: 0.25em;
***************
*** 39,43 ****
margin-top: 0.25em;
margin-bottom: 0.25em;
! background: yellow;
border-color: black;
border-style: solid;
--- 39,43 ----
margin-top: 0.25em;
margin-bottom: 0.25em;
! background: #FFFF99;
border-color: black;
border-style: solid;
***************
*** 45,49 ****
}
table.tip {
! background: #DDEEFF;
border-color: black;
border-style: solid;
--- 45,49 ----
}
table.tip {
! background: #CCDDEE;
border-color: black;
border-style: solid;
Index: index.html
===================================================================
RCS file: /cvsroot/mhonarc/mharc/doc/index.html,v
retrieving revision 1.3
retrieving revision 1.4
diff -C2 -r1.3 -r1.4
*** index.html 15 Sep 2002 04:30:09 -0000 1.3
--- index.html 24 Sep 2002 06:39:46 -0000 1.4
***************
*** 41,46 ****
<a href="http://savannah.gnu.org/projects/mhonarc/";>MHonArc Project</a>.
mharc is a collection of Perl scripts for generating and
! managing web-based searchable mailing list archives.
</p>
<!-- ====================================================================== -->
--- 41,90 ----
<a href="http://savannah.gnu.org/projects/mhonarc/";>MHonArc Project</a>.
mharc is a collection of Perl scripts for generating and
! managing web-based searchable mail archives.
</p>
+ <p>A typical problem with setting up web-based mail archives
+ is trying dealing with the configuration of the various tools available
+ to get the type of archives desired. For example, MHonArc does not
+ provide any built-in searching, so you have to configure a search engine
+ and then customize MHonArc's page layout to include the search form
+ within archive pages.
+ </p>
+
+ <p>Generally, many administrators have created their own set of
+ scripts to integrate various tools together for their mail archives.
+ Well, mharc exists to eliminate this replication of work by providing
+ a set of scripts that integrate popular free software tools inorder
+ to provide a robust and usable set of mail archives. mharc provides
+ the following: </p>
+ <ul>
+ <li>Automatic processing of incoming mail
+ (via <a href="http://www.procmail.org/";>Procmail</a>).
+ </li>
+ <li>Support for defining multiple archives for multiple lists.
+ </li>
+ <li>Archives broken up by monthly or yearly time periods.
+ </li>
+ <li>Full-text searching
+ (via <a href="http://www.namazu.org/";>Namazu</a>).
+ </li>
+ <li>Raw mail archives to search as a backup for the HTML archives.
+ </li>
+ <li>Page layout customization
+ (via <a href="http://www.mhonarc.org/";>MHonArc</a>).
+ </li>
+ <li><a href="http://httpd.apache.org/";>Apache HTTP server</a> configuration
+ files to help configure and control access to archives via web
+ clients.
+ </li>
+ </ul>
+
+ <p>mharc configuration is driven by easily editable configuration
+ files. There is no need to become a master with Procmail recipes or
+ learn how to invoke and configure a search engine. Also, the default
+ page layout of the mail archives provides nicely formatted pages
+ that improve readability; easy, but powerful, archive navigation;
+ and a stylesheet to control the visual appearance of pages, eliminating the
+ need to define numerous MHonArc resources (but you still can if you
+ really want to). </p>
<!-- ====================================================================== -->
Index: install.html
===================================================================
RCS file: /cvsroot/mhonarc/mharc/doc/install.html,v
retrieving revision 1.3
retrieving revision 1.4
diff -C2 -r1.3 -r1.4
*** install.html 16 Sep 2002 19:57:29 -0000 1.3
--- install.html 24 Sep 2002 06:39:46 -0000 1.4
***************
*** 11,15 ****
<p>This document describes how to install and configure mharc on
your system. It is <strong>highly recommended</strong> to read
! through this document in its entirety before performing any of the
installation steps. </p>
--- 11,15 ----
<p>This document describes how to install and configure mharc on
your system. It is <strong>highly recommended</strong> to read
! this document in its entirety before performing any of the
installation steps. </p>
***************
*** 27,31 ****
</ul>
<li><a href="#extract">Extracting mharc</a>
! <li><a href="#configure">Configuring mharc</a>
<li><a href="#maintenance">Maintenance Operations</a>
<li><a href="#postinstall">Post Install Checks</a>
--- 27,34 ----
</ul>
<li><a href="#extract">Extracting mharc</a>
! <li><a href="#install">Running <tt>install.pl</tt></a>
! <li><a href="#configure">Checking Configuration</a>
! <li><a href="#lists_def">Editing <tt>lists.def</tt></a>
! <li><a href="#crontab">Defining your <tt>crontab</tt></a>
<li><a href="#maintenance">Maintenance Operations</a>
<li><a href="#postinstall">Post Install Checks</a>
***************
*** 63,72 ****
<p>Shell examples are rendered as follows:</p>
! <pre class="shell">
prompt> <b>ls -CF</b>
bin/ etc/ images/ log/ msgid.cache README
cgi-bin/ .htaccess@ info/ Makefile NEWS TODO
COPYING html/ lib/ mbox/ procmailrc.mharc VERSION
! </pre>
<p>The text <tt class="ishell">prompt></tt> represents your
--- 66,75 ----
<p>Shell examples are rendered as follows:</p>
! <table border=1 width="100%"><tr><td><pre class="shell">
prompt> <b>ls -CF</b>
bin/ etc/ images/ log/ msgid.cache README
cgi-bin/ .htaccess@ info/ Makefile NEWS TODO
COPYING html/ lib/ mbox/ procmailrc.mharc VERSION
! </pre></td></tr></table>
<p>The text <tt class="ishell">prompt></tt> represents your
***************
*** 167,173 ****
<a href="http://www.procmail.org/";><http://www.procmail.org/></a>:
<p>Procmail is used for the pre-filtering of incoming mail into
! the raw mail archives. Note, the program <tt>lockfile</tt> is
! also needed, which is part of the standard procmail distribution,
! but some Unix distributions may include it in a separate package.
</p>
</li>
--- 170,177 ----
<a href="http://www.procmail.org/";><http://www.procmail.org/></a>:
<p>Procmail is used for the pre-filtering of incoming mail into
! the raw mail archives. Note, the programs <tt>formail</tt> and
! <tt>lockfile</tt> is also needed, which is part of the standard
! procmail distribution, but some Unix distributions may include these
! programs a separate packages.
</p>
</li>
***************
*** 177,181 ****
<p>Namazu is used to provide searching. mharc also takes advantage
of Namazu's awareness of MHonArc message pages to provide
! some useful archive navigational aids.
</p>
</li>
--- 181,188 ----
<p>Namazu is used to provide searching. mharc also takes advantage
of Namazu's awareness of MHonArc message pages to provide
! some useful archive navigational aids. Note, the program
! <tt>namazu.cgi</tt> is needed, which is part of the standard
! Namazu distribution, but some Unix distribtions may include it
! in a separate package.
</p>
</li>
***************
*** 190,236 ****
<p>The <tt>make</tt> program is not strictly required, but the
master <tt>Makefile</tt> provides a convenient interface to
! invoking the various mharc scripts. GNU make is recommended,
but other variations should work also. <tt>make</tt> is generally
provided on all Unix-like distributions.
</p>
- <table class="note">
- <tr valign="baseline">
- <td><strong>NOTE:</strong></td>
- <td><p>Some systems may have installed GNU make as <tt>gmake</tt>.
- If this is the case, anytime <tt>make</tt> is referenced in this
- document, replace it with <tt>gmake</tt>.
- </p>
- </td></tr></table>
</li>
</ul>
- <p>To quickly check if you have these packages installed,
- enter the following command at your shell prompt:
- </p>
- <pre class="shell">
- prompt> <b>which perl mhonarc namazu procmail lockfile make</b>
- /usr/local/bin/perl
- /usr/local/bin/mhonarc
- /usr/local/bin/namazu
- /usr/bin/procmail
- /usr/bin/lockfile
- /usr/bin/make
- </pre>
- <p>If the command returns a negative response for some of the
- programs, it does not necessarily indicate that the given program
- is not installed. It just indicates that it is not located in your
- shell's search path. Good places to look are in
- <tt>/usr/local/bin</tt>
- and
- <tt>/usr/bin</tt>.
- </p>
-
<table class="note">
<tr valign="baseline">
<td><strong>NOTE:</strong></td>
! <td><p>Under Solaris, <tt>make</tt> is typically located in
! <tt>/usr/ccs/bin</tt>. Also, if the optional software CD is installed,
! many free software packages will be installed in <tt>/opt/sfw/bin</tt>,
! including GNU make, which is called <tt>gmake</tt>.
</p>
</td></tr></table>
--- 197,214 ----
<p>The <tt>make</tt> program is not strictly required, but the
master <tt>Makefile</tt> provides a convenient interface to
! invoking the various mharc scripts. GNU make is recommended
! (and is sometimes installed as <tt>gmake</tt>),
but other variations should work also. <tt>make</tt> is generally
provided on all Unix-like distributions.
</p>
</li>
</ul>
<table class="note">
<tr valign="baseline">
<td><strong>NOTE:</strong></td>
! <td><p>The <a href="#install"><tt>install.pl</tt></a> installation
! script will check for programs that is required by mharc. If it
! cannot locate a program, it will generate a warning message.
</p>
</td></tr></table>
***************
*** 239,246 ****
what is installed on your system, contact your system administrator
(and while your at it, you may want to ask your sys admin to
! install this software for you :-).
! </p>
! <p>If you know that a given package is not installed, follow the
! instructions provided for the given package to install it.
</p>
--- 217,221 ----
what is installed on your system, contact your system administrator
(and while your at it, you may want to ask your sys admin to
! install mharc for you :-).
</p>
***************
*** 250,257 ****
<p>After MHonArc, Namazu, and Procmail have been installed, you can
! extract the tar bundle wherever you want the software installed,
! which you probably already did if your reading this file. If you
! extracted the bundle into a temporary location, you can re-extract
! to your prefered location.
</p>
--- 225,248 ----
<p>After MHonArc, Namazu, and Procmail have been installed, you can
! extract the tar bundle in a temporary location to start the installation
! process. The following command will extract the <tt>tar.gz</tt> distribution
! bundle: </p>
! <table border=1 width="100%"><tr><td><pre class="shell">
! prompt> <b>gzip -dc mharc-<i>X.X.X</i> | tar xvf -</b>
! mharc-<i>X.X.X</i>/
! mharc-<i>X.X.X</i>/README
! mharc-<i>X.X.X</i>/INSTALL
! mharc-<i>X.X.X</i>/NEWS
! mharc-<i>X.X.X</i>/COPYING
! mharc-<i>X.X.X</i>/TODO
! mharc-<i>X.X.X</i>/install.pl
! mharc-<i>X.X.X</i>/doc/
! <i>...</i>
! <i>...[file list snipped for brevity]...</i>
! <i>...</i>
! </pre></td></tr></table>
!
! <p>where <tt class="ishell"><i>X.X.X</i></tt> represents the version number
! of mharc you are extracting.
</p>
***************
*** 276,290 ****
<!-- ====================================================================== -->
<hr>
! <h2><img src="images/mharc-icon.png" align="top" alt=""> <a name="configure">Configuring mharc</a></h2>
! <p>After you extract the tar bundle, run the following command:
</p>
! <pre class="shell">
prompt> <b>make configure</b>
./bin/apply-config -verbose
! /bin/cp common.mrc.in.dist common.mrc.in
! /bin/chmod u+w common.mrc.in
! Processing "./bin/../dist/mharc/lib/common.mrc.in"
! <i>... [snip] ...</i>
./bin/mhonarc-check
You are using MHonArc v2.5.12
--- 267,382 ----
<!-- ====================================================================== -->
<hr>
! <h2><img src="images/mharc-icon.png" align="top" alt=""> <a name="install">Running <tt>install.pl</tt></a></h2>
!
! <p>After you extract the tar bundle, execute the following commands to
! run the mharc installation script:
! </p>
! <table border=1 width="100%"><tr><td><pre class="shell">
! prompt> <b>cd mharc-<i>X.X.X</i></b>
! prompt> <b>perl install.pl</b>
! </pre></td></tr></table>
!
! <p>The <a href="bin/install.pl.html"><tt>install.pl</tt></a> program
! will perform some system checks and prompt you where you want to
! install mharc. If this is a new install, it will also prompt you for
! some configuration information. The following is an example session
! of a new install: </p>
!
! <a name="install_session"></a>
! <table border=1 width="100%"><tr><td><pre class="shell">
! chdir .
! Looking for 'make' program... '/usr/bin/gmake'
! Looking for 'tar' program... '/bin/tar'
! Looking for 'cp' program... '/bin/cp'
! Looking for 'mkdir' program... '/bin/mkdir'
! Looking for 'pwd' program... '/bin/pwd'
!
! Pathname to install mharc: /home/mharc/archives
! "/home/mharc/archives" does not exist, create? ['y']
! /bin/mkdir -p /home/mharc/archives
! Current working directory: /tmp/mharc-<i>X.X.X</i>
! /bin/tar cf - . | (cd "/home/mharc/archives" && tar xvf -)
! ./
! ./README
! ./INSTALL
! ./NEWS
! ./COPYING
! <i>...</i>
! <i>...[file list snipped for brevity]...</i>
! <i>...</i>
! chdir /home/mharc/archives
! /bin/cp lib/config.sh.dist lib/config.sh
! Looking for 'mhonarc' program... '/usr/local/bin/mhonarc'
! Determine MHonArc library path from '/usr/local/bin/mhonarc'... \
! '/usr/local/lib/perl5/site_perl/5.6.1'
! Looking for 'mknmz' program... '/usr/local/bin/mknmz'
!
! Root URL for archives
! (You can set this later in lib/config.sh): /mharc/archives
! /bin/cp lib/lists.def.dist lib/lists.def
! Looking for 'namazu.cgi'... '/usr/local/libexec/namazu.cgi'
! bin/mhonarc-check
! You are using MHonArc v2.5.12
! Applying configuration (this may take awhile)...
! ------------------------------------------------------------------------
! Please read the document
! /home/mharc/archives/doc/install.html
! (Text Version: /home/mharc/archives/INSTALL)
! to finish the installation process.
! ------------------------------------------------------------------------
! </pre></td></tr></table>
! <table class="note" width="100%">
! <tr valign="baseline">
! <td><strong>NOTE:</strong></td>
! <td width="100%"><p>The installation script may provide diagnostics
! that warn you of any conditions that may prevent mharc from operating
! properly. Each warning message will provide you with information
! on what you can do to fix the problem.
</p>
! </td></tr></table>
! <p></p>
! <table class="note" width="100%">
! <tr valign="baseline">
! <td><strong>NOTE:</strong></td>
! <td width="100%"><p>The version of MHonArc shown may
! be different than what is shown above. The version shown will be
! the version you have installed on your system, and the version
! of MHonArc used when generating the HTML archives.
! </p>
! </td></tr></table>
!
! <!-- ====================================================================== -->
! <hr>
! <h2><img src="images/mharc-icon.png" align="top" alt=""> <a name="configure">Checking Configuration</a></h2>
!
! <p>After running
! <a href="bin/install.pl.html"><tt>install.pl</tt></a>, change your
! current working directory to the location you installed mharc. Continuing
! with <a href="#install_session">installation session</a> earlier,
! the following would be done:
! </p>
! <table border=1 width="100%"><tr><td><pre class="shell">
! prompt> <b>cd <i>/home/mharc/archives</i></b>
! </pre></td></tr></table>
! <p>Replace <tt class="ishell"><i>/home/mharc/archives</i></tt> with
! the pathname location you specified.
! </p>
!
! <p>You should now examine the
! <a href="file/config.sh.txt"><tt>lib/config.sh</tt></a> mharc
! configuration file created by
! <a href="bin/install.pl.html"><tt>install.pl</tt></a> and make any
! edits as needed. If you made some changes, 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>
./bin/apply-config -verbose
! Processing "./bin/../lib/common.mrc.in"
! Processing "./bin/../lib/mrc/_nothread.mrc.in"
! Processing "./bin/../lib/mrc/_logo.mrc.in"
! <i>...</i>
! <i>... [files processed snipped for brevity] ...</i>
! <i>...</i>
./bin/mhonarc-check
You are using MHonArc v2.5.12
***************
*** 293,305 ****
* lib/config.sh or change a .in template file.
=============================================================
! </pre>
! <p>Then, you should edit
! <a href="file/config.sh.txt"><tt>lib/config.sh</tt></a> to suit your
! local settings and rerun</p>
! <pre class="shell">
! prompt> <b>make configure</b></pre>
! <p>again to apply your changes.
! </p>
<table class="note">
--- 385,394 ----
* lib/config.sh or change a .in template file.
=============================================================
! </pre></td></tr></table>
! <p>In general, if you make any 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> so your changes will
! get applied. </p>
<table class="note">
***************
*** 313,355 ****
</td></tr></table>
! <p>Now, edit <a href="file/lists.def.txt"><tt>lib/lists.def</tt></a>
! to define the mailing lists you want archived. Syntax of the file
! is documented in the
<a href="bin/mk-procmailrc.html#list%20definition%20file"><tt>mk-procmailrc</tt></a>
manpage.
After editing, run the following command: </p>
! <pre class="shell">
prompt> <b>make</b>
You are using MHonArc v2.5.12
./bin/mk-procmailrc
! </pre>
<p>This should generate a filed called <tt>procmailrc.mharc</tt>
! that will do the initial filtering of mail. At anytime, if you edit
! <a href="file/lists.def.txt"><tt>lib/lists.def</tt></a>, you can rerun
! “<tt>make</tt>” to regenerate the <tt>procmailrc.mharc</tt>
! file to reflect your changes. </p>
! <table class="note" width="100%">
! <tr valign="baseline">
! <td><strong>NOTE:</strong></td>
! <td width="100%"><p>The version of MHonArc shown in the output may
! be different than what is shown above. The version shown will be
! the version you have installed on your system, and the version
! of MHonArc used when generating the HTML archives.
! </p>
! </td></tr></table>
! <p>The final step is to edit the archive user account crontab
to register the mail archiving scripts to cron inorder to get
automatic processing of your archives. The file
! <tt>etc/crontab</tt>
can serve as a template of the crontab entries you should add.
To register the file as your crontab, you can do the following:
</p>
! <pre class="shell">
prompt> <b>crontab etc/crontab</b>
! </pre>
<table class="caution" width="100%">
--- 402,443 ----
</td></tr></table>
! <!-- ====================================================================== -->
! <hr>
! <h2><img src="images/mharc-icon.png" align="top" alt=""> <a name="lists_def">Editing <tt>lists.def</tt></a></h2>
!
! <p>Once you have finished the main configuration step, you now need
! to define the lists you want to archive. To do this, you must
! edit <a href="file/lists.def.txt"><tt>lib/lists.def</tt></a>
! The syntax of the file is documented in the
<a href="bin/mk-procmailrc.html#list%20definition%20file"><tt>mk-procmailrc</tt></a>
manpage.
After editing, run the following command: </p>
! <table border=1 width="100%"><tr><td><pre class="shell">
prompt> <b>make</b>
You are using MHonArc v2.5.12
./bin/mk-procmailrc
! </pre></td></tr></table>
<p>This should generate a filed called <tt>procmailrc.mharc</tt>
! that will do the initial filtering of mail. At anytime, if you
! edit <a href="file/lists.def.txt"><tt>lib/lists.def</tt></a>, you
! can rerun <tt class="ishell"><b>make</b></tt> to regenerate the
! <tt>procmailrc.mharc</tt> file to reflect your changes. </p>
! <!-- ====================================================================== -->
! <hr>
! <h2><img src="images/mharc-icon.png" align="top" alt=""> <a name="crontab">Defining your <tt>crontab</tt></a></h2>
! <p>The final step is to edit your archive user account's crontab
to register the mail archiving scripts to cron inorder to get
automatic processing of your archives. The file
! <a href="file/crontab.txt"><tt>etc/crontab</tt></a>
can serve as a template of the crontab entries you should add.
To register the file as your crontab, you can do the following:
</p>
! <table border=1 width="100%"><tr><td><pre class="shell">
prompt> <b>crontab etc/crontab</b>
! </pre></td></tr></table>
<table class="caution" width="100%">
***************
*** 360,366 ****
</p>
! <pre class="shell">
prompt> <b>crontab -e</b>
! </pre>
<p>And copy the entries in <tt>etc/crontab</tt> into the account's
--- 448,454 ----
</p>
! <table border=1 width="100%"><tr><td><pre class="shell">
prompt> <b>crontab -e</b>
! </pre></td></tr></table>
<p>And copy the entries in <tt>etc/crontab</tt> into the account's
***************
*** 373,382 ****
and run</p>
! <pre class="shell">
! prompt> <b>make configure</b></pre>
<p>to create an <tt>etc/crontab</tt> file suitable for copying into
the account's crontab. </p>
<!-- ====================================================================== -->
<hr>
--- 461,481 ----
and run</p>
! <table border=1 width="100%"><tr><td><pre class="shell">
! prompt> <b>make configure</b></pre></td></tr></table>
<p>to create an <tt>etc/crontab</tt> file suitable for copying into
the account's crontab. </p>
+ <table class="note">
+ <tr valign="baseline">
+ <td><strong>NOTE:</strong></td>
+ <td><p>If you are system does not support cron, or you are unable to
+ register the execution of programs at periodic intervals, you can
+ still manually invoke archive processing by using the various
+ makefile targets shown in
+ <a href="#maintenance"><cite>Maintenance Operations</cite></a>.
+ </p>
+ </td></tr></table>
+
<!-- ====================================================================== -->
<hr>
***************
*** 386,390 ****
run the command,
</p>
! <pre class="shell">
prompt> <b>make help</b>
Targets available:
--- 485,489 ----
run the command,
</p>
! <table border=1 width="100%"><tr><td><pre class="shell">
prompt> <b>make help</b>
Targets available:
***************
*** 401,405 ****
rootidx: Regenerated top index for archives.
...
! </pre>
<p>You will get a summary of what targets are available. Targets exist
--- 500,504 ----
rootidx: Regenerated top index for archives.
...
! </pre></td></tr></table>
<p>You will get a summary of what targets are available. Targets exist
***************
*** 411,420 ****
and a message should be displayed when this happens. You can run:
</p>
! <pre class="shell">
prompt> <b>make enable</b>
=============================================================
!!! Auto-archive processing is ENABLED !!!
=============================================================
! </pre>
<p>to re-enable auto-message processing.
</p>
--- 510,519 ----
and a message should be displayed when this happens. You can run:
</p>
! <table border=1 width="100%"><tr><td><pre class="shell">
prompt> <b>make enable</b>
=============================================================
!!! Auto-archive processing is ENABLED !!!
=============================================================
! </pre></td></tr></table>
<p>to re-enable auto-message processing.
</p>
***************
*** 425,462 ****
<ul>
- <li><p>The Perl scripts contained in mharc assume the perl executable
- is located at <tt>/usr/local/bin/perl</tt>. If perl is installed, but
- in a different location, you can create a symbolic link from
- <tt>/usr/local/bin/perl</tt> to the installed location of the perl
- executable. If you do not have permissions to do this, you will
- need to change the initial <tt>#!</tt> line in all the Perl scripts to
- reflect the location of perl.
- </p>
-
- <li><p>mharc calls MHonArc via its library API, therefore make sure
- that the MHonArc library files are located in perl's library
- search path if you chose a different directory to install MHonArc
- library files from perl's site library location. You may need
- to set the <tt>MHONARC_LIB</tt> variable in
- <a href="file/config.sh.txt"><tt>lib/config.sh</tt></a> to the
- pathname location of the MHonArc libraries on your system.
- </p>
-
- <table class="note">
- <tr valign="baseline">
- <td><strong>NOTE:</strong></td>
- <td><p>The “<tt>make configure</tt>” command mentioned
- earlier will automatically check if MHonArc can be loaded. If not,
- the command will generate an error message indicating
- what you can do to fix the problem.
- </p>
- </td></tr></table>
-
-
- <li><p>Double check the URL to the <tt>namazu.cgi</tt> program. A useful
- tip is to copy the <tt>namazu.cgi</tt> program into the cgi-bin of
- the mharc installation.
- </p>
-
<li><p>The file
<a href="file/apache.conf.txt"><tt>etc/apache.conf</tt></a>
--- 524,527 ----
***************
*** 466,471 ****
<tt>etc/apache.conf.in</tt>
and run</p>
! <pre class="shell">
! prompt> <b>make configure</b></pre>
<p>to generate a new
<tt>etc/apache.conf</tt> that can be used in your Apache server configuration
--- 531,536 ----
<tt>etc/apache.conf.in</tt>
and run</p>
! <table border=1 width="100%"><tr><td><pre class="shell">
! prompt> <b>make configure</b></pre></td></tr></table>
<p>to generate a new
<tt>etc/apache.conf</tt> that can be used in your Apache server configuration
***************
*** 484,489 ****
executing the following command from the installation root:
</p>
! <pre class="shell">
! prompt> <b>ln -s ./etc/.htaccess</b></pre>
<p>This way, you do not have to re-copy each time you make
changes to this file.
--- 549,554 ----
executing the following command from the installation root:
</p>
! <table border=1 width="100%"><tr><td><pre class="shell">
! prompt> <b>ln -s ./etc/.htaccess</b></pre></td></tr></table>
<p>This way, you do not have to re-copy each time you make
changes to this file.
***************
*** 523,528 ****
<td><strong>NOTE:</strong></td>
<td width="100%"><p>You must run</p>
! <pre class="shell">
! prompt> <b>make configure</b></pre>
<p>to have mharc
recognize any changes you made to a template file.
--- 588,593 ----
<td><strong>NOTE:</strong></td>
<td width="100%"><p>You must run</p>
! <table border=1 width="100%"><tr><td><pre class="shell">
! prompt> <b>make configure</b></pre></td></tr></table>
<p>to have mharc
recognize any changes you made to a template file.
***************
*** 536,541 ****
the "<tt>.in.dist</tt>" version of a file, just remove the
"<tt>.in</tt>" version and rerun</p>
! <pre class="shell">
! prompt> <b>make configure</b></pre>
<p>The main MHonArc resource file is
--- 601,606 ----
the "<tt>.in.dist</tt>" version of a file, just remove the
"<tt>.in</tt>" version and rerun</p>
! <table border=1 width="100%"><tr><td><pre class="shell">
! prompt> <b>make configure</b></pre></td></tr></table>
<p>The main MHonArc resource file is
***************
*** 545,550 ****
<tt>lib/common.mrc.in</tt>
and run</p>
! <pre class="shell">
! prompt> <b>make configure</b></pre>
<p>
to generate a new
--- 610,615 ----
<tt>lib/common.mrc.in</tt>
and run</p>
! <table border=1 width="100%"><tr><td><pre class="shell">
! prompt> <b>make configure</b></pre></td></tr></table>
<p>
to generate a new
***************
*** 590,608 ****
</pre>
<p>And run</p>
! <pre class="shell">
! prompt> <b>make configure</b></pre>
<p>Anytime you want to make
any changes, make sure to edit <tt>$SW_ROOT/lib/default.mrc.<b>in</b></tt>
and rerun</p>
! <pre class="shell">
! prompt> <b>make configure</b></pre>
<p>Anytime you upgrade mharc, and mharc contains a new, improved
<tt>lib/common.mrc.in.dist</tt>, and you want the new settings to be
applied to your archives, you just need to do the following:
</p>
! <pre class="shell">
prompt> <b>rm lib/common.mrc.in</b>
prompt> <b>make configure</b>
! </pre>
<p>Any additional and/or override settings you have in
<tt>lib/default.mrc</tt> are left untouched.
--- 655,673 ----
</pre>
<p>And run</p>
! <table border=1 width="100%"><tr><td><pre class="shell">
! prompt> <b>make configure</b></pre></td></tr></table>
<p>Anytime you want to make
any changes, make sure to edit <tt>$SW_ROOT/lib/default.mrc.<b>in</b></tt>
and rerun</p>
! <table border=1 width="100%"><tr><td><pre class="shell">
! prompt> <b>make configure</b></pre></td></tr></table>
<p>Anytime you upgrade mharc, and mharc contains a new, improved
<tt>lib/common.mrc.in.dist</tt>, and you want the new settings to be
applied to your archives, you just need to do the following:
</p>
! <table border=1 width="100%"><tr><td><pre class="shell">
prompt> <b>rm lib/common.mrc.in</b>
prompt> <b>make configure</b>
! </pre></td></tr></table>
<p>Any additional and/or override settings you have in
<tt>lib/default.mrc</tt> are left untouched.
***************
*** 619,626 ****
<p>The software is structured to avoid screwing up an existing
! installation. All you need to do is extract the newer version
! of the bundle in the same location of the initial installation.
All the "<tt>.in.dist</tt>" files will get overwritten, but any "<tt>.in</tt>"
! files should be left untouched inorder to preserver any local edits.
</p>
--- 684,692 ----
<p>The software is structured to avoid screwing up an existing
! installation. When running
! <a href="#install"><tt>install.pl</tt></a>, just specify the existing
! location of your mharc installation.
All the "<tt>.in.dist</tt>" files will get overwritten, but any "<tt>.in</tt>"
! files will be left untouched inorder to preserve any local customizations.
</p>
***************
*** 631,636 ****
"<tt>.in.dist</tt>" version of a file, just remove the
"<tt>.in</tt>" version and rerun</p>
! <pre class="shell">
! prompt> <b>make configure</b></pre>
</td></tr></table>
--- 697,702 ----
"<tt>.in.dist</tt>" version of a file, just remove the
"<tt>.in</tt>" version and rerun</p>
! <table border=1 width="100%"><tr><td><pre class="shell">
! prompt> <b>make configure</b></pre></td></tr></table>
</td></tr></table>
***************
*** 731,734 ****
--- 797,808 ----
</pre>
+ <p>This method is probably better than the
+ <a href="#mharclistsadmin">mharc-based solution</a> since it eliminates
+ the need to poll the archive for any messages. It is also more secure
+ since any list administration messages are never in web server accessible
+ location, eliminating the need to edit server configuration to restrict
+ access to the list admin messages archive.
+ </p>
+
<!-- ====================================================================== -->
<hr>
***************
*** 742,746 ****
so the use of Javascript can be removed.
</p>
! <p>If Javascript is disable, or not supported, in a web client,
initial searches from an archive page will work, but trying to
do another search from the results page will always return no hits.
--- 816,820 ----
so the use of Javascript can be removed.
</p>
! <p>If Javascript is disabled, or not supported, in a web client,
initial searches from an archive page will work, but trying to
do another search from the results page will always return no hits.
Index: tools.html
===================================================================
RCS file: /cvsroot/mhonarc/mharc/doc/tools.html,v
retrieving revision 1.3
retrieving revision 1.4
diff -C2 -r1.3 -r1.4
*** tools.html 20 Sep 2002 03:01:26 -0000 1.3
--- tools.html 24 Sep 2002 06:39:46 -0000 1.4
***************
*** 22,25 ****
--- 22,27 ----
<dl>
+ <dt><a href="bin/install.pl.html"><strong><tt>install.pl</tt></strong></a></dt>
+ <dd>Installation script for mharc.</dd>
<dt><a href="bin/apply-config.html"><strong><tt>apply-config</tt></strong></a></dt>
<dd>Process input template files based upon configuration settings.</dd>
---------------------------------------------------------------------
To sign-off this list, send email to majordomo(_at_)mhonarc(_dot_)org with the
message text UNSUBSCRIBE MHONARC-DEV