--- rc.pod 2002/01/28 14:30:04 1.18
+++ rc.pod 2002/01/28 16:01:23 1.19
@@ -37,56 +37,62 @@
=over 4
-#rc [-h|--help] [-V|--version] [-v|--verbose]
-# [-d|--debug] [-p|--print] [-e|--eval]
-# [-c|--config] [-q|--query] [-r|--raw]
-# <command> <section> [<section> ...]
-
=item B<General>
@l_prefix@/etc/rc
-[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>[...]]]
-[B<-t>|B<--tmpdir> I<dir>]
+[B<-c>|B<--conf> I<file>[C<:>I<file>[...]]]
+[B<-t>|B<--tmp> I<dir>]
[B<-r>|B<--raw>]
[B<-v>|B<--verbose>]
[B<-D>|B<--debug>]
-[I<rcfile>]
-[I<command-options>]
-[I<command-arguments>]
=item B<Run-Command Execution>
@l_prefix@/etc/rc
-[I<parameter-options>]
+[I<General options>]
[B<-x>|B<--exec>]
[B<-p>|B<--print>]
[B<-e>|B<--eval>]
-I<rcfile>
+[B<-d>|B<--dirs> I<dir>[C<:>I<dir>[...]]
+[B<-f>|B<--func> I<file>[C<:>I<file>[...]]]
+[B<-F>|B<--force>]
+I<rcfile>
I<section>
[I<section> ...]
=item B<Configuration Query>
@l_prefix@/etc/rc
-[I<parameter-options>]
-[B<-q>|B<--query>]
-I<format>
-
-@l_prefix@/etc/rc
-[I<parameter-options>]
-[B<-c>|B<--config>]
-[I<package>]
+[I<General options>]
+B<-q>|B<--query> I<format>
+[B<-d>|B<--dirs> I<dir>[C<:>I<dir>[...]]
+[B<-F>|B<--force>]
+I<rcfile>
+
+=item B<Looking up available labels>
+
+[I<General options>]
+<-l>|<--labels>
+[B<-d>|B<--dirs> I<dir>[C<:>I<dir>[...]]
+[B<-F>|B<--force>]
+I<rcfile>
+
+# FIXME Ralf, what's that?
+# @l_prefix@/etc/rc
+# [I<parameter-options>]
+# [B<-c>|B<--conf>]
+# [I<package>]
-=item B<Facility Query>
+=item B<Facility Information>
@l_prefix@/etc/rc
-[I<parameter-options>]
+[I<General options>]
[B<-i>|B<--info>]
+=item B<Other>
+
@l_prefix@/etc/rc
+[B<-?>|B<--usage>]
[B<-h>|B<--help>]
[B<-V>|B<--version>]
@@ -137,19 +143,17 @@
Inclusive options which may be used with another
-=item B<-c>, B<--config> F<file>
+=item B<-c>, B<--conf> 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.
-=item B<-n>, B<--func> F<file>[C<:>F<file>[...]]
+=item B<-f>, B<--func> F<file>[C<:>F<file>[...]]
specify the location of one or more optional function files, containing
commands which are prepended to the sections of their corresponding
C<rcfile>s.
-=item B<-f>, B<--file>
+=item B<-F>, B<--force>
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
@@ -171,7 +175,7 @@
be silent, and disable output
-=item B<-d>, B<--debug>
+=item B<-D>, B<--debug>
don't remove temporary files, and output debug messages to stderr
@@ -189,6 +193,10 @@
print this help, then exit
+=item B<-?>, B<--usage>
+
+print short usage summary, then exit.
+
=item B<-V>, B<--version>
print version and copyright, then exit
@@ -234,16 +242,16 @@
B<--silent> will mute B<rc>'s output and also all command output that B<rc>
runs.
-=item B<-t>, B<--tmpdir> I<dir>
+=item B<-r>, B<--raw> I<dir>
The option B<-r> or B<--raw> turns on raw output mode. In this case, no
formatting is done to the screen output. This mode is different from formatted
output mode, in which the output is annotated with terminal control sequences
for better readability.
-=item B<-t>, B<--tmpdir> I<dir>
+=item B<-t>, B<--tmp> I<dir>
-Specifying the option B<--tmpdir> will force B<rc> to use the given temporary
+Specifying this option will force B<rc> to use the given temporary
directory I<dir> for all its temporary output.
=item B<-e>, B<--eval> and B<-p>, B<--print>
@@ -309,9 +317,13 @@
If neither B<--print>, B<--eval>, or B<-exec> is given B<rc> will default to
B<--exec>.
-=item B<-c>, B<--config> F<file>
-=item B<-n>, B<--func> F<file>[C<:>F<file>[...]]
-=item B<-f>, B<--file> F<file>
+=item B<-c>, B<--conf> F<file>
+
+Using F<file> from command line option -c aka --conf, fallback to
+${OSSP_RC_CONF}, fallback to "@l_prefix@/etc/rc.conf".
+
+=item B<-f>, B<--func> F<file>[C<:>F<file>[...]]
+=item B<-F>, B<--force>
=item B<-d>, B<--dirs> I<dir>[C<:>I<dir>[...]
#!FIXME! Sprech mal von Pfad und Dateien defaults wieviel rc.conf erlaubt
@@ -322,28 +334,18 @@
F<rc.env>
F<rcfile>
-#!FIXME! Kein mehr defaults, und sag so
-=item B<-v>, B<--verbose>
-=item B<-q>, B<--silent>
-=item B<-d>, B<--debug>
-=item B<-h>, B<--help>
-=item B<-V>, B<--version>
-=item B<-q>, B<--query>
-=item B<-l>, B<--labels>
-=item B<-i>, B<--info>
-
=head1 ENVIRONMENT
=over 4
-OSSP_RC_CONFIG - Where to find the F<rc.conf> file.
-OSSP_RC_DIRS - Where to find the F<rc.\<program\>> files.
-OSSP_RC_OPTIONS - Options, same as the command line ones
+Every command line longoption is also a keyword in the rc.conf file and,
+prefixed with "OSSP_RC_" and it's name in upper case, also available as an
+environment variable.
The environment determines where rc will search before beginning to process
run commands. It also influences B<rc's> behaviour, just as the command line
options do. There is no difference between typing an option in the command
-line, and appending the same option to the OSSP_RC_OPTIONS variable.
+line, and appending the same option to the OSSP_RC_OPTS variable.
#!FIXME! Study this and determine if it is needed
#OSSP_RC_IMPLS - Other rc implementations
@@ -382,7 +384,7 @@
/etc/rc --query lmtp2nntp
/mybin/rc sshd start
/etc/rc lmtp2nntp start
- /sfw/etc/rc --config /etc/rc.conf --debug smtpd stop
+ /sfw/etc/rc --conf /etc/rc.conf --debug smtpd stop
/sfw/etc/rc --silent ntpd start sync stop start
/usr/local/bin/rc httpd restart
|
