1 .\" $NetBSD: rcorder.8,v 1.3 2000/07/17 14:16:22 mrg Exp $
4 .\" Perry E. Metzger. All rights reserved.
6 .\" Redistribution and use in source and binary forms, with or without
7 .\" modification, are permitted provided that the following conditions
9 .\" 1. Redistributions of source code must retain the above copyright
10 .\" notice, this list of conditions and the following disclaimer.
11 .\" 2. Redistributions in binary form must reproduce the above copyright
12 .\" notice, this list of conditions and the following disclaimer in the
13 .\" documentation and/or other materials provided with the distribution.
14 .\" 3. All advertising materials mentioning features or use of this software
15 .\" must display the following acknowledgment:
16 .\" This product includes software developed for the NetBSD Project
17 .\" by Perry E. Metzger.
18 .\" 4. The name of the author may not be used to endorse or promote products
19 .\" derived from this software without specific prior written permission.
21 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
22 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
23 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
24 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
25 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
26 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
27 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
28 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
29 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
30 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
39 .Nd print a dependency ordering of interdependent files
48 utility is designed to print out a dependency ordering of a set of
50 Typically it is used to find an execution
51 sequence for a set of shell scripts in which certain files must be
52 executed before others.
56 must be annotated with special lines (which look like comments to the
57 shell) which indicate the dependencies the files have upon certain
58 points in the sequence, known as
60 and which indicate, for each file, which
62 may be expected to be filled by that file.
64 Within each file, a block containing a series of
71 The format of the lines is rigid.
72 Each line must begin with a single
74 followed by a single space, followed by
80 No deviation is permitted.
81 Each dependency line is then followed by a series of conditions,
82 separated by whitespace.
89 lines may appear, but all such lines must appear in a sequence without
90 any intervening lines, as once a line that does not follow the format
91 is reached, parsing stops.
92 .\" Note that for historical reasons REQUIRES, PROVIDES, and KEYWORDS
93 .\" are also accepted in addition to the above, but not documented so
94 .\" that they can be deprecated at some point in the future.
96 The options are as follows:
97 .Bl -tag -width indent
99 Add the specified keyword to the
103 option is given, only those files containing the matching keyword are listed.
105 Add the specified keyword to the
109 option is given, files containing the matching keyword are not listed.
112 An example block follows:
113 .Bd -literal -offset indent
114 # REQUIRE: networking syslog
119 This block states that the file in which it appears depends upon the
124 conditions, and provides the
130 A file may contain zero
132 lines, in which case it provides no conditions, and may contain zero
134 lines, in which case it has no dependencies.
135 There must be at least one file with no dependencies in the set of
138 in order for it to find a starting place in the dependency ordering.
143 .Bl -tag -width ".Cm shutdown" -offset indent
144 .It Cm firstboot, nojail, nojailvnet, nostart
159 utility may print one of the following error messages and exit with a non-zero
160 status if it encounters an error while processing the file list.
162 .It "Requirement %s has no providers, aborting."
165 line corresponding to a condition present in a
167 line in another file.
168 .It "Circular dependency on provision %s, aborting."
169 A set of files has a circular dependency which was detected while
170 processing the stated condition.
171 .It "Circular dependency on file %s, aborting."
172 A set of files has a circular dependency which was detected while
173 processing the stated file.
185 utility first appeared in
190 .An Perry E. Metzger Aq Mt perry@piermont.com
192 .An Matthew R. Green Aq Mt mrg@eterna.com.au .
196 keyword is misleading:
197 It does not describe which daemons have to be running before a script
199 It describes which scripts must be placed before it in
200 the dependency ordering.
206 it means the script must be placed after the
208 script in the dependency ordering,
209 not necessarily that it requires
211 to be started or enabled.