--- rc.pod 2002/01/23 13:40:54 1.12
+++ rc.pod 2002/01/23 13:44:50 1.13
@@ -90,7 +90,7 @@
=over 4
-OSSP rc is a run command processor. It applies the script code associated with
+B<OSSP rc> is a generic 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
@@ -194,97 +194,6 @@
=back 4
-=head1 RETURN VALUE
-
-=over 4
-
-Returns zero if successful, or nonzero if otherwise.
-
-=back 4
-
-=head1 ERRORS
-
-=over 4
-
--1 Faulty run command hierarchy
- 0 Success
- 1 First (or only) run command failed
- 2 Second run command failed
- N Nth run command failed
-
-Positive error values are indexed to their respective run commands by command
-line ordering. For more information see `DIAGNOSTICS.'
-
-=back 4
-
-=head1 EXAMPLES
-
-Some short one line examples include the following. Note that a run command
-consists of a single program name and one or more sections. The wildcard `all'
-can be given in place of a program name to denote all programs with entries in
-the rc registry F<$OSSP_RC_ROOT/rc.d>.
-
- /usr/local/bin/rc --info
- /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 --silent ntpd start sync stop start
- /usr/local/bin/rc httpd restart
-
-To evaluate a run command for all programs with an identical section name, a
-short expression can be written into a F<.profile> file. When the shell
-initializes itself, the run commands will execute according to the C<eval>
-command. This is often seen when importing the environment of packages of an
-B<OpenPKG> hierarchy.
-
- $ eval `@l_prefix@/etc/rc --eval all env`
-
-=head1 ENVIRONMENT
-
-=over 4
-
-OSSP_RC_ROOT - Where the OSSP rc hierarchy is located
-OSSP_RC_OPTIONS - Options, same as the command line ones
-
-The environment determines where rc will look before beginning to process run
-commands. It also influences the behaviour, just as the command line options
-do. There is no difference between typing an option in the command line, and
-adding the same option to the OSSP_RC_OPTIONS variable.
-
-OSSP_RC_IMPLS - Other rc implementations
-
-The OSSP_RC_IMPLS variable plays a role only when the user has more than one
-logical set of run command sections. If rc reads anything but EOL in this
-variable, it will assume that more than one rc implementation exists. The
-variable should contain a chain of paths where other rc implementations are.
-This allows the user to build several OSSP rc hierarchies and then switch from
-each... Blah FIXME I don't know if we should be paying attention to the
-ENVIRONMENT guys. Maybe this is not a good solution for our dynamic OpenPKG
-environment problem after all.
-
-=back 4
-
-=head1 FILES
-
-=over 4
-
-/$OSSP_RC_ROOT/rc.conf - Configuration file
-
-=back 4
-
-=head1 SEE ALSO
-
-=over 4
-
-OSSP rc integrates concepts taken from other run command architectures. For
-more information, inspect the /etc/rc structures provided by FreeBSD, Solaris,
-and Red Hat distributions.
-
-biff(1), bagg(1), honk(1), gonk(1), and quatch(1).
-
-=back 4
-
=head1 NOTES
=over 4
@@ -348,18 +257,64 @@
=back 4
-=head1 WARNINGS
+=head1 ENVIRONMENT
=over 4
-There are no warnings. OSSP rc is perfect ;-)
+OSSP_RC_ROOT - Where the OSSP rc hierarchy is located
+OSSP_RC_OPTIONS - Options, same as the command line ones
+
+The environment determines where rc will look before beginning to process run
+commands. It also influences the behaviour, just as the command line options
+do. There is no difference between typing an option in the command line, and
+adding the same option to the OSSP_RC_OPTIONS variable.
+
+OSSP_RC_IMPLS - Other rc implementations
+
+The OSSP_RC_IMPLS variable plays a role only when the user has more than one
+logical set of run command sections. If rc reads anything but EOL in this
+variable, it will assume that more than one rc implementation exists. The
+variable should contain a chain of paths where other rc implementations are.
+This allows the user to build several OSSP rc hierarchies and then switch from
+each... Blah FIXME I don't know if we should be paying attention to the
+ENVIRONMENT guys. Maybe this is not a good solution for our dynamic OpenPKG
+environment problem after all.
=back 4
-=head1 DIAGNOSTICS
+=head1 FILES
=over 4
+/$OSSP_RC_ROOT/rc.conf - Configuration file
+
+=back 4
+
+=head1 EXAMPLES
+
+Some short one line examples include the following. Note that a run command
+consists of a single program name and one or more sections. The wildcard `all'
+can be given in place of a program name to denote all programs with entries in
+the rc registry F<$OSSP_RC_ROOT/rc.d>.
+
+ /usr/local/bin/rc --info
+ /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 --silent ntpd start sync stop start
+ /usr/local/bin/rc httpd restart
+
+To evaluate a run command for all programs with an identical section name, a
+short expression can be written into a F<.profile> file. When the shell
+initializes itself, the run commands will execute according to the C<eval>
+command. This is often seen when importing the environment of packages of an
+B<OpenPKG> hierarchy.
+
+ $ eval `@l_prefix@/etc/rc --eval all env`
+
+=head1 DIAGNOSTICS
+
The exit status is 0 if rc was able to initiate the given section code of the
given run command(s). If rc encountered an error during its processing, the
exit status is indexed to the first command parameter which failed as ordered
@@ -383,7 +338,11 @@
example. If the run command hierarchy is broken, no further action is taken
and no run commands are processed.
-=back 4
+=head1 SEE ALSO
+
+B<OSSP rc> integrates concepts taken from other run-command
+architectures. For more information, inspect the /etc/rc facilities
+provided by FreeBSD, NetBSD and Solaris.
=head1 AUTHORS
|
