freebsd-skq/sbin/reboot/reboot.8

.\" Copyright (c) 1990, 1991, 1993
.\"	The Regents of the University of California.  All rights reserved.
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\"    notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\"    notice, this list of conditions and the following disclaimer in the
.\"    documentation and/or other materials provided with the distribution.
.\" 4. Neither the name of the University nor the names of its contributors
.\"    may be used to endorse or promote products derived from this software
.\"    without specific prior written permission.
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\"	@(#)reboot.8	8.1 (Berkeley) 6/9/93
.\" $FreeBSD$
.\"
.Dd October 11, 2010
.Dt REBOOT 8
.Os
.Sh NAME
.Nm reboot ,
.Nm halt ,
.Nm fastboot ,
.Nm fasthalt
.Nd stopping and restarting the system
.Sh SYNOPSIS
.Nm halt
.Op Fl lnpq
.Op Fl k Ar kernel
.Nm
.Op Fl dlnpq
.Op Fl k Ar kernel
.Nm fasthalt
.Op Fl lnpq
.Op Fl k Ar kernel
.Nm fastboot
.Op Fl dlnpq
.Op Fl k Ar kernel
.Sh DESCRIPTION
The
.Nm halt
and
.Nm
utilities flush the file system cache to disk, send all running processes
a
.Dv SIGTERM
(and subsequently a
.Dv SIGKILL )
and, respectively, halt or restart the system.
The action is logged, including entering a shutdown record into the user
accounting database.
.Pp
The options are as follows:
.Bl -tag -width indent
.It Fl d
The system is requested to create a crash dump.
This option is
supported only when rebooting, and it has no effect unless a dump
device has previously been specified with
.Xr dumpon 8 .
.It Fl k Ar kernel
Boot the specified
.Ar kernel
on the next system boot.
If the kernel boots successfully, the
.Em default
kernel will be booted on successive boots, this is a one-shot option.
If the boot fails, the system will continue attempting to boot
.Ar kernel
until the boot process is interrupted and a valid kernel booted.
This may change in the future.
.It Fl l
The halt or reboot is
.Em not
logged to the system log.
This option is intended for applications such as
.Xr shutdown 8 ,
that call
.Nm
or
.Nm halt
and log this themselves.
.It Fl n
The file system cache is not flushed.
This option should probably not be used.
.It Fl p
The system will turn off the power if it can.
If the power down action fails, the system
will halt or reboot normally, depending on whether
.Nm halt
or
.Nm
was called.
.It Fl q
The system is halted or restarted quickly and ungracefully, and only
the flushing of the file system cache is performed (if the
.Fl n
option is not specified).
This option should probably not be used.
.El
.Pp
The
.Nm fasthalt
and
.Nm fastboot
utilities are nothing more than aliases for the
.Nm halt
and
.Nm
utilities.
.Pp
Normally, the
.Xr shutdown 8
utility is used when the system needs to be halted or restarted, giving
users advance warning of their impending doom and cleanly terminating
specific programs.
.Sh SEE ALSO
.Xr getutxent 3 ,
.Xr boot 8 ,
.Xr dumpon 8 ,
.Xr nextboot 8 ,
.Xr savecore 8 ,
.Xr shutdown 8 ,
.Xr sync 8
.Sh HISTORY
A
.Nm
utility appeared in
.At v6 .
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin. 1994-05-26 06:35:07 +00:00			`.\" Copyright (c) 1990, 1991, 1993`
			`.\" The Regents of the University of California. All rights reserved.`
			`.\"`
			`.\" Redistribution and use in source and binary forms, with or without`
			`.\" modification, are permitted provided that the following conditions`
			`.\" are met:`
			`.\" 1. Redistributions of source code must retain the above copyright`
			`.\" notice, this list of conditions and the following disclaimer.`
			`.\" 2. Redistributions in binary form must reproduce the above copyright`
			`.\" notice, this list of conditions and the following disclaimer in the`
			`.\" documentation and/or other materials provided with the distribution.`
			`.\" 4. Neither the name of the University nor the names of its contributors`
			`.\" may be used to endorse or promote products derived from this software`
			`.\" without specific prior written permission.`
			`.\"`
			.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
			`.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE`
			`.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE`
			`.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE`
			`.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL`
			`.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS`
			`.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)`
			`.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT`
			`.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY`
			`.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF`
			`.\" SUCH DAMAGE.`
			`.\"`
			`.\" @(#)reboot.8 8.1 (Berkeley) 6/9/93`
$Id$ -> $FreeBSD$ 1999-08-28 00:22:10 +00:00			`.\" $FreeBSD$`
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin. 1994-05-26 06:35:07 +00:00			`.\"`
Remove stale reference to wtmp(5). Reported by: pluknet 2010-10-11 20:17:23 +00:00			`.Dd October 11, 2010`
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin. 1994-05-26 06:35:07 +00:00			`.Dt REBOOT 8`
			`.Os`
			`.Sh NAME`
			`.Nm reboot ,`
Add `.Nm fastboot' and `.Nm fasthalt' to NAME section. 2000-01-10 12:24:47 +00:00			`.Nm halt ,`
			`.Nm fastboot ,`
			`.Nm fasthalt`
			`.Nd stopping and restarting the system`
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin. 1994-05-26 06:35:07 +00:00			`.Sh SYNOPSIS`
			`.Nm halt`
Sync program's usage() with manpage's SYNOPSIS. 2005-02-10 09:19:34 +00:00			`.Op Fl lnpq`
Add a -k option to reboot to specify the kernel to boot next time around. If the kernel boots successfully, the record of this kernel is erased, it is intended to be a one-shot option for testing kernels. This could be improved by having the loader remove the record of the next kernel to boot, it is currently removed in /etc/rc immediately after disks are mounted r/w. I'd like to MFC this before the 4.6 freeze unless there is violent objection. Reviewed by: Several on IRC MFC after: 4 days 2002-04-26 07:31:04 +00:00			`.Op Fl k Ar kernel`
mdoc(7) police: use the new features of the Nm macro. 2000-11-20 16:52:27 +00:00			`.Nm`
Sync program's usage() with manpage's SYNOPSIS. 2005-02-10 09:19:34 +00:00			`.Op Fl dlnpq`
Add a -k option to reboot to specify the kernel to boot next time around. If the kernel boots successfully, the record of this kernel is erased, it is intended to be a one-shot option for testing kernels. This could be improved by having the loader remove the record of the next kernel to boot, it is currently removed in /etc/rc immediately after disks are mounted r/w. I'd like to MFC this before the 4.6 freeze unless there is violent objection. Reviewed by: Several on IRC MFC after: 4 days 2002-04-26 07:31:04 +00:00			`.Op Fl k Ar kernel`
Install aliases "fasthalt" and "fastboot" for halt and boot respectively. This is for "backwards compatibility". Documented these aliases in the manual page. 1994-08-21 05:48:34 +00:00			`.Nm fasthalt`
Sync program's usage() with manpage's SYNOPSIS. 2005-02-10 09:19:34 +00:00			`.Op Fl lnpq`
Add a -k option to reboot to specify the kernel to boot next time around. If the kernel boots successfully, the record of this kernel is erased, it is intended to be a one-shot option for testing kernels. This could be improved by having the loader remove the record of the next kernel to boot, it is currently removed in /etc/rc immediately after disks are mounted r/w. I'd like to MFC this before the 4.6 freeze unless there is violent objection. Reviewed by: Several on IRC MFC after: 4 days 2002-04-26 07:31:04 +00:00			`.Op Fl k Ar kernel`
Install aliases "fasthalt" and "fastboot" for halt and boot respectively. This is for "backwards compatibility". Documented these aliases in the manual page. 1994-08-21 05:48:34 +00:00			`.Nm fastboot`
Sync program's usage() with manpage's SYNOPSIS. 2005-02-10 09:19:34 +00:00			`.Op Fl dlnpq`
Add a -k option to reboot to specify the kernel to boot next time around. If the kernel boots successfully, the record of this kernel is erased, it is intended to be a one-shot option for testing kernels. This could be improved by having the loader remove the record of the next kernel to boot, it is currently removed in /etc/rc immediately after disks are mounted r/w. I'd like to MFC this before the 4.6 freeze unless there is violent objection. Reviewed by: Several on IRC MFC after: 4 days 2002-04-26 07:31:04 +00:00			`.Op Fl k Ar kernel`
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin. 1994-05-26 06:35:07 +00:00			`.Sh DESCRIPTION`
			`The`
			`.Nm halt`
			`and`
Correct use of .Nm. Add rcsid. -Wall. Add -p flag in usage string (was missing). 1998-07-15 06:51:38 +00:00			`.Nm`
s/filesystem/file system/g as discussed on -developers 2002-08-21 18:11:48 +00:00			`utilities flush the file system cache to disk, send all running processes`
Clarify some details. 1999-06-23 07:00:30 +00:00			`a`
			`.Dv SIGTERM`
			`(and subsequently a`
			`.Dv SIGKILL )`
			`and, respectively, halt or restart the system.`
Remove stale references to utmp(5) and its corresponding filenames. I removed utmp and its manpage, but not other manpages referring to it. 2010-01-21 17:25:12 +00:00			`The action is logged, including entering a shutdown record into the user`
			`accounting database.`
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin. 1994-05-26 06:35:07 +00:00			`.Pp`
			`The options are as follows:`
Correct use of .Nm. Add rcsid. -Wall. Add -p flag in usage string (was missing). 1998-07-15 06:51:38 +00:00			`.Bl -tag -width indent`
Add a "-d" option which causes the system to generate a crash dump. 1999-11-21 21:52:40 +00:00			`.It Fl d`
mdoc(7) police: nits. 2002-05-29 16:47:55 +00:00			`The system is requested to create a crash dump.`
			`This option is`
Add a "-d" option which causes the system to generate a crash dump. 1999-11-21 21:52:40 +00:00			`supported only when rebooting, and it has no effect unless a dump`
			`device has previously been specified with`
			`.Xr dumpon 8 .`
Add a -k option to reboot to specify the kernel to boot next time around. If the kernel boots successfully, the record of this kernel is erased, it is intended to be a one-shot option for testing kernels. This could be improved by having the loader remove the record of the next kernel to boot, it is currently removed in /etc/rc immediately after disks are mounted r/w. I'd like to MFC this before the 4.6 freeze unless there is violent objection. Reviewed by: Several on IRC MFC after: 4 days 2002-04-26 07:31:04 +00:00			`.It Fl k Ar kernel`
			`Boot the specified`
			`.Ar kernel`
mdoc(7) police: nits. 2002-05-29 16:47:55 +00:00			`on the next system boot.`
			`If the kernel boots successfully, the`
Add a -k option to reboot to specify the kernel to boot next time around. If the kernel boots successfully, the record of this kernel is erased, it is intended to be a one-shot option for testing kernels. This could be improved by having the loader remove the record of the next kernel to boot, it is currently removed in /etc/rc immediately after disks are mounted r/w. I'd like to MFC this before the 4.6 freeze unless there is violent objection. Reviewed by: Several on IRC MFC after: 4 days 2002-04-26 07:31:04 +00:00			`.Em default`
english(4) police. 2002-12-27 12:15:40 +00:00			`kernel will be booted on successive boots, this is a one-shot option.`
Add a -k option to reboot to specify the kernel to boot next time around. If the kernel boots successfully, the record of this kernel is erased, it is intended to be a one-shot option for testing kernels. This could be improved by having the loader remove the record of the next kernel to boot, it is currently removed in /etc/rc immediately after disks are mounted r/w. I'd like to MFC this before the 4.6 freeze unless there is violent objection. Reviewed by: Several on IRC MFC after: 4 days 2002-04-26 07:31:04 +00:00			`If the boot fails, the system will continue attempting to boot`
			`.Ar kernel`
			`until the boot process is interrupted and a valid kernel booted.`
			`This may change in the future.`
Document the -l option. PR: docs/27440 Submitted by: Flix-Antoine Paradis <reel@sympatico.ca> 2001-05-24 09:28:05 +00:00			`.It Fl l`
			`The halt or reboot is`
			`.Em not`
			`logged to the system log.`
Remove whitespace at EOL. 2001-07-15 07:53:42 +00:00			`This option is intended for applications such as`
Document the -l option. PR: docs/27440 Submitted by: Flix-Antoine Paradis <reel@sympatico.ca> 2001-05-24 09:28:05 +00:00			`.Xr shutdown 8 ,`
			`that call`
			`.Nm`
Remove whitespace at EOL. 2001-07-15 07:53:42 +00:00			`or`
Document the -l option. PR: docs/27440 Submitted by: Flix-Antoine Paradis <reel@sympatico.ca> 2001-05-24 09:28:05 +00:00			`.Nm halt`
			`and log this themselves.`
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin. 1994-05-26 06:35:07 +00:00			`.It Fl n`
s/filesystem/file system/g as discussed on -developers 2002-08-21 18:11:48 +00:00			`The file system cache is not flushed.`
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin. 1994-05-26 06:35:07 +00:00			`This option should probably not be used.`
Add support to halt, to allow it to request that the power be turned off (the RB_POWEROFF flag) 1996-08-24 01:40:02 +00:00			`.It Fl p`
Document behaviour change in reboot(8) introduced in reboot.c rev. 1.17: when using '-p' with reboot, and the power down action failds, reboot the system normally. The behaviour of 'halt -p' and of shutdown(8) is unchanged. Approved by: roberto 2002-10-07 21:18:20 +00:00			`The system will turn off the power if it can.`
			`If the power down action fails, the system`
			`will halt or reboot normally, depending on whether`
			`.Nm halt`
			`or`
mdoc(7) police: Nits. Approved by: re 2002-11-26 09:05:06 +00:00			`.Nm`
Document behaviour change in reboot(8) introduced in reboot.c rev. 1.17: when using '-p' with reboot, and the power down action failds, reboot the system normally. The behaviour of 'halt -p' and of shutdown(8) is unchanged. Approved by: roberto 2002-10-07 21:18:20 +00:00			`was called.`
Sync program's usage() with manpage's SYNOPSIS. 2005-02-10 09:19:34 +00:00			`.It Fl q`
			`The system is halted or restarted quickly and ungracefully, and only`
			`the flushing of the file system cache is performed (if the`
			`.Fl n`
			`option is not specified).`
			`This option should probably not be used.`
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin. 1994-05-26 06:35:07 +00:00			`.El`
			`.Pp`
Install aliases "fasthalt" and "fastboot" for halt and boot respectively. This is for "backwards compatibility". Documented these aliases in the manual page. 1994-08-21 05:48:34 +00:00			`The`
			`.Nm fasthalt`
			`and`
			`.Nm fastboot`
			`utilities are nothing more than aliases for the`
			`.Nm halt`
			`and`
Correct use of .Nm. Add rcsid. -Wall. Add -p flag in usage string (was missing). 1998-07-15 06:51:38 +00:00			`.Nm`
Install aliases "fasthalt" and "fastboot" for halt and boot respectively. This is for "backwards compatibility". Documented these aliases in the manual page. 1994-08-21 05:48:34 +00:00			`utilities.`
			`.Pp`
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin. 1994-05-26 06:35:07 +00:00			`Normally, the`
			`.Xr shutdown 8`
			`utility is used when the system needs to be halted or restarted, giving`
Clarify some details. 1999-06-23 07:00:30 +00:00			`users advance warning of their impending doom and cleanly terminating`
			`specific programs.`
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin. 1994-05-26 06:35:07 +00:00			`.Sh SEE ALSO`
Remove stale reference to wtmp(5). Reported by: pluknet 2010-10-11 20:17:23 +00:00			`.Xr getutxent 3 ,`
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin. 1994-05-26 06:35:07 +00:00			`.Xr boot 8 ,`
Add a "-d" option which causes the system to generate a crash dump. 1999-11-21 21:52:40 +00:00			`.Xr dumpon 8 ,`
Cross-reference nextboot(8). MFC after: 3 days 2006-11-22 13:12:34 +00:00			`.Xr nextboot 8 ,`
Add a "-d" option which causes the system to generate a crash dump. 1999-11-21 21:52:40 +00:00			`.Xr savecore 8 ,`
Correct a bunch of man page cross references and generally try and silence "manck". ncurses, rpc, and some of the gnu stuff are still a big mess, however. 1996-02-11 22:38:05 +00:00			`.Xr shutdown 8 ,`
			`.Xr sync 8`
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin. 1994-05-26 06:35:07 +00:00			`.Sh HISTORY`
			`A`
Correct use of .Nm. Add rcsid. -Wall. Add -p flag in usage string (was missing). 1998-07-15 06:51:38 +00:00			`.Nm`
The .Nm utility. 2002-07-06 19:35:14 +00:00			`utility appeared in`
BSD 4.4 Lite sbin Sources Note: XNSrouted and routed NOT imported here, they shall be imported with usr.sbin. 1994-05-26 06:35:07 +00:00			`.At v6 .`