share/man/man8/rc.8

   1 .\" Copyright (c) 1980, 1991, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Portions of this manual page are Copyrighted by
   5 .\"     The NetBSD Foundation.
   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. Neither the name of the University nor the names of its contributors
  16 .\"    may be used to endorse or promote products derived from this software
  17 .\"    without specific prior written permission.
  18 .\"
  19 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  20 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  21 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  22 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  23 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  24 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  25 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  26 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  27 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  28 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  29 .\" SUCH DAMAGE.
  30 .\"
  31 .\"     @(#)rc.8        8.2 (Berkeley) 12/11/93
  32 .\" $FreeBSD$
  33 .\"
  34 .Dd October 6, 2020
  35 .Dt RC 8
  36 .Os
  37 .Sh NAME
  38 .Nm rc
  39 .Nd command scripts for auto-reboot and daemon startup
  40 .Sh SYNOPSIS
  41 .Nm
  42 .Nm rc.conf
  43 .Nm rc.conf.local
  44 .Nm rc.d/
  45 .Nm rc.firewall
  46 .Nm rc.local
  47 .Nm rc.resume
  48 .Nm rc.shutdown
  49 .Nm rc.subr
  50 .Sh DESCRIPTION
  51 The
  52 .Nm
  53 utility is the command script which controls the automatic boot process
  54 after being called by
  55 .Xr init 8 .
  56 The
  57 .Nm rc.local
  58 script contains commands which are pertinent only
  59 to a specific site.
  60 Typically, the
  61 .Pa /usr/local/etc/rc.d/
  62 mechanism is used instead of
  63 .Nm rc.local
  64 these days but if
  65 you want to use
  66 .Nm rc.local ,
  67 it is still supported.
  68 In this case, it should source
  69 .Pa /etc/rc.conf
  70 and contain additional custom startup code for your system.
  71 The best way to handle
  72 .Nm rc.local ,
  73 however, is to separate it out into
  74 .Nm rc.d/
  75 style scripts and place them under
  76 .Pa /usr/local/etc/rc.d/ .
  77 The
  78 .Nm rc.conf
  79 file contains the global system configuration information referenced
  80 by the startup scripts, while
  81 .Nm rc.conf.local
  82 contains the local system configuration.
  83 See
  84 .Xr rc.conf 5
  85 for more information.
  86 .Pp
  87 The
  88 .Nm rc.d/
  89 directories contain scripts which will be automatically
  90 executed at boot time and shutdown time.
  91 .Pp
  92 The
  93 .Xr service 8
  94 command provides a convenient interface to manage rc.d services.
  95 .Pp
  96 The
  97 .Xr sysrc 8
  98 command provides a scripting interface to modify system config files.
  99 .Ss Operation of Nm
 100 .Bl -enum
 101 .It
 102 If autobooting, set
 103 .Va autoboot Ns = Ns Li yes
 104 and enable a flag
 105 .Pq Va rc_fast Ns = Ns Li yes ,
 106 which prevents the
 107 .Nm rc.d/
 108 scripts from performing the check for already running processes
 109 (thus speeding up the boot process).
 110 This
 111 .Va rc_fast Ns = Ns Li yes
 112 speedup will not occur when
 113 .Nm
 114 is started up after exiting the single-user shell.
 115 .It
 116 Determine whether the system is booting diskless,
 117 and if so run the
 118 .Pa /etc/rc.initdiskless
 119 script.
 120 .It
 121 Source
 122 .Pa /etc/rc.subr
 123 to load various
 124 .Xr rc.subr 8
 125 shell functions to use.
 126 .It
 127 Load the configuration files.
 128 .It
 129 Determine if booting in a jail,
 130 and add
 131 .Dq Li nojail
 132 (no jails allowed) or
 133 .Dq Li nojailvnet
 134 (only allow vnet-enabled jails) to the list of KEYWORDS to skip in
 135 .Xr rcorder 8 .
 136 .It
 137 If the file
 138 .Va ${firstboot_sentinel}
 139 does not exist, add
 140 .Dq Li firstboot
 141 to the list of KEYWORDS to skip in
 142 .Xr rcorder 8 .
 143 .It
 144 Invoke
 145 .Xr rcorder 8
 146 to order the files in
 147 .Pa /etc/rc.d/
 148 that do not have a
 149 .Dq Li nostart
 150 KEYWORD (refer to
 151 .Xr rcorder 8 Ns 's
 152 .Fl s
 153 flag).
 154 .It
 155 Call each script in turn using
 156 .Fn run_rc_script
 157 (from
 158 .Xr rc.subr 8 ) ,
 159 which sets
 160 .Va $1
 161 to
 162 .Dq Li start ,
 163 and sources the script in a subshell.
 164 Stop processing when the script that is the value of the
 165 .Va $early_late_divider
 166 has been run.
 167 .It
 168 Check again to see if the file
 169 .Va ${firstboot_sentinel}
 170 exists (in case it is located on a newly mounted file system)
 171 and adjust the list of KEYWORDs to skip appropriately.
 172 .It
 173 Re-run
 174 .Xr rcorder 8 ,
 175 this time including the scripts in the
 176 .Va $local_startup
 177 directories.
 178 Ignore everything up to the
 179 .Va $early_late_divider ,
 180 then start executing the scripts as described above.
 181 .It
 182 If the file
 183 .Va ${firstboot_sentinel}
 184 exists, delete it.
 185 If the file
 186 .Va ${firstboot_sentinel}-reboot
 187 also exists (because it was created by a script), then delete it and reboot.
 188 .El
 189 .Ss Operation of Nm rc.shutdown
 190 .Bl -enum
 191 .It
 192 Set
 193 .Va rc_shutdown
 194 to the value of the first argument passed to
 195 .Nm rc.shutdown
 196 or to
 197 .Dq Li unspecified
 198 if no argument was passed.
 199 .It
 200 Source
 201 .Pa /etc/rc.subr
 202 to load various
 203 .Xr rc.subr 8
 204 shell functions to use.
 205 .It
 206 Load the configuration files.
 207 .It
 208 Invoke
 209 .Xr rcorder 8
 210 to order the files in
 211 .Pa /etc/rc.d/
 212 and the
 213 .Va $local_startup
 214 directories
 215 that have a
 216 .Dq Li shutdown
 217 KEYWORD (refer to
 218 .Xr rcorder 8 Ns 's
 219 .Fl k
 220 flag),
 221 reverse that order, and assign the result to a variable.
 222 .It
 223 Call each script in turn using
 224 .Fn run_rc_script
 225 (from
 226 .Xr rc.subr 8 ) ,
 227 which sets
 228 .Va $1
 229 to
 230 .Dq Li faststop ,
 231 and sources the script in a subshell.
 232 .El
 233 .Ss Contents of Nm rc.d/
 234 .Nm rc.d/
 235 is located in
 236 .Pa /etc/rc.d/ .
 237 The following file naming conventions are currently used in
 238 .Nm rc.d/ :
 239 .Bl -tag -width ".Pa ALLUPPERCASE" -offset indent
 240 .It Pa ALLUPPERCASE
 241 Scripts that are
 242 .Dq placeholders
 243 to ensure that certain operations are performed before others.
 244 In order of startup, these are:
 245 .Bl -tag -width ".Pa FILESYSTEMS"
 246 .It Pa FILESYSTEMS
 247 Ensure that root and other critical file systems are mounted.
 248 This is the default
 249 .Va $early_late_divider .
 250 .It Pa NETWORKING
 251 Ensure basic network services are running, including general
 252 network configuration.
 253 .It Pa SERVERS
 254 Ensure basic services
 255 exist for services that start early (such as
 256 .Pa nisdomain ) ,
 257 because they are required by
 258 .Pa DAEMON
 259 below.
 260 .It Pa DAEMON
 261 Check-point before all general purpose daemons such as
 262 .Pa lpd
 263 and
 264 .Pa ntpd .
 265 .It Pa LOGIN
 266 Check-point before user login services
 267 .Pa ( inetd
 268 and
 269 .Pa sshd ) ,
 270 as well as services which might run commands as users
 271 .Pa ( cron
 272 and
 273 .Pa sendmail ) .
 274 .El
 275 .It Pa bar
 276 Scripts that are sourced in a subshell.
 277 The boot does not stop if such a script terminates with a non-zero status,
 278 but a script can stop the boot if necessary by invoking the
 279 .Fn stop_boot
 280 function (from
 281 .Xr rc.subr 8 ) .
 282 .El
 283 .Pp
 284 Each script should contain
 285 .Xr rcorder 8
 286 keywords, especially an appropriate
 287 .Dq Li PROVIDE
 288 entry, and if necessary
 289 .Dq Li REQUIRE
 290 and
 291 .Dq Li BEFORE
 292 keywords.
 293 .Pp
 294 Each script is expected to support at least the following arguments, which
 295 are automatically supported if it uses the
 296 .Fn run_rc_command
 297 function:
 298 .Bl -tag -width ".Cm restart" -offset indent
 299 .It Cm start
 300 Start the service.
 301 This should check that the service is to be started as specified by
 302 .Xr rc.conf 5 .
 303 Also checks if the service is already running and refuses to start if
 304 it is.
 305 This latter check is not performed by standard
 306 .Fx
 307 scripts if the system is starting directly to multi-user mode, to
 308 speed up the boot process.
 309 If
 310 .Cm forcestart
 311 is given, ignore the
 312 .Xr rc.conf 5
 313 check and start anyway.
 314 .It Cm stop
 315 If the service is to be started as specified by
 316 .Xr rc.conf 5 ,
 317 stop the service.
 318 This should check that the service is running and complain if it is not.
 319 If
 320 .Cm forcestop
 321 is given, ignore the
 322 .Xr rc.conf 5
 323 check and attempt to stop.
 324 .It Cm restart
 325 Perform a
 326 .Cm stop
 327 then a
 328 .Cm start .
 329 .It Cm status
 330 If the script starts a process (rather than performing a one-off
 331 operation), show the status of the process.
 332 Otherwise it is not necessary to support this argument.
 333 Defaults to displaying the process ID of the program (if running).
 334 .It Cm enable
 335 Enable the service in
 336 .Xr rc.conf 5 .
 337 .It Cm disable
 338 Disable the service in
 339 .Xr rc.conf 5 .
 340 .It Cm delete
 341 Remove the service from
 342 .Xr rc.conf 5 .
 343 If
 344 .Ql Li service_delete_empty
 345 is set to
 346 .Dq Li YES ,
 347 .Pa /etc/rc.conf.d/$servicename
 348 will be deleted if empty after modification.
 349 .It Cm describe
 350 Print a short description of what the script does.
 351 .It Cm extracommands
 352 Print the script's non-standard commands.
 353 .It Cm poll
 354 If the script starts a process (rather than performing a one-off
 355 operation), wait for the command to exit.
 356 Otherwise it is not necessary to support this argument.
 357 .It Cm enabled
 358 Return 0 if the service is enabled and 1 if it is not.
 359 This command does not print anything.
 360 .It Cm rcvar
 361 Display which
 362 .Xr rc.conf 5
 363 variables are used to control the startup of the service (if any).
 364 .El
 365 .Pp
 366 If a script must implement additional commands it can list them in
 367 the
 368 .Va extra_commands
 369 variable, and define their actions in a variable constructed from
 370 the command name (see the
 371 .Sx EXAMPLES
 372 section).
 373 .Pp
 374 The following key points apply to old-style scripts in
 375 .Pa /usr/local/etc/rc.d/ :
 376 .Bl -bullet
 377 .It
 378 Scripts are only executed if their
 379 .Xr basename 1
 380 matches the shell globbing pattern
 381 .Pa *.sh ,
 382 and they are executable.
 383 Any other files or directories present within the directory are silently
 384 ignored.
 385 .It
 386 When a script is executed at boot time, it is passed the string
 387 .Dq Li start
 388 as its first and only argument.
 389 At shutdown time, it is passed the string
 390 .Dq Li stop
 391 as its first and only argument.
 392 All
 393 .Nm rc.d/
 394 scripts are expected to handle these arguments appropriately.
 395 If no action needs to be taken at a given time
 396 (either boot time or shutdown time),
 397 the script should exit successfully and without producing an error message.
 398 .It
 399 The scripts within each directory are executed in lexicographical order.
 400 If a specific order is required,
 401 numbers may be used as a prefix to the existing filenames,
 402 so for example
 403 .Pa 100.foo
 404 would be executed before
 405 .Pa 200.bar ;
 406 without the numeric prefixes the opposite would be true.
 407 .It
 408 The output from each script is traditionally a space character,
 409 followed by the name of the software package being started or shut down,
 410 .Em without
 411 a trailing newline character.
 412 .El
 413 .Sh SCRIPTS OF INTEREST
 414 When an automatic reboot is in progress,
 415 .Nm
 416 is invoked with the argument
 417 .Cm autoboot .
 418 One of the scripts run from
 419 .Pa /etc/rc.d/
 420 is
 421 .Pa /etc/rc.d/fsck .
 422 This script runs
 423 .Xr fsck 8
 424 with option
 425 .Fl p
 426 and
 427 .Fl F
 428 to
 429 .Dq preen
 430 all the disks of minor inconsistencies resulting
 431 from the last system shutdown.
 432 If this fails, then checks/repairs of serious inconsistencies
 433 caused by hardware or software failure will be performed
 434 in the background at the end of the booting process.
 435 If
 436 .Cm autoboot
 437 is not set, when going from single-user to multi-user mode for example,
 438 the script does not do anything.
 439 .Pp
 440 The
 441 .Pa /etc/rc.d/local
 442 script can execute scripts from multiple
 443 .Nm rc.d/
 444 directories.
 445 The default location includes
 446 .Pa /usr/local/etc/rc.d/ ,
 447 but these may be overridden with the
 448 .Va local_startup
 449 .Xr rc.conf 5
 450 variable.
 451 .Pp
 452 The
 453 .Pa /etc/rc.d/serial
 454 script is used to set any special configurations for serial devices.
 455 .Pp
 456 The
 457 .Nm rc.firewall
 458 script is used to configure rules for the kernel based firewall
 459 service.
 460 It has several possible options:
 461 .Pp
 462 .Bl -tag -width ".Ar filename" -compact -offset indent
 463 .It Cm open
 464 will allow anyone in
 465 .It Cm client
 466 will try to protect just this machine
 467 .It Cm simple
 468 will try to protect a whole network
 469 .It Cm closed
 470 totally disables IP services except via
 471 .Pa lo0
 472 interface
 473 .It Cm UNKNOWN
 474 disables the loading of firewall rules
 475 .It Ar filename
 476 will load the rules in the given filename (full path required).
 477 .El
 478 .Pp
 479 Most daemons, including network related daemons, have their own script in
 480 .Pa /etc/rc.d/ ,
 481 which can be used to start, stop, and check the status of the service.
 482 .Pp
 483 Any architecture specific scripts, such as
 484 .Pa /etc/rc.d/apm
 485 for example, specifically check that they are on that architecture
 486 before starting the daemon.
 487 .Pp
 488 Following tradition, all startup files reside in
 489 .Pa /etc .
 490 .Sh FILES
 491 .Bl -tag -compact -width Pa
 492 .It Pa /etc/rc
 493 .It Pa /etc/rc.conf
 494 .It Pa /etc/rc.conf.local
 495 .It Pa /etc/rc.d/
 496 .It Pa /etc/rc.firewall
 497 .It Pa /etc/rc.local
 498 .It Pa /etc/rc.shutdown
 499 .It Pa /etc/rc.subr
 500 .It Pa /var/run/dmesg.boot
 501 .Xr dmesg 8
 502 results soon after the
 503 .Nm
 504 process begins.
 505 Useful when
 506 .Xr dmesg 8
 507 buffer in the kernel no longer has this information.
 508 .El
 509 .Sh EXAMPLES
 510 The following is a minimal
 511 .Nm rc.d/
 512 style script.
 513 Most scripts require little more than the following.
 514 .Bd -literal -offset indent
 515 #!/bin/sh
 516 #
 517
 518 # PROVIDE: foo
 519 # REQUIRE: bar_service_required_to_precede_foo
 520
 521 \&. /etc/rc.subr
 522
 523 name="foo"
 524 rcvar=foo_enable
 525 command="/usr/local/bin/foo"
 526
 527 load_rc_config $name
 528 run_rc_command "$1"
 529 .Ed
 530 .Pp
 531 Certain scripts may want to provide enhanced functionality.
 532 The user may access this functionality through additional commands.
 533 The script may list and define as many commands at it needs.
 534 .Bd -literal -offset indent
 535 #!/bin/sh
 536 #
 537
 538 # PROVIDE: foo
 539 # REQUIRE: bar_service_required_to_precede_foo
 540 # BEFORE:  baz_service_requiring_foo_to_precede_it
 541
 542 \&. /etc/rc.subr
 543
 544 name="foo"
 545 rcvar=foo_enable
 546 command="/usr/local/bin/foo"
 547 extra_commands="nop hello"
 548 hello_cmd="echo Hello World."
 549 nop_cmd="do_nop"
 550
 551 do_nop()
 552 {
 553         echo "I do nothing."
 554 }
 555
 556 load_rc_config $name
 557 run_rc_command "$1"
 558 .Ed
 559 .Pp
 560 As all processes are killed by
 561 .Xr init 8
 562 at shutdown, the explicit
 563 .Xr kill 1
 564 is unnecessary, but is often included.
 565 .Sh SEE ALSO
 566 .Xr kill 1 ,
 567 .Xr rc.conf 5 ,
 568 .Xr init 8 ,
 569 .Xr rc.resume 8 ,
 570 .Xr rc.subr 8 ,
 571 .Xr rcorder 8 ,
 572 .Xr reboot 8 ,
 573 .Xr savecore 8 ,
 574 .Xr service 8 ,
 575 .Xr sysrc 8
 576 .Sh HISTORY
 577 The
 578 .Nm
 579 utility appeared in
 580 .Bx 4.0 .