Index: ossp-pkg/rc/rc.pod RCS File: /v/ossp/cvs/ossp-pkg/rc/rc.pod,v rcsdiff -q -kk '-r1.16' '-r1.17' -u '/v/ossp/cvs/ossp-pkg/rc/rc.pod,v' 2>/dev/null --- 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 @l_prefix@/etc/rc -[B<-f>|B<--rcfile> I] +[B<-f>|B<--rcfile>] [B<-d>|B<--rcdir> I[C<:>I[...]] [B<-C>|B<--rcconf> I[C<:>I[...]]] [B<-F>|B<--rcfunc> I[C<:>I[...]]] @@ -53,7 +53,7 @@ [B<-r>|B<--raw>] [B<-v>|B<--verbose>] [B<-D>|B<--debug>] -[I] +[I] [I] [I] @@ -64,9 +64,9 @@ [B<-x>|B<--exec>] [B<-p>|B<--print>] [B<-e>|B<--eval>] -I -I -[I ...] +I +I
+[I
...] =item B @@ -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. including script code grouped into sections. To -help understand this file structure and how a section typically looks, an -example called F 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 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 +script files for B
(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 input. The F 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 script files, an example +called F 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 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 Fs.' The user may thus give the `all' wildcard +in place of the C parameter to process the commands from the given +sections of all Cs 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 -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[C<:>F[...]] -specify the location of an optional functions file, -containing Bourne shell script code - -=item B<-f>, B<--file> F - -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 +Cs. + +=item B<-f>, B<--file> + +Disable ${OSSP_RC_PREFIX} and ${OSSP_RC_SUFFIX} expansion on F. +Disable searching for F. This mode assumes F is a filename. It +is automagically entered when the F matches the regex '^\.{0,2}/'. =item B<-d>, B<--dirs> I[C<:>I[...] -override OSSP_RC_DIRS, and use these paths instead +override OSSP_RC_DIRS, and use these paths to search for Fs instead. =item B<-t>, B<--tmpdir> I @@ -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 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, but control the general output of all -script code found in the F as well. For example, specifying -B<--silent> will mute B's output and also all script output that B +control the screen output of B and control the general output of all +sections found in the Fs as well. For example, specifying +B<--silent> will mute B's output and also all command output that B runs. =item B<-t>, B<--tmpdir> I @@ -264,9 +272,9 @@ The B<--query> option queries the I value of one or more configuration variables. These variables are set in the C<%config> section of -the corresponding F> file. The B<--query> option reports the -I value, and not necessarily that written in the F> -file, which can be overridden by variable settings in the F file. +the corresponding F. The B<--query> option reports the +I value, and not necessarily that written in the F +file, which can be overridden by variable settings in the F file. Used with the B<--query> option, B will expect exactly one command line argument to follow. This must be a I string containing arbitrary text @@ -311,8 +319,8 @@ F F -F -F> +F +F #!FIXME! Kein mehr defaults, und sag so =item B<-v>, B<--verbose> @@ -404,8 +412,8 @@ =over 4 F - User defined functions file -F - Postprocess variable declaration file -F> - Run command file +F - Postprocess variable declaration file +F> - 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