sbin/init/init.8

   1 .\" Copyright (c) 1980, 1991, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" This code is derived from software contributed to Berkeley by
   5 .\" Donn Seeley at Berkeley Software Design, Inc.
   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 .\" 4. 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 .\"     @(#)init.8      8.3 (Berkeley) 4/18/94
  32 .\" $FreeBSD$
  33 .\"
  34 .Dd March 14, 2012
  35 .Dt INIT 8
  36 .Os
  37 .Sh NAME
  38 .Nm init
  39 .Nd process control initialization
  40 .Sh SYNOPSIS
  41 .Nm
  42 .Nm
  43 .Oo
  44 .Cm 0 | 1 | 6 |
  45 .Cm c | q
  46 .Oc
  47 .Sh DESCRIPTION
  48 The
  49 .Nm
  50 utility
  51 is the last stage of the boot process.
  52 It normally runs the automatic reboot sequence as described in
  53 .Xr rc 8 ,
  54 and if this succeeds, begins multi-user operation.
  55 If the reboot scripts fail,
  56 .Nm
  57 commences single-user operation by giving
  58 the super-user a shell on the console.
  59 The
  60 .Nm
  61 utility may be passed parameters
  62 from the boot program to
  63 prevent the system from going multi-user and to instead execute
  64 a single-user shell without starting the normal daemons.
  65 The system is then quiescent for maintenance work and may
  66 later be made to go to multi-user by exiting the
  67 single-user shell (with ^D).
  68 This
  69 causes
  70 .Nm
  71 to run the
  72 .Pa /etc/rc
  73 start up command file in fastboot mode (skipping disk checks).
  74 .Pp
  75 If the
  76 .Em console
  77 entry in the
  78 .Xr ttys 5
  79 file is marked
  80 .Dq insecure ,
  81 then
  82 .Nm
  83 will require that the super-user password be
  84 entered before the system will start a single-user shell.
  85 The password check is skipped if the
  86 .Em console
  87 is marked as
  88 .Dq secure .
  89 .Pp
  90 If the system security level (see
  91 .Xr security 7 )
  92 is initially nonzero, then
  93 .Nm
  94 leaves it unchanged.
  95 Otherwise,
  96 .Nm
  97 raises the level to 1 before going multi-user for the first time.
  98 Since the level cannot be reduced, it will be at least 1 for
  99 subsequent operation, even on return to single-user.
 100 If a level higher than 1 is desired while running multi-user,
 101 it can be set before going multi-user, e.g., by the startup script
 102 .Xr rc 8 ,
 103 using
 104 .Xr sysctl 8
 105 to set the
 106 .Va kern.securelevel
 107 variable to the required security level.
 108 .Pp
 109 If
 110 .Nm
 111 is run in a jail, the security level of the
 112 .Dq host system
 113 will not be affected.
 114 Part of the information set up in the kernel to support a jail
 115 is a per-jail security level.
 116 This allows running a higher security level inside of a jail
 117 than that of the host system.
 118 See
 119 .Xr jail 8
 120 for more information about jails.
 121 .Pp
 122 In multi-user operation,
 123 .Nm
 124 maintains
 125 processes for the terminal ports found in the file
 126 .Xr ttys 5 .
 127 The
 128 .Nm
 129 utility reads this file and executes the command found in the second field,
 130 unless the first field refers to a device in
 131 .Pa /dev
 132 which is not configured.
 133 The first field is supplied as the final argument to the command.
 134 This command is usually
 135 .Xr getty 8 ;
 136 .Nm getty
 137 opens and initializes the tty line
 138 and
 139 executes the
 140 .Xr login 1
 141 program.
 142 The
 143 .Nm login
 144 program, when a valid user logs in,
 145 executes a shell for that user.
 146 When this shell
 147 dies, either because the user logged out
 148 or an abnormal termination occurred (a signal),
 149 .Nm login
 150 records the logout in the user accounting
 151 database (see
 152 .Xr getutxent 3)
 153 and terminates.
 154 The cycle is
 155 then restarted by
 156 .Nm
 157 executing a new
 158 .Nm getty
 159 for the line.
 160 .Pp
 161 The
 162 .Nm
 163 utility can also be used to keep arbitrary daemons running,
 164 automatically restarting them if they die.
 165 In this case, the first field in the
 166 .Xr ttys 5
 167 file must not reference the path to a configured device node
 168 and will be passed to the daemon
 169 as the final argument on its command line.
 170 This is similar to the facility offered in the
 171 .At V
 172 .Pa /etc/inittab .
 173 .Pp
 174 Line status (on, off, secure, getty, or window information)
 175 may be changed in the
 176 .Xr ttys 5
 177 file without a reboot by sending the signal
 178 .Dv SIGHUP
 179 to
 180 .Nm
 181 with the command
 182 .Dq Li "kill -HUP 1" .
 183 On receipt of this signal,
 184 .Nm
 185 re-reads the
 186 .Xr ttys 5
 187 file.
 188 When a line is turned off in
 189 .Xr ttys 5 ,
 190 .Nm
 191 will send a SIGHUP signal to the controlling process
 192 for the session associated with the line.
 193 For any lines that were previously turned off in the
 194 .Xr ttys 5
 195 file and are now on,
 196 .Nm
 197 executes the command specified in the second field.
 198 If the command or window field for a line is changed,
 199 the change takes effect at the end of the current
 200 login session (e.g., the next time
 201 .Nm
 202 starts a process on the line).
 203 If a line is commented out or deleted from
 204 .Xr ttys 5 ,
 205 .Nm
 206 will not do anything at all to that line.
 207 .Pp
 208 The
 209 .Nm
 210 utility will terminate multi-user operations and resume single-user mode
 211 if sent a terminate
 212 .Pq Dv TERM
 213 signal, for example,
 214 .Dq Li "kill \-TERM 1" .
 215 If there are processes outstanding that are deadlocked (because of
 216 hardware or software failure),
 217 .Nm
 218 will not wait for them all to die (which might take forever), but
 219 will time out after 30 seconds and print a warning message.
 220 .Pp
 221 The
 222 .Nm
 223 utility will cease creating new processes
 224 and allow the system to slowly die away, if it is sent a terminal stop
 225 .Pq Dv TSTP
 226 signal, i.e.\&
 227 .Dq Li "kill \-TSTP 1" .
 228 A later hangup will resume full
 229 multi-user operations, or a terminate will start a single-user shell.
 230 This hook is used by
 231 .Xr reboot 8
 232 and
 233 .Xr halt 8 .
 234 .Pp
 235 The
 236 .Nm
 237 utility will terminate all possible processes (again, it will not wait
 238 for deadlocked processes) and reboot the machine if sent the interrupt
 239 .Pq Dv INT
 240 signal, i.e.\&
 241 .Dq Li "kill \-INT 1".
 242 This is useful for shutting the machine down cleanly from inside the kernel
 243 or from X when the machine appears to be hung.
 244 .Pp
 245 The
 246 .Nm
 247 utility will do the same, except it will halt the machine if sent
 248 the user defined signal 1
 249 .Pq Dv USR1 ,
 250 or will halt and turn the power off (if hardware permits) if sent
 251 the user defined signal 2
 252 .Pq Dv USR2 .
 253 .Pp
 254 When shutting down the machine,
 255 .Nm
 256 will try to run the
 257 .Pa /etc/rc.shutdown
 258 script.
 259 This script can be used to cleanly terminate specific programs such
 260 as
 261 .Nm innd
 262 (the InterNetNews server).
 263 If this script does not terminate within 120 seconds,
 264 .Nm
 265 will terminate it.
 266 The timeout can be configured via the
 267 .Xr sysctl 8
 268 variable
 269 .Va kern.init_shutdown_timeout .
 270 .Pp
 271 The role of
 272 .Nm
 273 is so critical that if it dies, the system will reboot itself
 274 automatically.
 275 If, at bootstrap time, the
 276 .Nm
 277 process cannot be located, the system will panic with the message
 278 .Dq "panic: init died (signal %d, exit %d)" .
 279 .Pp
 280 If run as a user process as shown in the second synopsis line,
 281 .Nm
 282 will emulate
 283 .At V
 284 behavior, i.e., super-user can specify the desired
 285 .Em run-level
 286 on a command line, and
 287 .Nm
 288 will signal the original
 289 (PID 1)
 290 .Nm
 291 as follows:
 292 .Bl -column Run-level SIGTERM
 293 .It Sy "Run-level       Signal  Action
 294 .It Cm 0 Ta Dv SIGUSR2 Ta "Halt and turn the power off"
 295 .It Cm 1 Ta Dv SIGTERM Ta "Go to single-user mode"
 296 .It Cm 6 Ta Dv SIGINT Ta "Reboot the machine"
 297 .It Cm c Ta Dv SIGTSTP Ta "Block further logins"
 298 .It Cm q Ta Dv SIGHUP Ta Rescan the
 299 .Xr ttys 5
 300 file
 301 .El
 302 .Sh FILES
 303 .Bl -tag -width /var/log/init.log -compact
 304 .It Pa /dev/console
 305 system console device
 306 .It Pa /dev/tty*
 307 terminal ports found in
 308 .Xr ttys 5
 309 .It Pa /etc/ttys
 310 the terminal initialization information file
 311 .It Pa /etc/rc
 312 system startup commands
 313 .It Pa /etc/rc.shutdown
 314 system shutdown commands
 315 .It Pa /var/log/init.log
 316 log of
 317 .Xr rc 8
 318 output if the system console device is not available
 319 .El
 320 .Sh DIAGNOSTICS
 321 .Bl -diag
 322 .It "getty repeating too quickly on port %s, sleeping."
 323 A process being started to service a line is exiting quickly
 324 each time it is started.
 325 This is often caused by a ringing or noisy terminal line.
 326 .Bf -emphasis
 327 Init will sleep for 30 seconds,
 328 then continue trying to start the process.
 329 .Ef
 330 .It "some processes would not die; ps axl advised."
 331 A process
 332 is hung and could not be killed when the system was shutting down.
 333 This condition is usually caused by a process
 334 that is stuck in a device driver because of
 335 a persistent device error condition.
 336 .El
 337 .Sh SEE ALSO
 338 .Xr kill 1 ,
 339 .Xr login 1 ,
 340 .Xr sh 1 ,
 341 .Xr ttys 5 ,
 342 .Xr security 7 ,
 343 .Xr getty 8 ,
 344 .Xr halt 8 ,
 345 .Xr jail 8 ,
 346 .Xr rc 8 ,
 347 .Xr reboot 8 ,
 348 .Xr shutdown 8 ,
 349 .Xr sysctl 8
 350 .Sh HISTORY
 351 An
 352 .Nm
 353 utility appeared in
 354 .At v6 .
 355 .Sh CAVEATS
 356 Systems without
 357 .Xr sysctl 8
 358 behave as though they have security level \-1.
 359 .Pp
 360 Setting the security level above 1 too early in the boot sequence can
 361 prevent
 362 .Xr fsck 8
 363 from repairing inconsistent file systems.
 364 The
 365 preferred location to set the security level is at the end of
 366 .Pa /etc/rc
 367 after all multi-user startup actions are complete.