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