f5c5d4147f
- Fix formatting issues such as: - Use Ql instead of Dq Li as Li is deprecated - Address some mandoc warnings - Add arguments missing from the list of options (i.e., document "-k keep" instead of just "-k"). - Document that -k and -s can be specified multiple times - Use sshd instead of named for the example in the BUGS section, as named is not in the base system. Also, use Nm instead of Xr there as it is not the sshd binary that is required to be running, but the service. - Use Sy instead of Cm for KEYWORDS. Cm is reserved for command-line modifiers of the CLI. - Add an EXAMPLES section - Cross-reference service(8). MFC after: 2 weeks
232 lines
6.4 KiB
Groff
232 lines
6.4 KiB
Groff
.\" $NetBSD: rcorder.8,v 1.3 2000/07/17 14:16:22 mrg Exp $
|
|
.\"
|
|
.\" Copyright (c) 1998
|
|
.\" Perry E. Metzger. All rights reserved.
|
|
.\"
|
|
.\" Redistribution and use in source and binary forms, with or without
|
|
.\" modification, are permitted provided that the following conditions
|
|
.\" are met:
|
|
.\" 1. Redistributions of source code must retain the above copyright
|
|
.\" notice, this list of conditions and the following disclaimer.
|
|
.\" 2. Redistributions in binary form must reproduce the above copyright
|
|
.\" notice, this list of conditions and the following disclaimer in the
|
|
.\" documentation and/or other materials provided with the distribution.
|
|
.\" 3. All advertising materials mentioning features or use of this software
|
|
.\" must display the following acknowledgment:
|
|
.\" This product includes software developed for the NetBSD Project
|
|
.\" by Perry E. Metzger.
|
|
.\" 4. The name of the author may not be used to endorse or promote products
|
|
.\" derived from this software without specific prior written permission.
|
|
.\"
|
|
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
|
|
.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
|
|
.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
|
|
.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
|
|
.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
|
|
.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
|
.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
|
.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
|
.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
|
|
.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
|
.\"
|
|
.\" $FreeBSD$
|
|
.\"
|
|
.Dd June 22, 2020
|
|
.Dt RCORDER 8
|
|
.Os
|
|
.Sh NAME
|
|
.Nm rcorder
|
|
.Nd print a dependency ordering of interdependent files
|
|
.Sh SYNOPSIS
|
|
.Nm
|
|
.Op Fl k Ar keep
|
|
.Op Fl s Ar skip
|
|
.Ar
|
|
.Sh DESCRIPTION
|
|
The
|
|
.Nm
|
|
utility is designed to print out a dependency ordering of a set of
|
|
interdependent files.
|
|
Typically it is used to find an execution
|
|
sequence for a set of shell scripts in which certain files must be
|
|
executed before others.
|
|
.Pp
|
|
Each file passed to
|
|
.Nm
|
|
must be annotated with special lines (which look like comments to the
|
|
shell) which indicate the dependencies the files have upon certain
|
|
points in the sequence, known as
|
|
.Dq conditions ,
|
|
and which indicate, for each file, which
|
|
.Dq conditions
|
|
may be expected to be filled by that file.
|
|
.Pp
|
|
Within each file, a block containing a series of
|
|
.Ql REQUIRE ,
|
|
.Ql PROVIDE ,
|
|
.Ql BEFORE
|
|
and
|
|
.Ql KEYWORD
|
|
lines must appear.
|
|
The format of the lines is rigid.
|
|
Each line must begin with a single
|
|
.Ql # ,
|
|
followed by a single space, followed by
|
|
.Ql PROVIDE\&: ,
|
|
.Ql REQUIRE\&: ,
|
|
.Ql BEFORE\&: ,
|
|
or
|
|
.Ql KEYWORD\&: .
|
|
No deviation is permitted.
|
|
Each dependency line is then followed by a series of conditions,
|
|
separated by whitespace.
|
|
Multiple
|
|
.Ql PROVIDE ,
|
|
.Ql REQUIRE ,
|
|
.Ql BEFORE
|
|
and
|
|
.Ql KEYWORD
|
|
lines may appear, but all such lines must appear in a sequence without
|
|
any intervening lines, as once a line that does not follow the format
|
|
is reached, parsing stops.
|
|
.\" Note that for historical reasons REQUIRES, PROVIDES, and KEYWORDS
|
|
.\" are also accepted in addition to the above, but not documented so
|
|
.\" that they can be deprecated at some point in the future.
|
|
.Pp
|
|
The options are as follows:
|
|
.Bl -tag -width "-k keep"
|
|
.It Fl k Ar keep
|
|
Add the specified keyword to the
|
|
.Dq "keep list" .
|
|
If any
|
|
.Fl k
|
|
option is given, only those files containing the matching keyword are listed.
|
|
This option can be specified multiple times.
|
|
.It Fl s Ar skip
|
|
Add the specified keyword to the
|
|
.Dq "skip list" .
|
|
If any
|
|
.Fl s
|
|
option is given, files containing the matching keyword are not listed.
|
|
This option can be specified multiple times.
|
|
.El
|
|
.Pp
|
|
An example block follows:
|
|
.Bd -literal -offset indent
|
|
# REQUIRE: networking syslog
|
|
# REQUIRE: usr
|
|
# PROVIDE: dns nscd
|
|
.Ed
|
|
.Pp
|
|
This block states that the file in which it appears depends upon the
|
|
.Ql networking ,
|
|
.Ql syslog ,
|
|
and
|
|
.Ql usr
|
|
conditions, and provides the
|
|
.Ql dns
|
|
and
|
|
.Ql nscd
|
|
conditions.
|
|
.Pp
|
|
A file may contain zero
|
|
.Ql PROVIDE
|
|
lines, in which case it provides no conditions, and may contain zero
|
|
.Ql REQUIRE
|
|
lines, in which case it has no dependencies.
|
|
There must be at least one file with no dependencies in the set of
|
|
arguments passed to
|
|
.Nm
|
|
in order for it to find a starting place in the dependency ordering.
|
|
.Sh KEYWORDS
|
|
There are several
|
|
.Em KEYWORDs
|
|
in use:
|
|
.Bl -tag -width "shutdown" -offset indent
|
|
.It Sy firstboot , nojail , nojailvnet , nostart
|
|
Used by
|
|
.Xr rc 8 .
|
|
.It Sy resume
|
|
Used by
|
|
.Nm /etc/rc.resume
|
|
(see
|
|
.Xr acpiconf 8 )
|
|
.It Sy shutdown
|
|
Used by
|
|
.Xr rc.shutdown 8 .
|
|
.El
|
|
.Sh EXAMPLES
|
|
Print the dependency ordering of the services from the base system and
|
|
.Xr ports 7 :
|
|
.Bd -literal -offset indent
|
|
$ rcorder /etc/rc.d/* /usr/local/etc/rc.d/*
|
|
.Ed
|
|
.Pp
|
|
Count the number of services in the base system, which specify the
|
|
.Sy shutdown
|
|
keyword, while skipping those with
|
|
.Sy firstboot
|
|
and
|
|
.Sy nojailvnet :
|
|
.Bd -literal -offset indent
|
|
$ rcorder -k nostart -s firstboot -s nojailvnet /etc/rc.d/* | wc -l
|
|
3
|
|
.Ed
|
|
.Sh DIAGNOSTICS
|
|
The
|
|
.Nm
|
|
utility may print one of the following error messages and exit with a non-zero
|
|
status if it encounters an error while processing the file list.
|
|
.Bl -diag
|
|
.It "Requirement %s has no providers, aborting."
|
|
No file has a
|
|
.Ql PROVIDE
|
|
line corresponding to a condition present in a
|
|
.Ql REQUIRE
|
|
line in another file.
|
|
.It "Circular dependency on provision %s, aborting."
|
|
A set of files has a circular dependency which was detected while
|
|
processing the stated condition.
|
|
.It "Circular dependency on file %s, aborting."
|
|
A set of files has a circular dependency which was detected while
|
|
processing the stated file.
|
|
.El
|
|
.Sh SEE ALSO
|
|
.Xr acpiconf 8 ,
|
|
.Xr rc 8 ,
|
|
.Xr rc.shutdown 8 ,
|
|
.Xr service 8
|
|
.Sh HISTORY
|
|
The
|
|
.Nm
|
|
utility appeared in
|
|
.Nx 1.5 .
|
|
.Nm
|
|
utility first appeared in
|
|
.Fx 5.0 .
|
|
.Sh AUTHORS
|
|
.An -nosplit
|
|
Written by
|
|
.An Perry E. Metzger Aq Mt perry@piermont.com
|
|
and
|
|
.An Matthew R. Green Aq Mt mrg@eterna.com.au .
|
|
.Sh BUGS
|
|
The
|
|
.Ql REQUIRE
|
|
keyword is misleading:
|
|
It does not describe which daemons have to be running before a script
|
|
will be started.
|
|
It describes which scripts must be placed before it in
|
|
the dependency ordering.
|
|
For example,
|
|
if your script has a
|
|
.Ql REQUIRE
|
|
on
|
|
.Ql sshd ,
|
|
it means the script must be placed after the
|
|
.Ql sshd
|
|
script in the dependency ordering,
|
|
not necessarily that it requires
|
|
.Nm sshd
|
|
to be started or enabled.
|