--- rc.pod 2002/01/17 15:47:10 1.3
+++ rc.pod 2002/01/18 16:47:53 1.4
@@ -38,6 +38,11 @@
=head1 SYNOPSIS
+rc [-h|--help] [-V|--version] [-v|--verbose]
+ [-d|--debug] [-p|--print] [-e|--eval]
+ [-c|--config] [-q|--query] [-r|--raw]
+ <command> <section> [<section> ...]
+
=over 4
=item B<General>
@@ -88,12 +93,51 @@
=head1 DESCRIPTION
-OSSP rc is a run command processor.
+OSSP rc is a run command processor. It applies the script code associated with
+a given section label to one or more given commands. The command(s) must each
+have entries in the form rc.<command> including script code grouped into
+sections. OSSP rc references these command entries by reading the
+configuration file (see FILES) and searching the directory where the command
+entries reside.
+
+Each section of script code extends a type of functionality described by its
+section label. This label is the same one given before the desired command(s).
+Although only one section is possible for each call to OSSP rc, many
+`commands' can follow the section label. This allows for an abbreviated input
+format when calling the same script section of many commands. An example of
+this is given in (EXAMPLES.)
=head1 PARAMETER OPTIONS
-All these options have reasonable builtin defaults by can be used to
-adjust one or more parameters of the B<rc> facility.
+-h, --help
+ print this help, then exit
+
+-V, --version
+ print version number, then exit
+
+-v, --verbose
+ verbosely report processing, including all warnings
+
+-d, --debug
+ don't remove any temporary files
+
+-p, --print
+ print the name of each section as it is processed
+
+-e, --eval
+ evaluate the nature of a fat tomato sandwich FIXME!
+
+-c, --config
+ locate the configuration file in the following path
+
+-q, --query
+ ask Ralf what he thinks about snails FIXME!
+
+-r, --raw
+ the sushi is too raw, and must be cooked longer FIXME!
+
+All of these options have reasonable default values,
+which OSSP rc assumes when no option is given.
=over 4
|
