--- loncom/metadata_database/searchcat.pl	2003/02/03 18:03:53	1.31
+++ loncom/metadata_database/searchcat.pl	2003/03/26 20:15:57	1.32
@@ -2,7 +2,7 @@
 # The LearningOnline Network
 # searchcat.pl "Search Catalog" batch script
 #
-# $Id: searchcat.pl,v 1.31 2003/02/03 18:03:53 harris41 Exp $
+# $Id: searchcat.pl,v 1.32 2003/03/26 20:15:57 www Exp $
 #
 # Copyright Michigan State University Board of Trustees
 #
@@ -27,10 +27,42 @@
 # http://www.lon-capa.org/
 #
 ###
+=pod
 
-# This script goes through a LON-CAPA resource
-# directory and gathers metadata.
-# The metadata is entered into a SQL database.
+=head1 NAME
+
+B<searchcat.pl> - put authoritative filesystem data into sql database.
+
+=head1 SYNOPSIS
+
+Ordinarily this script is to be called from a loncapa cron job
+(CVS source location: F<loncapa/loncom/cron/loncapa>; typical
+filesystem installation location: F</etc/cron.d/loncapa>).
+
+Here is the cron job entry.
+
+C<# Repopulate and refresh the metadata database used for the search catalog.>
+C<10 1 * * 7    www    /home/httpd/perl/searchcat.pl>
+
+This script only allows itself to be run as the user C<www>.
+
+=head1 DESCRIPTION
+
+This script goes through a loncapa resource directory and gathers metadata.
+The metadata is entered into a SQL database.
+
+This script also does general database maintenance such as reformatting
+the C<loncapa:metadata> table if it is deprecated.
+
+This script evaluates dynamic metadata from the authors'
+F<nohist_resevaldata.db> database file in order to store it in MySQL, as
+well as to compress the filesize (add up all "count"-type metadata).
+
+This script is playing an increasingly important role for a loncapa
+library server.  The proper operation of this script is critical for a smooth
+and correct user experience.
+
+=cut
 
 use lib '/home/httpd/lib/perl/';
 use LONCAPA::Configuration;