NetBSD/sbin/reboot/reboot.8

.\"	$NetBSD: reboot.8,v 1.18 2003/02/25 10:35:08 wiz Exp $
.\"
.\" 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.
.\" 3. All advertising materials mentioning features or use of this software
.\"    must display the following acknowledgement:
.\"	This product includes software developed by the University of
.\"	California, Berkeley and its contributors.
.\" 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
.\"
.Dd April 14, 2000
.Dt REBOOT 8
.Os
.Sh NAME
.Nm reboot ,
.Nm poweroff ,
.Nm halt
.Nd restarting, powering down and stopping the system
.Sh SYNOPSIS
.Nm halt
.Op Fl dlnpq
.Nm poweroff
.Op Fl dlnq
.Nm
.Op Fl dlnq
.Sh DESCRIPTION
The
.Nm poweroff ,
.Nm halt
and
.Nm
utilities flush the file system cache to disk, send all running processes
a SIGTERM, wait up to 30 seconds for them to die, send a SIGKILL to the
survivors and, respectively, power down, halt or restart the system.
The action is logged, including entering a shutdown record into the login
accounting file and sending a message via
.Xr syslog 3 .
.Pp
The options are as follows:
.Bl -tag -width Ds
.It Fl d
Create a dump before halting or restarting.
This option is useful for debugging system dump procedures or
capturing the state of a corrupted or misbehaving system.
.It Fl l
Suppress sending a message via
.Xr syslog 3
before halting or restarting.
.It Fl n
Do not flush the file system cache.
This option should be used with extreme caution.
It can be used if a disk or the processor is on fire.
.It Fl p
Attempt to powerdown the system.
If the powerdown fails, or the system does not support
software powerdown, the system will halt.
This option is only valid for
.Nm halt .
.It Fl q
Do not give processes a chance to shut down before halting or restarting.
This option should not normally be used.
.El
.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.
.Sh SEE ALSO
.Xr reboot 2 ,
.Xr syslog 3 ,
.Xr utmp 5 ,
.Xr boot 8 ,
.Xr shutdown 8 ,
.Xr sync 8
.Sh HISTORY
A
.Nm
command appeared in
.At v6 .
.Pp
The
.Nm poweroff
command first appeared in
.Nx 1.5 .
.Sh BUGS
The single user shell will ignore the SIGTERM signal.
To avoid waiting for the timeout when
rebooting or halting from the single user shell, you have to
.Ic exec reboot
or
.Ic exec halt .
.Nm does not need a dummy argument ("") before punctuation or for correct formatting of the SYNOPSIS any longer. 2003-02-25 13:34:36 +03:00			`.\" $NetBSD: reboot.8,v 1.18 2003/02/25 10:35:08 wiz Exp $`
pseudo-merge with Lite; man pages need to be merged seperately, but that's really a port-specific thing. They probably should be updated, too. 1995-03-18 19:11:33 +03:00			`.\"`
from Lite 1995-03-18 18:17:32 +03: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.`
			`.\" 3. All advertising materials mentioning features or use of this software`
			`.\" must display the following acknowledgement:`
			`.\" This product includes software developed by the University of`
			`.\" California, Berkeley and its contributors.`
			`.\" 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`
			`.\"`
Implement a "poweroff" command which is equivalent to "halt -p", but allows powering down the system from an exec(2) call, e.g. via a user which has "poweroff" as login shell. The command name is modeled after Solaris. 2000-04-25 18:03:25 +04:00			`.Dd April 14, 2000`
from Lite 1995-03-18 18:17:32 +03:00			`.Dt REBOOT 8`
			`.Os`
			`.Sh NAME`
			`.Nm reboot ,`
Implement a "poweroff" command which is equivalent to "halt -p", but allows powering down the system from an exec(2) call, e.g. via a user which has "poweroff" as login shell. The command name is modeled after Solaris. 2000-04-25 18:03:25 +04:00			`.Nm poweroff ,`
from Lite 1995-03-18 18:17:32 +03:00			`.Nm halt`
Sync order of programs with their actions, noted by mrg. 2002-04-17 20:31:02 +04:00			`.Nd restarting, powering down and stopping the system`
from Lite 1995-03-18 18:17:32 +03:00			`.Sh SYNOPSIS`
			`.Nm halt`
Add a -p option to halt(8), specifying that the system should be powered down. 1998-06-07 01:05:41 +04:00			`.Op Fl dlnpq`
Implement a "poweroff" command which is equivalent to "halt -p", but allows powering down the system from an exec(2) call, e.g. via a user which has "poweroff" as login shell. The command name is modeled after Solaris. 2000-04-25 18:03:25 +04:00			`.Nm poweroff`
			`.Op Fl dlnq`
.Nm does not need a dummy argument ("") before punctuation or for correct formatting of the SYNOPSIS any longer. 2003-02-25 13:34:36 +03:00			`.Nm`
Sync order of programs with their actions, noted by mrg. 2002-04-17 20:31:02 +04:00			`.Op Fl dlnq`
from Lite 1995-03-18 18:17:32 +03:00			`.Sh DESCRIPTION`
			`The`
Implement a "poweroff" command which is equivalent to "halt -p", but allows powering down the system from an exec(2) call, e.g. via a user which has "poweroff" as login shell. The command name is modeled after Solaris. 2000-04-25 18:03:25 +04:00			`.Nm poweroff ,`
from Lite 1995-03-18 18:17:32 +03:00			`.Nm halt`
			`and`
- use .Nm correctly - use __progname instead of rindex(argv[0]) ... 1997-09-15 11:38:32 +04:00			`.Nm`
from Lite 1995-03-18 18:17:32 +03:00			`utilities flush the file system cache to disk, send all running processes`
Make halt and reboot wait up to 32 seconds after kill(-1, SIGTERM), but check at 3 second intervals if any are left. This will help slow machines to cleanly shut down X servers (to make the console visible), databases, or Usenet news servers. 1998-07-03 17:59:56 +04:00			`a SIGTERM, wait up to 30 seconds for them to die, send a SIGKILL to the`
Implement a "poweroff" command which is equivalent to "halt -p", but allows powering down the system from an exec(2) call, e.g. via a user which has "poweroff" as login shell. The command name is modeled after Solaris. 2000-04-25 18:03:25 +04:00			`survivors and, respectively, power down, halt or restart the system.`
from Lite 1995-03-18 18:17:32 +03:00			`The action is logged, including entering a shutdown record into the login`
"-l" means _don't_ log to syslog(3). 1999-08-19 17:43:27 +04:00			`accounting file and sending a message via`
			`.Xr syslog 3 .`
from Lite 1995-03-18 18:17:32 +03:00			`.Pp`
			`The options are as follows:`
			`.Bl -tag -width Ds`
Add a `-d' option to force a dump. From John Kohl. 1995-10-05 08:36:21 +03:00			`.It Fl d`
Clean up documentation a bit, and document the `-l' option. 1998-01-21 02:37:27 +03:00			`Create a dump before halting or restarting.`
Add a `-d' option to force a dump. From John Kohl. 1995-10-05 08:36:21 +03:00			`This option is useful for debugging system dump procedures or`
			`capturing the state of a corrupted or misbehaving system.`
Clean up documentation a bit, and document the `-l' option. 1998-01-21 02:37:27 +03:00			`.It Fl l`
"-l" means _don't_ log to syslog(3). 1999-08-19 17:43:27 +04:00			`Suppress sending a message via`
Clean up documentation a bit, and document the `-l' option. 1998-01-21 02:37:27 +03:00			`.Xr syslog 3`
			`before halting or restarting.`
			`.It Fl n`
			`Do not flush the file system cache.`
New sentence, new line. From Robert Elz. 2002-10-03 19:41:44 +04:00			`This option should be used with extreme caution.`
			`It can be used if a disk or the processor is on fire.`
Add a -p option to halt(8), specifying that the system should be powered down. 1998-06-07 01:05:41 +04:00			`.It Fl p`
New sentence, new line. From Robert Elz. 2002-10-03 19:41:44 +04:00			`Attempt to powerdown the system.`
			`If the powerdown fails, or the system does not support`
			`software powerdown, the system will halt.`
			`This option is only valid for`
Add a -p option to halt(8), specifying that the system should be powered down. 1998-06-07 01:05:41 +04:00			`.Nm halt .`
Clean up documentation a bit, and document the `-l' option. 1998-01-21 02:37:27 +03:00			`.It Fl q`
			`Do not give processes a chance to shut down before halting or restarting.`
			`This option should not normally be used.`
from Lite 1995-03-18 18:17:32 +03:00			`.El`
			`.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.`
			`.Sh SEE ALSO`
Implement a "poweroff" command which is equivalent to "halt -p", but allows powering down the system from an exec(2) call, e.g. via a user which has "poweroff" as login shell. The command name is modeled after Solaris. 2000-04-25 18:03:25 +04:00			`.Xr reboot 2 ,`
			`.Xr syslog 3 ,`
Sort SEE ALSO, use .Pp for paragraphs. 2001-11-16 15:06:32 +03:00			`.Xr utmp 5 ,`
			`.Xr boot 8 ,`
xref sync(8) not nonexistent sync(1), reorder xrefs 1997-07-22 09:35:45 +04:00			`.Xr shutdown 8 ,`
Sort SEE ALSO, use .Pp for paragraphs. 2001-11-16 15:06:32 +03:00			`.Xr sync 8`
from Lite 1995-03-18 18:17:32 +03:00			`.Sh HISTORY`
			`A`
- use .Nm correctly - use __progname instead of rindex(argv[0]) ... 1997-09-15 11:38:32 +04:00			`.Nm`
from Lite 1995-03-18 18:17:32 +03:00			`command appeared in`
			`.At v6 .`
Sort SEE ALSO, use .Pp for paragraphs. 2001-11-16 15:06:32 +03:00			`.Pp`
Implement a "poweroff" command which is equivalent to "halt -p", but allows powering down the system from an exec(2) call, e.g. via a user which has "poweroff" as login shell. The command name is modeled after Solaris. 2000-04-25 18:03:25 +04:00			`The`
			`.Nm poweroff`
			`command first appeared in`
			`.Nx 1.5 .`
Sort SEE ALSO, use .Pp for paragraphs. 2001-11-16 15:06:32 +03:00			`.Sh BUGS`
			`The single user shell will ignore the SIGTERM signal.`
			`To avoid waiting for the timeout when`
			`rebooting or halting from the single user shell, you have to`
			`.Ic exec reboot`
			`or`
			`.Ic exec halt .`