manpages: Uniformly order the prologue macros by Dd/Dt/Os.
[dragonfly.git] / sbin / rcrun / rcrun.8
1 .\"
2 .\" Copyright (c) 2007 The DragonFly Project.  All rights reserved.
3 .\"
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
6 .\" are met:
7 .\"
8 .\" 1. Redistributions of source code must retain the above copyright
9 .\"    notice, this list of conditions and the following disclaimer.
10 .\" 2. Redistributions in binary form must reproduce the above copyright
11 .\"    notice, this list of conditions and the following disclaimer in
12 .\"    the documentation and/or other materials provided with the
13 .\"    distribution.
14 .\" 3. Neither the name of The DragonFly Project nor the names of its
15 .\"    contributors may be used to endorse or promote products derived
16 .\"    from this software without specific, prior written permission.
17 .\"
18 .\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20 .\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
21 .\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
22 .\" COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
23 .\" INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
24 .\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
25 .\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
26 .\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
27 .\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
28 .\" OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 .\" SUCH DAMAGE.
30 .\"
31 .Dd October 13, 2007
32 .Dt RCRUN 8
33 .Os
34 .Sh NAME
35 .Nm rcrun ,
36 .Nm rcstart ,
37 .Nm rcforce ,
38 .Nm rcfast ,
39 .Nm rcstop ,
40 .Nm rcrestart ,
41 .Nm rcvar ,
42 .Nm rcdisable ,
43 .Nm rcenable ,
44 .Nm rclist
45 .Nd rc script control utility
46 .Sh SYNOPSIS
47 .Nm rcrun
48 .Cm command Ar script ...
49 .Nm rcstart
50 .Ar script ...
51 .Nm rcforce
52 .Ar script ...
53 .Nm rcfast
54 .Ar script ...
55 .Nm rcstop
56 .Ar script ...
57 .Nm rcrestart
58 .Ar script ...
59 .Nm rcvar
60 .Ar script ...
61 .Nm rcdisable
62 .Ar script ...
63 .Nm rcenable
64 .Ar script ...
65 .Nm rclist
66 .Op Ar script ...
67 .Sh DESCRIPTION
68 The
69 .Nm
70 utility provides a number of commands for controlling
71 .Xr rc 8
72 scripts.
73 .Pp
74 The
75 .Cm start ,
76 .Cm forcestart ,
77 .Cm faststart ,
78 .Cm stop ,
79 .Cm restart ,
80 and
81 .Cm rcvar
82 commands are just passed to the scripts.
83 See
84 .Xr rc 8
85 for more information on these commands.
86 .Pp
87 The remaining commands are:
88 .Bl -tag -width ".Cm disable"
89 .It Cm disable
90 Sets the corresponding
91 .Va _enable
92 variable in
93 .Xr rc.conf 5
94 to
95 .Dq Li NO
96 and runs the
97 .Cm stop
98 command.
99 .It Cm enable
100 Sets the corresponding
101 .Va _enable
102 variable in
103 .Xr rc.conf 5
104 to
105 .Dq Li YES
106 and runs the
107 .Cm start
108 command.
109 .It Cm list
110 Shows the status of the specified scripts.
111 If no argument is specified, the status of all scripts is shown.
112 .El
113 .Pp
114 .Nm Rcstart ,
115 .Nm rcforce ,
116 .Nm rcfast ,
117 .Nm rcstop ,
118 .Nm rcrestart ,
119 .Nm rcvar ,
120 .Nm rcdisable ,
121 .Nm rcenable
122 and
123 .Nm rclist
124 are shortcuts for
125 .Nm Ap s
126 commands.
127 .Sh SEE ALSO
128 .Xr rc.conf 5 ,
129 .Xr rc 8
130 .Sh HISTORY
131 The
132 .Nm
133 script first appeared in
134 .Dx 1.0 .
135 .Sh AUTHORS
136 .An Matt Dillon