sbin/rcorder/rcorder.8

   1 .\"     $NetBSD: rcorder.8,v 1.3 2000/07/17 14:16:22 mrg Exp $
   2 .\"
   3 .\" Copyright (c) 1998
   4 .\"     Perry E. Metzger.  All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   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.
  20 .\"
  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.
  31 .\"
  32 .\" $FreeBSD$
  33 .\"
  34 .Dd June 9, 2008
  35 .Dt RCORDER 8
  36 .Os
  37 .Sh NAME
  38 .Nm rcorder
  39 .Nd print a dependency ordering of interdependent files
  40 .Sh SYNOPSIS
  41 .Nm
  42 .Op Fl k Ar keep
  43 .Op Fl s Ar skip
  44 .Ar
  45 .Sh DESCRIPTION
  46 The
  47 .Nm
  48 utility is designed to print out a dependency ordering of a set of
  49 interdependent files.
  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.
  53 .Pp
  54 Each file passed to
  55 .Nm
  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
  59 .Dq conditions ,
  60 and which indicate, for each file, which
  61 .Dq conditions
  62 may be expected to be filled by that file.
  63 .Pp
  64 Within each file, a block containing a series of
  65 .Dq Li REQUIRE ,
  66 .Dq Li PROVIDE ,
  67 .Dq Li BEFORE
  68 and
  69 .Dq Li KEYWORD
  70 lines must appear.
  71 The format of the lines is rigid.
  72 Each line must begin with a single
  73 .Ql # ,
  74 followed by a single space, followed by
  75 .Dq Li PROVIDE: ,
  76 .Dq Li REQUIRE: ,
  77 .Dq Li BEFORE: ,
  78 or
  79 .Dq Li KEYWORD: .
  80 No deviation is permitted.
  81 Each dependency line is then followed by a series of conditions,
  82 separated by whitespace.
  83 Multiple
  84 .Dq Li PROVIDE ,
  85 .Dq Li REQUIRE ,
  86 .Dq Li BEFORE
  87 and
  88 .Dq Li KEYWORD
  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 .Pp
  93 The options are as follows:
  94 .Bl -tag -width indent
  95 .It Fl k
  96 Add the specified keyword to the
  97 .Dq "keep list" .
  98 If any
  99 .Fl k
 100 option is given, only those files containing the matching keyword are listed.
 101 .It Fl s
 102 Add the specified keyword to the
 103 .Dq "skip list" .
 104 If any
 105 .Fl s
 106 option is given, files containing the matching keyword are not listed.
 107 .El
 108 .Pp
 109 An example block follows:
 110 .Bd -literal -offset indent
 111 # REQUIRE: networking syslog
 112 # REQUIRE: usr
 113 # PROVIDE: dns nscd
 114 .Ed
 115 .Pp
 116 This block states that the file in which it appears depends upon the
 117 .Dq Li networking ,
 118 .Dq Li syslog ,
 119 and
 120 .Dq Li usr
 121 conditions, and provides the
 122 .Dq Li dns
 123 and
 124 .Dq Li nscd
 125 conditions.
 126 .Pp
 127 A file may contain zero
 128 .Dq Li PROVIDE
 129 lines, in which case it provides no conditions, and may contain zero
 130 .Dq Li REQUIRE
 131 lines, in which case it has no dependencies.
 132 There must be at least one file with no dependencies in the set of
 133 arguments passed to
 134 .Nm
 135 in order for it to find a starting place in the dependency ordering.
 136 .Sh DIAGNOSTICS
 137 The
 138 .Nm
 139 utility may print one of the following error messages and exit with a non-zero
 140 status if it encounters an error while processing the file list.
 141 .Bl -diag
 142 .It "Requirement %s has no providers, aborting."
 143 No file has a
 144 .Dq Li PROVIDE
 145 line corresponding to a condition present in a
 146 .Dq Li REQUIRE
 147 line in another file.
 148 .It "Circular dependency on provision %s, aborting."
 149 A set of files has a circular dependency which was detected while
 150 processing the stated condition.
 151 .It "Circular dependency on file %s, aborting."
 152 A set of files has a circular dependency which was detected while
 153 processing the stated file.
 154 .El
 155 .Sh BUGS
 156 The
 157 .Dq Li REQUIRE
 158 keyword is misleading:
 159 It doesn't describe which daemons have to be running before a script
 160 will be started.
 161 It describes which scripts must be placed before it in
 162 the dependency ordering.
 163 For example,
 164 if your script has a
 165 .Dq Li REQUIRE
 166 on
 167 .Dq Li named ,
 168 it means the script must be placed after the
 169 .Dq Li named
 170 script in the dependency ordering,
 171 not necessarily that it requires
 172 .Xr named 8
 173 to be started or enabled.
 174 .Sh SEE ALSO
 175 .Xr rc 8
 176 .Sh HISTORY
 177 The
 178 .Nm
 179 utility first appeared in
 180 .Nx 1.5 .
 181 .Sh AUTHORS
 182 .An -nosplit
 183 Written by
 184 .An Perry E. Metzger Aq perry@piermont.com
 185 and
 186 .An Matthew R. Green Aq mrg@eterna.com.au .