Add <sys/_null.h> for the definition of NULL:
[dragonfly.git] / sbin / rcrun / rcrun.8
blob110519949ab860965919cae21e4bc4d79e11ab50
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 .\" $DragonFly: src/sbin/rcrun/rcrun.8,v 1.1 2007/10/13 23:51:32 swildner Exp $
32 .\"
33 .Dd October 13, 2007
34 .Os
35 .Dt RCRUN 8
36 .Sh NAME
37 .Nm rcrun ,
38 .Nm rcstart ,
39 .Nm rcforce ,
40 .Nm rcfast ,
41 .Nm rcstop ,
42 .Nm rcrestart ,
43 .Nm rcvar ,
44 .Nm rcdisable ,
45 .Nm rcenable ,
46 .Nm rclist
47 .Nd rc script control utility
48 .Sh SYNOPSIS
49 .Nm rcrun
50 .Cm command Ar script ...
51 .Nm rcstart
52 .Ar script ...
53 .Nm rcforce
54 .Ar script ...
55 .Nm rcfast
56 .Ar script ...
57 .Nm rcstop
58 .Ar script ...
59 .Nm rcrestart
60 .Ar script ...
61 .Nm rcvar
62 .Ar script ...
63 .Nm rcdisable
64 .Ar script ...
65 .Nm rcenable
66 .Ar script ...
67 .Nm rclist
68 .Op Ar script ...
69 .Sh DESCRIPTION
70 The
71 .Nm
72 utility provides a number of commands for controlling
73 .Xr rc 8
74 scripts.
75 .Pp
76 The
77 .Cm start ,
78 .Cm forcestart ,
79 .Cm faststart ,
80 .Cm stop ,
81 .Cm restart ,
82 and
83 .Cm rcvar
84 commands are just passed to the scripts.
85 See
86 .Xr rc 8
87 for more information on these commands.
88 .Pp
89 The remaining commands are:
90 .Bl -tag -width ".Cm disable"
91 .It Cm disable
92 Sets the corresponding
93 .Va _enable
94 variable in
95 .Xr rc.conf 5
97 .Dq Li NO
98 and runs the
99 .Cm stop
100 command.
101 .It Cm enable
102 Sets the corresponding
103 .Va _enable
104 variable in
105 .Xr rc.conf 5
107 .Dq Li YES
108 and runs the
109 .Cm start
110 command.
111 .It Cm list
112 Shows the status of the specified scripts.
113 If no argument is specified, the status of all scripts is shown.
116 .Nm Rcstart ,
117 .Nm rcforce ,
118 .Nm rcfast ,
119 .Nm rcstop ,
120 .Nm rcrestart ,
121 .Nm rcvar ,
122 .Nm rcdisable ,
123 .Nm rcenable
125 .Nm rclist
126 are shortcuts for
127 .Nm Ap s
128 commands.
129 .Sh SEE ALSO
130 .Xr rc.conf 5 ,
131 .Xr rc 8
132 .Sh HISTORY
135 script first appeared in
136 .Dx 1.0 .
137 .Sh AUTHORS
138 .An Matt Dillon