GC !__DragonFly__ section.
[dragonfly.git] / sbin / rcorder / rcorder.8
CommitLineData
9c600e7d 1.\" $NetBSD: rcorder.8,v 1.3 2000/07/17 14:16:22 mrg Exp $
ddb56f61 2.\" $DragonFly: src/sbin/rcorder/rcorder.8,v 1.2 2003/12/11 20:50:21 dillon Exp $
9c600e7d
MD
3.\"
4.\" Copyright (c) 1998
5.\" Perry E. Metzger. All rights reserved.
6.\"
7.\" Redistribution and use in source and binary forms, with or without
8.\" modification, are permitted provided that the following conditions
9.\" are met:
10.\" 1. Redistributions of source code must retain the above copyright
11.\" notice, this list of conditions and the following disclaimer.
12.\" 2. Redistributions in binary form must reproduce the above copyright
13.\" notice, this list of conditions and the following disclaimer in the
14.\" documentation and/or other materials provided with the distribution.
15.\" 3. All advertising materials mentioning features or use of this software
16.\" must display the following acknowledgment:
17.\" This product includes software developed for the NetBSD Project
18.\" by Perry E. Metzger.
19.\" 4. The name of the author may not be used to endorse or promote products
20.\" derived from this software without specific prior written permission.
21.\"
22.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
23.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
24.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
25.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
26.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
27.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
28.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
29.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
30.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
31.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32.\"
33.\" $FreeBSD: src/sbin/rcorder/rcorder.8,v 1.3 2002/11/25 16:23:03 ru Exp $
34.\"
35.Dd July 17, 2000
36.Dt RCORDER 8
37.Os
38.Sh NAME
39.Nm rcorder
40.Nd print a dependency ordering of interdependent files
41.Sh SYNOPSIS
42.Nm
43.Op Fl k Ar keep
44.Op Fl s Ar skip
ddb56f61 45.Op Fl o Ar resolve_for_file
9c600e7d
MD
46.Ar
47.Sh DESCRIPTION
48The
49.Nm
50utility is designed to print out a dependency ordering of a set of
51interdependent files.
52Typically it is used to find an execution
53sequence for a set of shell scripts in which certain files must be
54executed before others.
55.Pp
56Each file passed to
57.Nm
58must be annotated with special lines (which look like comments to the
59shell) which indicate the dependencies the files have upon certain
60points in the sequence, known as
61.Dq conditions ,
62and which indicate, for each file, which
63.Dq conditions
64may be expected to be filled by that file.
65.Pp
66Within each file, a block containing a series of
67.Dq Li REQUIRE ,
68.Dq Li PROVIDE ,
69.Dq Li BEFORE
70and
71.Dq Li KEYWORD
72lines must appear.
73The format of the lines is rigid.
74Each line must begin with a single
75.Ql # ,
76followed by a single space, followed by
77.Dq Li PROVIDE: ,
78.Dq Li REQUIRE: ,
79.Dq Li BEFORE: ,
80or
81.Dq Li KEYWORD: .
82No deviation is permitted.
83Each dependency line is then followed by a series of conditions,
84separated by whitespace.
85Multiple
86.Dq Li PROVIDE ,
87.Dq Li REQUIRE ,
88.Dq Li BEFORE
89and
90.Dq Li KEYWORD
91lines may appear, but all such lines must appear in a sequence without
92any intervening lines, as once a line that does not follow the format
93is reached, parsing stops.
94.Pp
95The options are as follows:
96.Bl -tag -width indent
97.It Fl k
98Add the specified keyword to the
99.Dq "keep list" .
100If any
101.Fl k
102option is given, only those files containing the matching keyword are listed.
103.It Fl s
104Add the specified keyword to the
105.Dq "skip list" .
106If any
107.Fl s
108option is given, files containing the matching keyword are not listed.
ddb56f61
MD
109.It Fl o
110Generate the dependancy list required to execute this file, including this
111file.
112If several
113.Fl o
114options are specified, the results are merged.
9c600e7d
MD
115.El
116.Pp
117 An example block follows:
118.Bd -literal -offset indent
119# REQUIRE: networking syslog
120# REQUIRE: usr
121# PROVIDE: dns nscd
122.Ed
123.Pp
124This block states that the file in which it appears depends upon the
125.Dq Li networking ,
126.Dq Li syslog ,
127and
128.Dq Li usr
129conditions, and provides the
130.Dq Li dns
131and
132.Dq Li nscd
133conditions.
134.Pp
135A file may contain zero
136.Dq Li PROVIDE
137lines, in which case it provides no conditions, and may contain zero
138.Dq Li REQUIRE
139lines, in which case it has no dependencies.
140There must be at least one file with no dependencies in the set of
141arguments passed to
142.Nm
143in order for it to find a starting place in the dependency ordering.
144.Sh DIAGNOSTICS
145The
146.Nm
147utility may print one of the following error messages and exit with a non-zero
148status if it encounters an error while processing the file list.
149.Bl -diag
150.It "Requirement %s has no providers, aborting."
151No file has a
152.Dq Li PROVIDE
153line corresponding to a condition present in a
154.Dq Li REQUIRE
155line in another file.
156.It "Circular dependency on provision %s, aborting."
157A set of files has a circular dependency which was detected while
158processing the stated condition.
159.It "Circular dependency on file %s, aborting."
160A set of files has a circular dependency which was detected while
161processing the stated file.
162.El
163.Sh SEE ALSO
164.Xr rc 8
165.Sh HISTORY
166The
167.Nm
168utility first appeared in
169.Nx 1.5 .
170.Sh AUTHORS
171.An -nosplit
172Written by
173.An Perry E. Metzger Aq perry@piermont.com
174and
175.An Matthew R. Green Aq mrg@eterna.com.au .