1 .\" Copyright (c) 1980, 1991, 1993
2 .\" The Regents of the University of California. All rights reserved.
4 .\" Portions of this manual page are Copyrighted by
5 .\" The NetBSD Foundation.
7 .\" Redistribution and use in source and binary forms, with or without
8 .\" modification, are permitted provided that the following conditions
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 acknowledgement:
17 .\" This product includes software developed by the University of
18 .\" California, Berkeley and its contributors.
19 .\" 4. Neither the name of the University nor the names of its contributors
20 .\" may be used to endorse or promote products derived from this software
21 .\" without specific prior written permission.
23 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
24 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
27 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
35 .\" @(#)rc.8 8.2 (Berkeley) 12/11/93
43 .Nd command scripts for auto-reboot and daemon startup
56 utility is the command script which controls the automatic boot process
61 script contains commands which are pertinent only
64 .Pa /usr/local/etc/rc.d/
65 mechanism is used instead of
70 it is still supported.
71 In this case, it should source
73 and contain additional custom startup code for your system.
74 The best way to handle
76 however, is to separate it out into
78 style scripts and place them under
79 .Pa /usr/local/etc/rc.d/ .
82 file contains the global system configuration information referenced
83 by the startup scripts, while
85 contains the local system configuration.
92 directories contain scripts which will be automatically
93 executed at boot time and shutdown time.
95 The sysrc(8) command provides a scripting interface to modify system
101 .Va autoboot Ns = Ns Li yes
103 .Pq Va rc_fast Ns = Ns Li yes ,
106 scripts from performing the check for already running processes
107 (thus speeding up the boot process).
109 .Va rc_fast Ns = Ns Li yes
110 speedup will not occur when
112 is started up after exiting the single-user shell.
114 Determine whether the system is booting diskless,
116 .Pa /etc/rc.initdiskless
123 shell functions to use.
125 Load the configuration files.
127 Determine if booting in a jail,
130 (no jails allowed) or
132 (only allow vnet-enabled jails) to the list of KEYWORDS to skip in
136 .Va ${firstboot_sentinel}
139 to the list of KEYWORDS to skip in
144 to order the files in
153 Call each script in turn using
161 and sources the script in a subshell.
164 suffix then it is sourced directly into the current shell.
165 Stop processing when the script that is the value of the
166 .Va $early_late_divider
169 Check again to see if the file
170 .Va ${firstboot_sentinel}
171 exists (in case it is located on a newly mounted file system)
172 and adjust the list of KEYWORDs to skip appropriately.
176 this time including the scripts in the
179 Ignore everything up to the
180 .Va $early_late_divider ,
181 then start executing the scripts as described above.
184 .Va ${firstboot_sentinel}
187 .Va ${firstboot_sentinel}-reboot
188 also exists (because it was created by a script), then delete it and reboot.
190 .Ss Operation of Nm rc.shutdown
197 shell functions to use.
199 Load the configuration files.
203 to order the files in
214 reverse that order, and assign the result to a variable.
216 Call each script in turn using
224 and sources the script in a subshell.
227 suffix then it is sourced directly into the current shell.
229 .Ss Contents of Nm rc.d/
233 The following file naming conventions are currently used in
235 .Bl -tag -width ".Pa ALLUPPERCASE" -offset indent
239 to ensure that certain operations are performed before others.
240 In order of startup, these are:
241 .Bl -tag -width ".Pa NETWORKING"
243 Ensure basic network services are running, including general
244 network configuration.
246 Ensure basic services
247 exist for services that start early (such as
249 because they are required by
253 Check-point before all general purpose daemons such as
258 Check-point before user login services
262 as well as services which might run commands as users
268 Scripts that are to be sourced into the current shell rather than a subshell
272 Extreme care must be taken in using this, as the startup sequence will
273 terminate if the script does.
275 Scripts that are sourced in a subshell.
276 The boot does not stop if such a script terminates with a non-zero status,
277 but a script can stop the boot if necessary by invoking the
283 Each script should contain
285 keywords, especially an appropriate
287 entry, and if necessary
293 Each script is expected to support at least the following arguments, which
294 are automatically supported if it uses the
297 .Bl -tag -width ".Cm restart" -offset indent
300 This should check that the service is to be started as specified by
302 Also checks if the service is already running and refuses to start if
304 This latter check is not performed by standard
306 scripts if the system is starting directly to multi-user mode, to
307 speed up the boot process.
312 check and start anyway.
314 If the service is to be started as specified by
317 This should check that the service is running and complain if it is not.
322 check and attempt to stop.
329 If the script starts a process (rather than performing a one-off
330 operation), show the status of the process.
331 Otherwise it is not necessary to support this argument.
332 Defaults to displaying the process ID of the program (if running).
334 If the script starts a process (rather than performing a one-off
335 operation), wait for the command to exit.
336 Otherwise it is not necessary to support this argument.
338 Return 0 if the service is enabled and 1 if it is not.
339 This command does not print anything.
343 variables are used to control the startup of the service (if any).
346 If a script must implement additional commands it can list them in
349 variable, and define their actions in a variable constructed from
350 the command name (see the
354 The following key points apply to old-style scripts in
355 .Pa /usr/local/etc/rc.d/ :
358 Scripts are only executed if their
360 matches the shell globbing pattern
362 and they are executable.
363 Any other files or directories present within the directory are silently
366 When a script is executed at boot time, it is passed the string
368 as its first and only argument.
369 At shutdown time, it is passed the string
371 as its first and only argument.
374 scripts are expected to handle these arguments appropriately.
375 If no action needs to be taken at a given time
376 (either boot time or shutdown time),
377 the script should exit successfully and without producing an error message.
379 The scripts within each directory are executed in lexicographical order.
380 If a specific order is required,
381 numbers may be used as a prefix to the existing filenames,
384 would be executed before
386 without the numeric prefixes the opposite would be true.
388 The output from each script is traditionally a space character,
389 followed by the name of the software package being started or shut down,
391 a trailing newline character (see the
395 .Sh SCRIPTS OF INTEREST
396 When an automatic reboot is in progress,
398 is invoked with the argument
400 One of the scripts run from
412 all the disks of minor inconsistencies resulting
413 from the last system shutdown.
414 If this fails, then checks/repairs of serious inconsistencies
415 caused by hardware or software failure will be performed
416 in the background at the end of the booting process.
419 is not set, when going from single-user to multi-user mode for example,
420 the script does not do anything.
424 script can execute scripts from multiple
427 The default location includes
428 .Pa /usr/local/etc/rc.d/ ,
429 but these may be overridden with the
436 script is used to set any special configurations for serial devices.
440 script is used to configure rules for the kernel based firewall
442 It has several possible options:
444 .Bl -tag -width ".Ar filename" -compact -offset indent
448 will try to protect just this machine
450 will try to protect a whole network
452 totally disables IP services except via
456 disables the loading of firewall rules
458 will load the rules in the given filename (full path required).
463 scripts are used to configure ATM network interfaces.
464 The interfaces are configured in three passes.
465 The first pass performs the initial interface configuration.
466 The second pass completes the interface configuration and defines PVCs and
467 permanent ATMARP entries.
468 The third pass starts any ATM daemons.
470 Most daemons, including network related daemons, have their own script in
472 which can be used to start, stop, and check the status of the service.
474 Any architecture specific scripts, such as
476 for example, specifically check that they are on that architecture
477 before starting the daemon.
479 Following tradition, all startup files reside in
482 .Bl -tag -compact -width Pa
485 .It Pa /etc/rc.conf.local
487 .It Pa /etc/rc.firewall
489 .It Pa /etc/rc.shutdown
491 .It Pa /var/run/dmesg.boot
493 results soon after the
498 buffer in the kernel no longer has this information.
501 The following is a minimal
504 Most scripts require little more than the following.
505 .Bd -literal -offset indent
510 # REQUIRE: bar_service_required_to_precede_foo
516 command="/usr/local/bin/foo"
522 Certain scripts may want to provide enhanced functionality.
523 The user may access this functionality through additional commands.
524 The script may list and define as many commands at it needs.
525 .Bd -literal -offset indent
530 # REQUIRE: bar_service_required_to_precede_foo
531 # BEFORE: baz_service_requiring_foo_to_precede_it
537 command="/usr/local/bin/foo"
538 extra_commands="nop hello"
539 hello_cmd="echo Hello World."
551 As all processes are killed by
553 at shutdown, the explicit
555 is unnecessary, but is often included.