Update of /cvsroot/mhonarc/mharc/bin
In directory subversions:/tmp/cvs-serv15994
Modified Files:
apply-config compress-files compress-mboxes extract-mesg-date
filter-spool gc-search-indexes mbox-month-pack mh-month-pack
mhonarc-check mk-procmailrc read-mail web-archive
Log Message:
Documentation mods.
Index: apply-config
===================================================================
RCS file: /cvsroot/mhonarc/mharc/bin/apply-config,v
retrieving revision 1.9
retrieving revision 1.10
diff -C2 -r1.9 -r1.10
*** apply-config 13 Sep 2002 07:25:55 -0000 1.9
--- apply-config 15 Sep 2002 03:33:08 -0000 1.10
***************
*** 163,170 ****
This program processes input template files and expands variables
! referenced to values specified in C<$SW_ROOT/lib/config.sh>, where
! C<$SW_ROOT> is the root of the software installation (which is
! considered to be the parent directory of the directory containing this
! program).
Template files are designated by the C<.in> filename extentions. For a
--- 163,167 ----
This program processes input template files and expands variables
! referenced to values specified in C<E<lt>mharc-rootE<gt>/lib/config.sh>.
Template files are designated by the C<.in> filename extentions. For a
***************
*** 183,187 ****
Any non-option arguments are treated as directories to recursively
scan for template files. If no directories are specified, then
! C<$SW_ROOT> is used as defined in L<"DESCRIPTION">.
=over
--- 180,184 ----
Any non-option arguments are treated as directories to recursively
scan for template files. If no directories are specified, then
! C<$SW_ROOT> is used as defined in C<E<lt>mharc-rootE<gt>/lib/config.sh>.
=over
***************
*** 198,201 ****
--- 195,202 ----
clean up all files for generating a distribution bundle.
+ B<WARNING:> Use this option with care since it will delete all
+ customized versions of C<.in> templates. This option is mainly
+ for use by mharc developers.
+
=item -debug
***************
*** 217,221 ****
=over
! =item C<$SW_ROOT/lib/config.sh>
Configuration file defining variables values.
--- 218,222 ----
=over
! =item C<E<lt>mharc-rootE<gt>/lib/config.sh>
Configuration file defining variables values.
Index: compress-files
===================================================================
RCS file: /cvsroot/mhonarc/mharc/bin/compress-files,v
retrieving revision 1.7
retrieving revision 1.8
diff -C2 -r1.7 -r1.8
*** compress-files 13 Sep 2002 07:25:55 -0000 1.7
--- compress-files 15 Sep 2002 03:33:08 -0000 1.8
***************
*** 116,123 ****
=head1 DESCRIPTION
! This program is part of mharc, the auto-archiving system that works in
! conjuction with Procmail, Namazu, and a collection of shell and
! Perl programs. This program is used to compress files that have not
! been modified over a given period of time.
=head1 OPTIONS
--- 116,121 ----
=head1 DESCRIPTION
! This program is part of mharc. This program is used to compress
! files that have not been modified over a given period of time.
=head1 OPTIONS
Index: compress-mboxes
===================================================================
RCS file: /cvsroot/mhonarc/mharc/bin/compress-mboxes,v
retrieving revision 1.7
retrieving revision 1.8
diff -C2 -r1.7 -r1.8
*** compress-mboxes 13 Sep 2002 07:25:55 -0000 1.7
--- compress-mboxes 15 Sep 2002 03:33:08 -0000 1.8
***************
*** 101,107 ****
=head1 DESCRIPTION
! This program is part of mharc, the auto-archiving system that works in
! conjuction with Procmail, Namazu, and a collection of shell and
! Perl programs. This program has the responsibility of gzipping
mailbox files that have not been modified in over a month to save
disk space.
--- 101,105 ----
=head1 DESCRIPTION
! This program is part of mharc and has the responsibility of gzipping
mailbox files that have not been modified in over a month to save
disk space.
***************
*** 111,115 ****
This program will use the C<MBOX_DIR> variable from
! C<I<mharc-root>/lib/config.sh> as the root directory to search for
mailbox files. Any file matching the following regex,
--- 109,113 ----
This program will use the C<MBOX_DIR> variable from
! C<E<lt>mharc-rootE<gt>/lib/config.sh> as the root directory to search for
mailbox files. Any file matching the following regex,
***************
*** 144,148 ****
=over
! =item C<I<mharc-root>/lib/config.sh>
Main configuration file for mharc.
--- 142,146 ----
=over
! =item C<E<lt>mharc-rootE<gt>/lib/config.sh>
Main configuration file for mharc.
Index: extract-mesg-date
===================================================================
RCS file: /cvsroot/mhonarc/mharc/bin/extract-mesg-date,v
retrieving revision 1.3
retrieving revision 1.4
diff -C2 -r1.3 -r1.4
*** extract-mesg-date 13 Sep 2002 07:25:55 -0000 1.3
--- extract-mesg-date 15 Sep 2002 03:33:08 -0000 1.4
***************
*** 120,123 ****
--- 120,131 ----
mesg_date=`cat message | extract-mesg-date`
+ Example useage within a procmail recipe:
+
+ :0 Wi
+ MESGDATE_=| extract-mesg-date -fmt '%Y-%m'
+
+ :0:
+ $MBOXROOT/.listsadmin/$MESGDATE_
+
=head1 OPTIONS
***************
*** 139,143 ****
Print out debugging information.
! B<DO NOT USE THIS OPTION WITHIN PROCMAILRC RULES.>
=item C<-fmt> I<time-fmt-string>
--- 147,151 ----
Print out debugging information.
! B<WARNING: DO NOT USE THIS OPTION WITHIN PROCMAILRC RULES.>
=item C<-fmt> I<time-fmt-string>
Index: filter-spool
===================================================================
RCS file: /cvsroot/mhonarc/mharc/bin/filter-spool,v
retrieving revision 1.9
retrieving revision 1.10
diff -C2 -r1.9 -r1.10
*** filter-spool 13 Sep 2002 07:25:55 -0000 1.9
--- filter-spool 15 Sep 2002 03:33:08 -0000 1.10
***************
*** 181,194 ****
=head1 DESCRIPTION
! This program is part of mharc, a web-based mail archiving system.
! This program has the responsibility of filtering incoming mail into
! the raw message archives. This script is called by the L<read-mail|read-mail>
! script before L<web-archive|web-archive> is invoked.
=head1 OPTIONS
This program is generally called without any command-line options
! since it will read C<I<mharc-root>/lib/config.sh> for all configurable
! options. Regardless, the following command-line options are
available:
--- 181,194 ----
=head1 DESCRIPTION
! This program is part of mharc and has the responsibility of filtering
! incoming mail into the raw message archives. This script is called
! by the L<read-mail|read-mail> script before L<web-archive|web-archive>
! is invoked.
=head1 OPTIONS
This program is generally called without any command-line options
! since it will read C<E<lt>mharc-rootE<gt>/lib/config.sh> for all configurable
! options. However, the following command-line options are
available:
***************
*** 239,243 ****
Pathname to incoming mailbox file.
If not specified, C<ORGMAIL> variable in C<config.sh> is used,
! else C</var/mail/$LOGNAME> is used (C<$LOGNAME> represents the
value of the C<LOGNAME> environment variable.
--- 239,243 ----
Pathname to incoming mailbox file.
If not specified, C<ORGMAIL> variable in C<config.sh> is used,
! else C</var/mail/$LOGNAME> is used, where C<$LOGNAME> represents the
value of the C<LOGNAME> environment variable.
***************
*** 279,283 ****
=over
! =item C<I<mharc-root>/lib/config.sh>
Main configuration file for mharc.
--- 279,283 ----
=over
! =item C<E<lt>mharc-rootE<gt>/lib/config.sh>
Main configuration file for mharc.
Index: gc-search-indexes
===================================================================
RCS file: /cvsroot/mhonarc/mharc/bin/gc-search-indexes,v
retrieving revision 1.5
retrieving revision 1.6
diff -C2 -r1.5 -r1.6
*** gc-search-indexes 13 Sep 2002 07:25:55 -0000 1.5
--- gc-search-indexes 15 Sep 2002 03:33:08 -0000 1.6
***************
*** 122,128 ****
=head1 DESCRIPTION
! This program is part of mharc, the auto-archiving system that works in
! conjuction with Procmail, Namazu, and a collection of shell and
! Perl programs. This program has the responsibility of performing
garbage collection on archive search indexes.
--- 122,126 ----
=head1 DESCRIPTION
! This program is part of mharc, and has the responsibility of performing
garbage collection on archive search indexes.
***************
*** 131,135 ****
This program will use the C<HTML_DIR> variable from
! C<I<mharc-root>/lib/config.sh> as the root directory to search for
searchable archives.
--- 129,133 ----
This program will use the C<HTML_DIR> variable from
! C<E<lt>mharc-rootE<gt>/lib/config.sh> as the root directory to search for
searchable archives.
***************
*** 160,164 ****
=over
! =item C<I<mharc-root>/lib/config.sh>
Main configuration file for mharc.
--- 158,162 ----
=over
! =item C<E<lt>mharc-rootE<gt>/lib/config.sh>
Main configuration file for mharc.
Index: mbox-month-pack
===================================================================
RCS file: /cvsroot/mhonarc/mharc/bin/mbox-month-pack,v
retrieving revision 1.3
retrieving revision 1.4
diff -C2 -r1.3 -r1.4
*** mbox-month-pack 13 Sep 2002 07:25:55 -0000 1.3
--- mbox-month-pack 15 Sep 2002 03:33:08 -0000 1.4
***************
*** 242,246 ****
This program is provided as part of mharc to provide the ability to
! import existing mailbox messages into mharc archives.
=head1 OPTIONS
--- 242,248 ----
This program is provided as part of mharc to provide the ability to
! import existing mailbox messages into mharc archives, or as a possible
! replacement for L<filter-spool|filter-spool> for sites that have
! alternate methods for managing incoming mail.
=head1 OPTIONS
***************
*** 290,295 ****
For example, if you run the program twice in a row like the following:
! shell> mbox-month-pack mail.mbx
! shell> mbox-month-pack mail.mbx
The resulting monthly mailbox files will contain two of each message.
--- 292,297 ----
For example, if you run the program twice in a row like the following:
! prompt> mbox-month-pack mail.mbx
! prompt> mbox-month-pack mail.mbx
The resulting monthly mailbox files will contain two of each message.
Index: mh-month-pack
===================================================================
RCS file: /cvsroot/mhonarc/mharc/bin/mh-month-pack,v
retrieving revision 1.3
retrieving revision 1.4
diff -C2 -r1.3 -r1.4
*** mh-month-pack 13 Sep 2002 07:25:55 -0000 1.3
--- mh-month-pack 15 Sep 2002 03:33:08 -0000 1.4
***************
*** 191,214 ****
messages will be appended to it.
! Each MH/nmh process will be annotated inorder to mark it that
! it has been processed by this program, unless the C<-noanno> option
! is specified. The annotation allows this program to reprocess folders
! multiple times and to skip messages that have been packed before.
!
! This program is provided as part of mharc to provide the ability to
! import MH/nmh messages into mharc archives. This program could be
! used for sites that have an existing MH/nmh filtering system inplace
! and want to usage mharc to generate web-based archives. This program
! can be used instead of C<filter-spool> to move incoming messages into
! the raw message archive before calling C<web-archive>.
=head1 OPTIONS
=over
=item C<-all>
! Force packing of all messages, if even if message is marked as
! already have been processed.
=item C<-debug>
--- 191,218 ----
messages will be appended to it.
! Each MH/nmh process will be annotated inorder to mark the message as
! having been processed, unless the C<-noanno> option is specified.
! The annotation allows this program to reprocess folders multiple
! times and to skip messages that have been packed before.
!
! This program is provided as part of mharc to provide the ability
! to import MH/nmh messages into mharc archives. This program could
! be used for sites that have an existing MH/nmh filtering system
! inplace and want to usage mharc to generate web-based archives.
! This program can be used instead of L<filter-spool|filter-spool> to
! move incoming messages into the raw message archive before calling
! L<web-archive|web-archive>.
=head1 OPTIONS
+ Any non-option argument is treated as an MH/nmh folder to process.
+ Folders are specified in the same manner as in MH/nmh commands.
+
=over
=item C<-all>
! Force packing of all messages, even if some messages are marked as
! processed.
=item C<-debug>
***************
*** 226,237 ****
=item C<-n>
! Just echo what would be done, but do not do it.
=item C<-noanno>
! Do not annotate message that it has been packed. By default, this
! program will annotate the message via the anno(1) command to mark
! the message that it has been processed. Therefore, if the folder
! is processed again in the future, the message will be skipped.
=item C<-outdir> I<directory>
--- 230,242 ----
=item C<-n>
! Just echo what would be done, but do not do it. This is handy
! to verify what will be done before actually doing it for real.
=item C<-noanno>
! Do not annotate messages that have been processed. By default, this
! program will annotate the messages via the anno(1) command to mark
! messages as being processed. Therefore, if the folder is processed
! again in the future, the message will be skipped.
=item C<-outdir> I<directory>
***************
*** 253,257 ****
This program requires that the following MH/nmh commands are in
! your search path: anno(1), folder(1), scan(1), packf(1).
=head1 LIMITATIONS
--- 258,262 ----
This program requires that the following MH/nmh commands are in
! your search path: C<anno(1)>, C<folder(1)>, C<scan(1)>, C<packf(1)>.
=head1 LIMITATIONS
Index: mhonarc-check
===================================================================
RCS file: /cvsroot/mhonarc/mharc/bin/mhonarc-check,v
retrieving revision 1.4
retrieving revision 1.5
diff -C2 -r1.4 -r1.5
*** mhonarc-check 13 Sep 2002 07:25:55 -0000 1.4
--- mhonarc-check 15 Sep 2002 03:33:08 -0000 1.5
***************
*** 74,78 ****
This program does a simple check to see that an installation of mharc
! can load the MHonArc libraries. If the check failed, the program
returns a non-zero exit status and prints out what can be done to
fix the problem.
--- 74,78 ----
This program does a simple check to see that an installation of mharc
! can load the MHonArc libraries. If the check fails, the program
returns a non-zero exit status and prints out what can be done to
fix the problem.
Index: mk-procmailrc
===================================================================
RCS file: /cvsroot/mhonarc/mharc/bin/mk-procmailrc,v
retrieving revision 1.17
retrieving revision 1.18
diff -C2 -r1.17 -r1.18
*** mk-procmailrc 13 Sep 2002 07:25:55 -0000 1.17
--- mk-procmailrc 15 Sep 2002 03:33:08 -0000 1.18
***************
*** 323,338 ****
=head1 DESCRIPTION
! This program is part of mharc, a web-based mail archiving system. This
! program has the responsibility of generating the main procmailrc
! used by the L<filter-spool|filter-spool> program. The procmailrc is generated
! from C<I<mharc-root>/lib/lists.def>.
! This program is typically invoked from calling C<make> from
the mharc root directory with configuration options specified
! in C<I<mharc-root>/lib/config.sh>.
=head1 LIST DEFINITION FILE
! The list definition file, C<I<mharc-root>/lib/lists.def>, is
read to generate the procmailrc used by L<filter-spool|filter-spool> to
filter messages into raw mail archives. The format of the file
--- 323,337 ----
=head1 DESCRIPTION
! This program is part of mharc and the responsibility of generating
! the main procmailrc used by the L<filter-spool|filter-spool> program.
! The procmailrc is generated from C<E<lt>mharc-rootE<gt>/lib/lists.def>.
! This program is typically invoked by calling C<make> from
the mharc root directory with configuration options specified
! in C<E<lt>mharc-rootE<gt>/lib/config.sh>.
=head1 LIST DEFINITION FILE
! The list definition file, C<E<lt>mharc-rootE<gt>/lib/lists.def>, is
read to generate the procmailrc used by L<filter-spool|filter-spool> to
filter messages into raw mail archives. The format of the file
***************
*** 382,389 ****
Mail address of the list. This option is an alternative to C<Address>
for cases where the list can only be donoted by the C<From: > field
! of the message. Some lists specify the C<To: > to be the actual
! subscribed address to the list instead of to the address of the
! list itself. This is fairly common for one-way lists like newsletters
! where subscribers receive list messages but cannot post to the list.
This option can be specified multiple times.
--- 381,388 ----
Mail address of the list. This option is an alternative to C<Address>
for cases where the list can only be donoted by the C<From: > field
! of the message. Some lists have the C<To: > to be the subscriber's
! address instead of to the list address. This is fairly common for
! one-way lists like newsletters where subscribers receive list messages
! but cannot post to the list.
This option can be specified multiple times.
***************
*** 408,413 ****
=item Description
! Brief description of list. This will be used as the title of archive
! index pages.
=item Final
--- 407,412 ----
=item Description
! Brief description of list. This will be used as the main title of
! archive index pages.
=item Final
***************
*** 437,451 ****
been customized to obscure address to prevent address harvesting.
! B<Note:> If this is the case, make sure to change the permission of
! the C<I<mharc-root>/mbox> directory so it is not readable by the
! HTTP server process so someone cannot backdoor into the raw archives.
! This is generally done by removing world read permission. Make sure
! the permission do allow for the mharc archiving system to read and
! write to the directory.
!
! You could also explicitly deny access to the directory via the HTTP
! server configuration file. This is the recommended approach since
! it gives you additional protection in case the C<I<mharc-root>/mbox>
! directory permissions are unintentionally changed to world readable.
=item No-Search
--- 436,451 ----
been customized to obscure address to prevent address harvesting.
! B<Note:> If this is the case, make sure to change the permission
! of the C<$MBOX_DIR/mbox/I<E<lt>list-nameE<gt>>> directory so it is
! not readable by the HTTP server process so someone cannot backdoor
! into the raw archives. This is generally done by removing world
! read permission. Make sure the permissions do allow for the mharc
! archiving system to read and write to the directory.
!
! You could also explicitly deny access to the directory via
! the HTTP server configuration file. This is the recommended
! approach since it gives you additional protection in case the
! C<$MBOX_DIR/mbox/I<E<lt>list-nameE<gt>>> directory permissions are
! unintentionally changed to world readable.
=item No-Search
***************
*** 482,486 ****
## In this definition, we define multiple addresses to check.
Name: mhonarc-users
! Description: MHonArc Mailing List
Address: mhonarc-users(_at_)mhonarc(_dot_)org
Address: mhonarc(_at_)ncsa(_dot_)uiuc(_dot_)edu
--- 482,486 ----
## In this definition, we define multiple addresses to check.
Name: mhonarc-users
! Description: MHonArc Users
Address: mhonarc-users(_at_)mhonarc(_dot_)org
Address: mhonarc(_at_)ncsa(_dot_)uiuc(_dot_)edu
***************
*** 491,495 ****
## pollute the discussion messages with cvs commit messages
Name: mhonarc-dev
! Description: MHonArc Development Mailing List
Address: mhonarc-dev(_at_)mhonarc(_dot_)org
CVS-Commits: 1
--- 491,495 ----
## pollute the discussion messages with cvs commit messages
Name: mhonarc-dev
! Description: MHonArc Development
Address: mhonarc-dev(_at_)mhonarc(_dot_)org
CVS-Commits: 1
***************
*** 516,520 ****
If specified, no I<catch> archive will be defined.
! B<Note:> Care should be used when using this option since any
message that does not match a normal rule will be lost.
--- 516,520 ----
If specified, no I<catch> archive will be defined.
! B<CAUTION:> Care should be used when using this option since any
message that does not match a normal rule will be lost.
***************
*** 590,598 ****
=over
! =item C<I<mharc-root>/lib/lists.def>
Mailing lists definition file.
! =item C<I<mharc-root>/lib/config.sh>
Main configuration file for mharc.
--- 590,598 ----
=over
! =item C<E<lt>mharc-rootE<gt>/lib/lists.def>
Mailing lists definition file.
! =item C<E<lt>mharc-rootE<gt>/lib/config.sh>
Main configuration file for mharc.
Index: read-mail
===================================================================
RCS file: /cvsroot/mhonarc/mharc/bin/read-mail,v
retrieving revision 1.9
retrieving revision 1.10
diff -C2 -r1.9 -r1.10
*** read-mail 13 Sep 2002 07:25:55 -0000 1.9
--- read-mail 15 Sep 2002 03:33:08 -0000 1.10
***************
*** 100,118 ****
=head1 DESCRIPTION
! This program is part of mharc, a web-based mail archiving system.
! This is the main program for archiving mail. It is generally
! called via cron.
! This program does very little itself, but it invokes other
! mharc scripts to do all the work.
! If the file C<.noarchive> exists in mharc root directory, then
! this program will do nothing and exit. This is to allow one
! to disable archiving while doing administrative tasks.
=head1 OPTIONS
This program is generally called without any command-line options
! since it will read C<I<mharc-root>/lib/config.sh> for any configurable
options. Regardless, the following command-line options are
available:
--- 100,118 ----
=head1 DESCRIPTION
! This program is part of mharc and is the main program for archiving
! mail. It is generally called via cron.
! This program does very little itself, but it invokes other mharc
! scripts to do all the work.
! If the file C<.noarchive> exists in mharc root directory, then this
! program will do nothing and exit (unless the C<-force> option is
! specified). This is to allow one to disable incoming mail processing
! while performing administrative tasks.
=head1 OPTIONS
This program is generally called without any command-line options
! since it will read C<E<lt>mharc-rootE<gt>/lib/config.sh> for any configurable
options. Regardless, the following command-line options are
available:
Index: web-archive
===================================================================
RCS file: /cvsroot/mhonarc/mharc/bin/web-archive,v
retrieving revision 1.34
retrieving revision 1.35
diff -C2 -r1.34 -r1.35
*** web-archive 13 Sep 2002 07:25:55 -0000 1.34
--- web-archive 15 Sep 2002 03:33:08 -0000 1.35
***************
*** 805,809 ****
=head1 NAME
! web-archive - Update/create MHonArc archives from mailbox archives
=head1 SYNOPSIS
--- 805,809 ----
=head1 NAME
! web-archive - Update/create MHonArc archives from mailbox archives.
=head1 SYNOPSIS
***************
*** 815,821 ****
=head1 DESCRIPTION
! This program is part of the auto-archiving system that works in
! conjuction with Procmail, Namazu, and a collection of shell and
! Perl programs. This program has the responsibility of processing
the mailbox archives created by the L<filter-spool|filter-spool> script to
update and/or create MHonArc archives.
--- 815,819 ----
=head1 DESCRIPTION
! This program is part of mharc and has the responsibility of processing
the mailbox archives created by the L<filter-spool|filter-spool> script to
update and/or create MHonArc archives.
***************
*** 825,829 ****
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 need to do selective archive
processing, any non-option related argument is treated as mailing
list archive name to process.
--- 823,827 ----
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.
***************
*** 1037,1041 ****
=head1 AUTHOR
! Earl Hood, mhonarc(_at_)mhonarc(_dot_)org
This program is part of the mharc archiving system and comes with
--- 1035,1039 ----
=head1 AUTHOR
! Earl Hood, earl(_at_)earlhood(_dot_)com
This program is part of the mharc archiving system and comes with
---------------------------------------------------------------------
To sign-off this list, send email to majordomo(_at_)mhonarc(_dot_)org with the
message text UNSUBSCRIBE MHONARC-DEV