web-archive - Update/create MHonArc archives from mailbox archives. |
web-archive - Update/create MHonArc archives from mailbox archives.
web-archive web-archive [options] web-archive [options] [list-name ...]
This program is part of mharc and has the responsibility of processing the mailbox archives created by the filter-spool script to update and/or create MHonArc archives.
This program is automatically called by the read-mail script for processing incoming mail within the mail spool if filter-spool returns with an okay status. However, this program can be manually invoked to rebuild archives, edit existing archives, or other administrative tasks. Since there may be a need to do selective archive processing, any non-option related argument is treated as mailing list archive name to process.
-alllistidx
pathname
Pathname of file to generate the all lists index.
If not specified, the value of the ALL_LISTS_FILE
variable in
config.sh
is used, else it defaults to ``-htmldir/lists.html
''.
-alllistsurl
url
URL to page containing list of all mailing lists archived.
If not specified, the value of the ALL_LISTS_URL
variable in
config.sh
is used, else it defaults to -htmlurl
.
-editidx
Edit archive pages, useful to apply MHonArc resource changes.
-editrootidx
Only regenerate root index pages for archives. This is useful if
you make changes to the .PNM.head
or .PNM.foot
files that you
want immediately applied.
-help
Print out usage information.
-home
pathname
Root pathname of archiving software and data. If not specified, the parent directory that contains this program is used.
-htmldir
pathname
Root directory for html archives.
If not specified, ``-home/html
'' is used.
-htmlurl
url
URL root to HTML archives.
If not specified, defaults to rooturl/html
.
-infodir
pathname
Pathname of directory containing informational pages for each list
archive. Information for a list archive can be provided by creating a
file called ``list-name.html
''. Once created, a link to the file
(based on the value of the -infourl
option) will be generated in
the all-lists index to it.
If this option is not specified, the value of the INFO_DIR
variable
in config.sh
is used, else it defaults to ``-home/info
''.
-infourl
url
Base URL containing informational pages for each list archive.
If not specified, the value of the INFO_URL
variable in
config.sh
is used, else it defaults to ``-rooturl/info
''.
-keepsearch
Preserve search index if -rebuild
is specified. This option
is handy if all that is desired is to rebuild the HTML archives
from the raw data since the overhead of rebuilding the search indexes
will be avoided.
CAUTION: Do not use -keepsearch
if you have removed messages
from the raw mail archives since resulting HTML message pages may
have different URIs than what is stored within the search index.
-listsdef
pathname
Pathname to mailing lists definition file.
If not specified, ``-home/lib/lists.def
'' is used.
-man
Print out entire manpage.
-mboxdir
pathname
Root directory for mbox archives.
If not specified, ``-home/mbox
'' is used.
-mharc
pathname
MHonArc resource file for archives.
If not specified, ``-home/lib/common.mrc
'' is used.
-mharcdir
pathname
Directory containing list-specifc MHonArc resource files. A given
list archive can have additional resource settings by creating a
file called list-name.mrc
within the directory specified by
-mharcdir
.
If -mharcdir
is not specified, ``-home/lib/mrc
'' is used.
-mhamaxsize
number
Maximum MHonArc archive size.
If not specified the value of the WA_MAXSIZE
environment variable is used.
-mhapagesize
number
Maximum MHonArc index page size.
If not specified the value of the WA_PAGESIZE
environment variable is used.
-mknmz
pathname
Pathname to Namazu make search index program.
If not specified, ``/usr/local/bin/mknmz
'' is used.
-mknmzrc
pathname
Pathname to Namazu configuration file.
If not specified, ``-home/cgi-bin/mknmzrc
'' is used.
-mknmztmpldir
pathname
Pathname to Namazu template directory.
If not specified, ``-home/cgi-bin/template
'' is used.
-mnavcgi
url
URL to monthly navigation cgi program.
If not specified, rooturl/cgi-bin/mnav.cgi
is used.
-mtimeage
seconds
Modify time age of a mailbox file to be considered for processing. If
not specified the value of the WA_MTIME_AGE
environment variable is
used.
-nosearch
Do not update search indexes.
-period
period
Restrict operations to specified time period. This option is
applicable when -rebuild
or -editidx
is specified to restrict
processing to a given period of an archive, especially for large
archives in order to avoid complete rebuilds.
This option can be specified multiple times. For example:
web-archive -rebuild -period 2003-11 -period 2003-10 ...
If no list names are provided, the specified periods apply to all archives.
-rebuild
Rebuild archives from scratch.
-rooturl
url
URL root of archives.
If not specified, /~mhonarc/archives
is used.
-searchcgi
url
URL to search cgi program.
If not specified, rooturl/cgi-bin/namazu.cgi
is used.
-verbose
Show what is going on in detail.
Environment variable usage is deprecated.
The following environment variables are recognized:
WA_DEBUG
If set to a true value, detailed information of progress will be
printed to stdout. Debugging can also be enabled by the
-debug
command-line option.
WA_EDIT
If set to a true value, archives will be editted. It is probably
better to use the -editidx
command-line option instead if archives
editing is desired.
WA_MAXSIZE
Maximum MHonArc archive size. The default value is 2000. This setting
can be overridden by the -mhamaxsize
command-line option.
WA_MTIME_AGE
The modification age, in seconds, for a mailbox to be considered
for processing. The default value is 86400
(one day).
This setting can be overridden by the -mtimeage
command-line option.
WA_NOSEARCH
If set to a true value, the Namazu search indexes will not be updated
for archives processed. Disabling of search index updates can also be
disabled by the -nosearch
command-line option.
WA_PAGESIZE
MHonArc index page size. The default value is 200. This setting
can be overridden by the -mhapagesize
command-line option.
WA_REBUILD
If set to a true value, archives will be rebuilt. It is probably
better to use the -rebuild
command-line option instead if rebuilding
is desired.
$Id: web-archive,v 1.46 2015/12/21 19:07:50 ehood Exp $
Earl Hood, earl@earlhood.com
This program is part of the mharc archiving system and comes with ABSOLUTELY NO WARRANTY and may be copied only under the terms of the GNU General Public License, which may be found in the mharc distribution.
web-archive - Update/create MHonArc archives from mailbox archives. |