--- rc.pod 2002/01/28 12:08:13 1.16
+++ rc.pod 2002/01/28 14:25:47 1.17
@@ -45,7 +45,7 @@
=item B<General>
@l_prefix@/etc/rc
-[B<-f>|B<--rcfile> I<file>]
+[B<-f>|B<--rcfile>]
[B<-d>|B<--rcdir> I<dir>[C<:>I<dir>[...]]
[B<-C>|B<--rcconf> I<file>[C<:>I<file>[...]]]
[B<-F>|B<--rcfunc> I<file>[C<:>I<file>[...]]]
@@ -53,7 +53,7 @@
[B<-r>|B<--raw>]
[B<-v>|B<--verbose>]
[B<-D>|B<--debug>]
-[I<command>]
+[I<rcfile>]
[I<command-options>]
[I<command-arguments>]
@@ -64,9 +64,9 @@
[B<-x>|B<--exec>]
[B<-p>|B<--print>]
[B<-e>|B<--eval>]
-I<package>
-I<command>
-[I<command> ...]
+I<rcfile>
+I<section>
+[I<section> ...]
=item B<Configuration Query>
@@ -96,24 +96,28 @@
=over 4
-OSSP rc is a run command processor. It applies the script code associated with
-one or more given section label to a given program. The program must have an
-entry in the form rc.<program> including script code grouped into sections. To
-help understand this file structure and how a section typically looks, an
-example called F<rc.example> is included in the distribution. OSSP rc
-references these command entries by reading the configuration file (see FILES)
-and searching the directory where the program entries reside.
-
-Each section of script code offers a type of functionality described by its
-section label. This label is the same one given on the command line after the
-desired program name. Only one program may be processed at a time, although
-many sections can be sourced with the same call to rc. An example of this is
-given in `EXAMPLES.'
-
-There exists one exception to this rule in which an rc keyword named `all' is
-reserved to mean `all programs.' The user may thus give the `all' wildcard in
-place of the C<program> parameter to process the given sections of all
-programs found.
+OSSP rc is a run command processor. It's primary function is to scan F<rcfile>
+script files for B<section>(s) identified by corresponding label(s) and run the
+commands in the section(s).
+
+The run command processor can also only print the commands without executing
+them or reformat them to C<eval> input. The F<rcfile> files contain variables
+and the command processor has functionality to query their default, set and
+effective values.
+
+To understand the structure and syntax of F<rcfile> script files, an example
+called F<rc.example> is included in the distribution. The rc environment and
+behaviour is very configurable, so the syntax may vary and not match exactly
+the example provided.
+
+With a single call to rc usually one F<rcfile> may be processed at, although
+many sections can be given to source their corresponding commands, see
+EXAMPLES below.
+
+There is one exception to this rule in which an rc keyword named `all' is
+reserved to mean `all F<rcfile>s.' The user may thus give the `all' wildcard
+in place of the C<rcfile> parameter to process the commands from the given
+sections of all C<rcfile>s found.
#THL! does "all stop start" mean "a stop stop, a start, b start" or " a stop,
#a start, b stop, b start"?
@@ -135,22 +139,25 @@
=item B<-c>, B<--config> F<file>
-specify the location of the configuration file,
-overriding the environment variable $OSSP_RC_CONFIG
-and the built-in hard-coded value (see DEFAULTS.)!FIXME!
+specify the location of the configuration file, overriding the environment
+variable $OSSP_RC_CONFIG and the built-in hard-coded value (see
+DEFAULTS.)!FIXME!
=item B<-n>, B<--func> F<file>[C<:>F<file>[...]]
-specify the location of an optional functions file,
-containing Bourne shell script code
-
-=item B<-f>, B<--file> F<file>
-
-use the configuration and section data of a particular file
+specify the location of one or more optional function files, containing
+commands which are prepended /FIXME append?/ to the sections of their corresponding
+C<rcfile>s.
+
+=item B<-f>, B<--file>
+
+Disable ${OSSP_RC_PREFIX} and ${OSSP_RC_SUFFIX} expansion on F<rcfile>.
+Disable searching for F<rcfile>. This mode assumes F<rcfile> is a filename. It
+is automagically entered when the F<rcfile> matches the regex '^\.{0,2}/'.
=item B<-d>, B<--dirs> I<dir>[C<:>I<dir>[...]
-override OSSP_RC_DIRS, and use these paths instead
+override OSSP_RC_DIRS, and use these paths to search for F<rcfile>s instead.
=item B<-t>, B<--tmpdir> I<dir>
@@ -188,24 +195,25 @@
=item B<-p>, B<--print>
-output the text as it would be interpreted
-by the shell, but do not run the commands
+output the commands as they would by seen by the command interpreter, but do
+not run them.
=item B<-e>, B<--eval>
-output the text for a command suitable for shell evaluation
+output the text for a command suitable for shell evaluation, but do not run
+it.
=item B<-x>, B<--exec>
-execute in subshell(s), will actually run the commands
+execute the command interpreter in a subprocess and actually run the commands.
=item B<-q>, B<--query>
-print the value(s) of rc configuration variables
+print the value(s) of rc configuration variables defined in the %config section.
=item B<-l>, B<--labels>
-learn what section labels a run command offers
+learn what section labels a F<rcfile> offers.
=item B<-i>, B<--info>
@@ -221,9 +229,9 @@
B<--silent>
The B<--help>, B<--version>, B<--verbose>, and B<--silent> options are used to
-control the screen output of B<rc>, but control the general output of all
-script code found in the F<rc.files> as well. For example, specifying
-B<--silent> will mute B<rc>'s output and also all script output that B<rc>
+control the screen output of B<rc> and control the general output of all
+sections found in the F<rcfile>s as well. For example, specifying
+B<--silent> will mute B<rc>'s output and also all command output that B<rc>
runs.
=item B<-t>, B<--tmpdir> I<dir>
@@ -264,9 +272,9 @@
The B<--query> option queries the I<effective> value of one or more
configuration variables. These variables are set in the C<%config> section of
-the corresponding F<rc.\<program\>> file. The B<--query> option reports the
-I<effective> value, and not necessarily that written in the F<rc.\<program\>>
-file, which can be overridden by variable settings in the F<rc.config> file.
+the corresponding F<rcfile>. The B<--query> option reports the
+I<effective> value, and not necessarily that written in the F<rcfile>
+file, which can be overridden by variable settings in the F<rc.env> file.
Used with the B<--query> option, B<rc> will expect exactly one command line
argument to follow. This must be a I<format> string containing arbitrary text
@@ -311,8 +319,8 @@
F<rc.conf>
F<rc.func>
-F<rc.config>
-F<rc.\<program\>>
+F<rc.env>
+F<rcfile>
#!FIXME! Kein mehr defaults, und sag so
=item B<-v>, B<--verbose>
@@ -404,8 +412,8 @@
=over 4
F<rc.func> - User defined functions file
-F<rc.config> - Postprocess variable declaration file
-F<rc.\<program\>> - Run command file
+F<rc.env> - Postprocess variable declaration file
+F<rc.\<rcfile\>> - Run command file
=back 4
@@ -419,7 +427,7 @@
more information, inspect the /etc/rc structures provided by FreeBSD, Solaris,
and Red Hat distributions.
-rc.conf(1), rc.func(1), rc.config(1), rc.program(1), and rc-sample(1).
+rc.conf(1), rc.func(1), rc.env(1), rcfile(1), and rc-sample(1).
=back 4
|
