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