Changeset 1970


Ignore:
Timestamp:
2001-02-14T12:48:56+13:00 (23 years ago)
Author:
sjboddie
Message:

Added more usage information to all perl programs and removed a few
programs that are no longer useful.

Location:
trunk/gsdl/bin/script
Files:
6 deleted
20 edited

Legend:

Unmodified
Added
Removed

  • trunk/gsdl/bin/script/build

    r1778 r1970  
    135135
    136136sub print_usage {
    137     print STDERR "\n  usage: $0 [options] collection-name\n\n";
     137    print STDERR "\n";
     138    print STDERR "build: Builds a Greenstone collection (i.e. runs import.pl and buildcol.pl\n";
     139    print STDERR "       then copies the resulting indexes to the correct place).\n\n";
     140    print STDERR "  usage: $0 [options] collection-name\n\n";
    138141    print STDERR "  options:\n";
    139142    print STDERR "   -optionfile file        Get options from file, useful on systems where\n";

  • trunk/gsdl/bin/script/buildcol.pl

    r1853 r1970  
    4444
    4545sub print_usage {
    46     print STDERR "\n  usage: $0 [options] collection-name\n\n";
     46    print STDERR "\n";
     47    print STDERR "buildcol.pl: Builds the indexes of a Greenstone collection.\n\n";
     48    print STDERR "  usage: $0 [options] collection-name\n\n";
    4749    print STDERR "  options:\n";
    4850    print STDERR "   -verbosity number     0=none, 3=lots\n";
    … …  
    6567    print STDERR "   -out                  Filename or handle to print output status to.\n";
    6668    print STDERR "                         The default is STDERR\n";
    67     print STDERR "   -buildtype mg|mgpp    THis will override the config file setting. (default is mg)\n";
    68     print STDERR "   -no_strip_html        Do not strip the html tags from the indexed text (only used for mgpp collections).\n\n";
     69    print STDERR "   -buildtype mg|mgpp    This will override the config file setting.\n";
     70    print STDERR "                         (default is mg)\n";
     71    print STDERR "   -no_strip_html        Do not strip the html tags from the indexed text\n";
     72    print STDERR "                         (only used for mgpp collections).\n\n";
    6973}
    7074

  • trunk/gsdl/bin/script/cancel_build.pl

    r1461 r1970  
    4747
    4848sub print_usage {
    49     print STDERR "\n  usage: $0 [options] collection-name\n\n";
     49    print STDERR "\n";
     50    print STDERR "cancel_build.pl: Cancel a build in progress. This script is\n";
     51    print STDERR "                 called from the collector and is not intended\n";
     52    print STDERR "                 for general use.\n\n";
     53    print STDERR "  usage: $0 [options] collection-name\n\n";
    5054    print STDERR "  options:\n";
    5155    print STDERR "   -collectdir directory  Collection directory (defaults to " .

  • trunk/gsdl/bin/script/classinfo.pl

    r1885 r1970  
    4141
    4242sub print_usage {
    43     print STDERR "
    44   usage: $0 [options] classifier
    45 
    46   options:
    47    -collect collection-name  Giving a collection name will make
    48                              classinfo.pl look in
    49                              collect/collection-name/perllib/classify
    50                              first. If it doesn't find it there it will
    51                              look in the general perllib/classify directory.
    52 
    53 ";
     43    print STDERR "\n";
     44    print STDERR "classinfo.pl: Prints information about a classifier.\n\n";
     45    print STDERR "  usage: $0 [options] classifier\n\n";
     46    print STDERR "  options:\n";
     47    print STDERR "   -collect collection-name  Giving a collection name will make\n";
     48    print STDERR "         classinfo.pl look in collect/collection-name/perllib/classify\n";
     49    print STDERR "         first. If it doesn't find it there it will look in the general\n";
     50    print STDERR "         perllib/classify directory.\n\n";
    5451}
    55 
    5652
    5753&main ();

  • trunk/gsdl/bin/script/cleantmp.pl

    r1461 r1970  
    3939
    4040sub print_usage {
     41    print STDERR "\n";
     42    print STDERR "cleantmp.pl: Cleans up the Greenstone tmp directory by deleting anything\n";
     43    print STDERR "             more than -expire_days days old.\n\n";
    4144    print STDERR "\n  usage: $0 [options]\n\n";
    42     print STDERR "  oprions:\n";
     45    print STDERR "  options:\n";
    4346    print STDERR "   -expire_days number   The number of days old information in the tmp\n";
    4447    print STDERR "                         directory must be before it is removed (defaults\n";

  • trunk/gsdl/bin/script/create_distributions.pl

    r1934 r1970  
    6464
    6565sub print_usage {
    66     print STDERR "\n  usage: $0 [options]\n\n";
     66    print STDERR "\n";
     67    print STDERR "create_distributions.pl: Packages up Greenstone distributions.\n\n";
     68    print STDERR "  usage: $0 [options]\n\n";
    6769    print STDERR "  options:\n";
    6870    print STDERR "   -version_num           version number of distribution (x.xx)\n";

  • trunk/gsdl/bin/script/delcol.pl

    r1452 r1970  
    3535
    3636sub print_usage {
    37     print STDERR "\n  usage: $0 [options] collection-name\n\n";
     37    print STDERR "\n";
     38    print STDERR "delcol.pl: Deletes (forever) a collection.\n\n";
     39    print STDERR "  usage: $0 [options] collection-name\n\n";
    3840    print STDERR "  options:\n";
    3941    print STDERR "   -f                     Force deletion of collection without prompting\n\n";

  • trunk/gsdl/bin/script/filecopy.pl

    r1485 r1970  
    4040
    4141sub print_usage {
     42    print STDERR "\n";
     43    print STDERR "filecopy.pl: Recursively copies files into a collections import directory.\n\n";
    4244    print STDERR "\n  usage: $0 [options] [directories] collection-name\n\n";
    4345
    … …  
    4547    print STDERR "   -collectdir directory   Collection directory (defaults to " .
    4648    &util::filename_cat ($ENV{'GSDLHOME'}, "collect") . ")\n";
    47     print STDERR "   -out                  Filename or handle to print output status to.\n";
    48     print STDERR "                         The default is STDERR\n\n";
     49    print STDERR "   -out                    Filename or handle to print output status to.\n";
     50    print STDERR "                           The default is STDERR\n\n";
    4951}
    5052

  • trunk/gsdl/bin/script/gsConvert.pl

    r1960 r1970  
    4949sub print_usage
    5050{
    51     print STDERR "Usage: $0 [options] filename\n";
    52     print STDERR "Options are:\n\t-type\tdoc|pdf\n\t-output\thtml|text\n";
     51    print STDERR "\n";
     52    print STDERR "gsConvert.pl: Converts documents in a range of formats to html\n";
     53    print STDERR "              or text using third-party programs.\n\n";
     54    print STDERR "  usage: $0 [options] filename\n";
     55    print STDERR "  options:\n\t-type\tdoc|pdf\n\t-output\thtml|text\n";
    5356    print STDERR "\t-timeout\t<max cpu seconds>\n";
    5457    exit(1);

  • trunk/gsdl/bin/script/gsdlinfo.pl

    r1665 r1970  
    3636use parsargv;
    3737use colcfg;
     38
     39if (scalar(@ARGV) && $ARGV[0] eq "--help") {
     40    print STDERR "\n";
     41    print STDERR "gsdlinfo.pl: Prints information on any Greenstone collections\n";
     42    print STDERR "             found on the local file system.\n\n";
     43    exit;
     44}
    3845
    3946

  • trunk/gsdl/bin/script/import.pl

    r1587 r1970  
    4848
    4949sub print_usage {
    50     print STDERR "\n  usage: $0 [options] collection-name\n\n";
     50    print STDERR "\n";
     51    print STDERR "import.pl: Converts documents in collections -importdir directory into\n";
     52    print STDERR "           gml documents which are written to the -archivedir directory.\n\n";
     53    print STDERR "  usage: $0 [options] collection-name\n\n";
    5154    print STDERR "  options:\n";
    5255    print STDERR "   -verbosity number      0=none, 3=lots\n";

  • trunk/gsdl/bin/script/makemapfile.pl

    r1870 r1970  
    6767
    6868sub print_usage {
    69     print STDERR "\n  usage: $0 [options]\n\n";
     69    print STDERR "\n";
     70    print STDERR "makemapfile.pl: Creates unicode map (.ump) files from plain\n";
     71    print STDERR "                text code pages.\n\n";
     72    print STDERR "  usage: $0 [options]\n\n";
    7073    print STDERR "  options:\n";
    7174    print STDERR "   -encoding name\n";
    72     print STDERR "   -mapfile  text file from which to create binary\n\n";
     75    print STDERR "   -mapfile  text file from which to create binary ump file\n\n";
    7376}
    7477

  • trunk/gsdl/bin/script/mirror.pl

    r1533 r1970  
    3737#
    3838# To use w3mirror, the configuration file must be in etc/w3mir.cfg.
    39 # To use GNU wget, the configuartion file (i.e. a wgetrc file) must
     39# To use GNU wget, the configuration file (i.e. a wgetrc file) must
    4040# be in etc/wget.cfg and a file of the URLs to read in etc/wget.url
    4141
    … …  
    5757
    5858sub print_usage {
    59     print STDERR "\n  usage: $0 [options] collection-name\n\n";
     59    print STDERR "\n";
     60    print STDERR "mirror.pl: Uses w3mir or wget to sync a collections import data\n";
     61    print STDERR "           with a website.\n\n";
     62    print STDERR "  usage: $0 [options] collection-name\n\n";
    6063    print STDERR "  options:\n";
    6164    print STDERR "   -verbosity number      0=none, 3=lots\n";

  • trunk/gsdl/bin/script/mkcol.pl

    r1780 r1970  
    4343
    4444sub print_usage {
    45     print STDERR "\n  usage: $0 [options] collection-name\n\n";
     45    print STDERR "\n";
     46    print STDERR "mkcol.pl: Creates the directory structure for a new\n";
     47    print STDERR "          Greenstone collection.\n\n";
     48    print STDERR "  usage: $0 [options] collection-name\n\n";
    4649    print STDERR "  options:\n";
    4750    print STDERR "   -optionfile file    Get options from file, useful on systems where\n";

  • trunk/gsdl/bin/script/nightly.pl

    r1378 r1970  
    2828
    2929
    30 # This program will find all thecollections under $GSDLHOME/collect
     30# This program will find all the collections under $GSDLHOME/collect
    3131# and use the update.pl script to update them all.  It should be run
    3232# every night to keep mirror collections up-to-date.
    … …  
    5050
    5151sub print_usage {
    52     print STDERR "\n  usage: $0 [options]\n\n";
     52    print STDERR "\n";
     53    print STDERR "nightly.pl: Attempts to update all Greenstone collections found on\n";
     54    print STDERR "            the local filesystem by calling update.pl for each of\n";
     55    print STDERR "            them.\n\n";
     56    print STDERR "  usage: $0 [options]\n\n";
    5357    print STDERR "  options:\n";
    5458    print STDERR "   -verbosity number      0=none, 3=lots\n";
    … …  
    100104
    101105}
    102 
    103 
    104 
    105 
    106 

  • trunk/gsdl/bin/script/pluginfo.pl

    r1244 r1970  
    4242
    4343sub print_usage {
    44     print STDERR "\n  usage: $0 [options] plugin\n\n";
     44    print STDERR "\n";
     45    print STDERR "pluginfo.pl: Prints information about a plugin.\n\n";
     46    print STDERR "  usage: $0 [options] plugin\n\n";
    4547    print STDERR "  options:\n";
    4648    print STDERR "   -collect collection-name  Giving a collection name will make pluginfo.pl\n";

  • trunk/gsdl/bin/script/sendmail.pl

    r1777 r1970  
    4848             'smtp/.*', \$smtp,
    4949             'msgfile/.*/', \$msgfile)) {
    50     print STDERR "\n  usage: $0 [options]\n\n";
     50    print STDERR "\n";
     51    print STDERR "sendmail.pl: A simple platform independant mail sending program.\n\n";
     52    print STDERR "  usage: $0 [options]\n\n";
    5153    print STDERR "  options:\n";
    5254    print STDERR "   -to addr      Comma separated list of mail recipients\n";

  • trunk/gsdl/bin/script/translate.pl

    r1926 r1970  
    9292
    9393sub print_usage {
    94     print STDERR "\n  usage: $0 [options] macrofile\n\n";
     94    print STDERR "\n";
     95    print STDERR "translate.pl: Uses gimp to generate any images required by a\n";
     96    print STDERR "              Greenstone macro file.\n\n";
     97    print STDERR "  usage: $0 [options] macrofile\n\n";
    9598    print STDERR "  options:\n";
    9699    print STDERR "   -save_orig_file       edited macrofile will be written to\n";

  • trunk/gsdl/bin/script/unindex.pl

    r1666 r1970  
    5959
    6060sub print_usage {
    61     print STDERR "\n  usage: $0 [options]\n\n";
     61    print STDERR "\n";
     62    print STDERR "unindex.pl: Attempts to generate gml files from a built Greenstone index.\n\n";
     63    print STDERR "  usage: $0 [options]\n\n";
    6264    print STDERR "  options:\n";
    6365    print STDERR "   -verbosity number      0=none, 3=lots\n";

  • trunk/gsdl/bin/script/update.pl

    r1533 r1970  
    5555
    5656sub print_usage {
    57     print STDERR "\n  usage: $0 [options] collection-name\n\n";
     57    print STDERR "\n";
     58    print STDERR "update.pl: Updates a collection if it has been set up to mirror\n";
     59    print STDERR "           a website. Calls mirror.pl to do the mirroring.\n\n";
     60    print STDERR "  usage: $0 [options] collection-name\n\n";
    5861    print STDERR "  options:\n";
    5962    print STDERR "   -verbosity number      0=none, 3=lots\n";
Note: See TracChangeset for help on using the changeset viewer.