freebsd-nq/share/man/man9/boot.9

.\"	$NetBSD: boot.9,v 1.2 1996/09/24 07:01:26 ghudson Exp $
.\"
.\" Copyright (c) 1997
.\" 	Mike Pritchard.  All rights reserved.
.\"
.\" Copyright (c) 1994 Christopher G. Demetriou
.\" 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 Christopher G. Demetriou
.\"      for the NetBSD Project.
.\" 3. The name of the author may not be used to endorse or promote products
.\"    derived from this software without specific prior written permission
.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``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 AUTHOR 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.
.\"
.\" $FreeBSD$
.\"
.Dd February 14, 1997
.Dt BOOT 9
.Os
.Sh NAME
.Nm boot
.Nd halt or reboot the system
.Sh SYNOPSIS
.Fd #include <sys/types.h>
.Fd #include <sys/systm.h>
.Fd #include <sys/reboot.h>
.Ft void
.Fn boot "int howto"
.Sh DESCRIPTION
The
.Fn boot
function handles final system shutdown, and either halts or reboots
the system.  The exact action to be taken is determined by the
flags passed in
.Fa howto
and by whether or not the system has finished autoconfiguration.
.Pp
If the system has finished autoconfiguration,
.Fn boot
does the following:
.Bl -enum -offset indent
.It
If this is the first invocation of
.Fn boot
and the
.Dv RB_NOSYNC
flag is not set in
.Fa howto ,
syncs and unmounts the system disks by calling
.Xr vfs_unmountall 9 .
.It
Disables interrupts.
.It
If rebooting after a crash (i.e. if
.Dv RB_DUMP
is set in
.Fa howto ,
but
.Dv RB_HALT
is not), saves a system crash dump.
.It
Runs any shutdown hooks previously registered.
.It
Prints a message indicating that the system is about to be halted
or rebooted.
.It
If
.Dv RB_HALT
is set in
.Fa howto ,
halts the system.
Otherwise, reboots the system.
.El
.Pp
If the system has not finished autoconfiguration,
.Fn boot
runs any shutdown hooks previously registered,
prints a message, and halts the system.
.Sh SEE ALSO
.Xr vfs_unmountall 9
Add boot(9) Obtained from NetBSD w/modifications by me. 1997-02-14 07:06:26 +00:00			`.\" $NetBSD: boot.9,v 1.2 1996/09/24 07:01:26 ghudson Exp $`
			`.\"`
			`.\" Copyright (c) 1997`
			`.\" Mike Pritchard. All rights reserved.`
			`.\"`
			`.\" Copyright (c) 1994 Christopher G. Demetriou`
			`.\" 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 Christopher G. Demetriou`
			`.\" for the NetBSD Project.`
			`.\" 3. The name of the author may not be used to endorse or promote products`
			`.\" derived from this software without specific prior written permission`
			`.\"`
			.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``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 AUTHOR 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.`
			`.\"`
$Id$ -> $FreeBSD$ 1999-08-28 00:22:10 +00:00			`.\" $FreeBSD$`
Add $Id$, to make it simpler for members of the translation teams to track. The $Id$ line is normally at the bottom of the main comment block in the man page, separated from the rest of the manpage by an empty comment, like so; .\" $Id$ .\" If the immediately preceding comment is a @(#) format ID marker than the the $Id$ will line up underneath it with no intervening blank lines. Otherwise, an additional blank line is inserted. Approved by: bde 1999-07-12 21:02:10 +00:00			`.\"`
Add boot(9) Obtained from NetBSD w/modifications by me. 1997-02-14 07:06:26 +00:00			`.Dd February 14, 1997`
			`.Dt BOOT 9`
			`.Os`
			`.Sh NAME`
			`.Nm boot`
			`.Nd halt or reboot the system`
			`.Sh SYNOPSIS`
Fixed #include(s) in the synopsis to actually declare the function(s) in the synopsis. 1997-04-11 17:58:16 +00:00			`.Fd #include <sys/types.h>`
			`.Fd #include <sys/systm.h>`
Add boot(9) Obtained from NetBSD w/modifications by me. 1997-02-14 07:06:26 +00:00			`.Fd #include <sys/reboot.h>`
			`.Ft void`
			`.Fn boot "int howto"`
			`.Sh DESCRIPTION`
			`The`
			`.Fn boot`
			`function handles final system shutdown, and either halts or reboots`
			`the system. The exact action to be taken is determined by the`
			`flags passed in`
			`.Fa howto`
			`and by whether or not the system has finished autoconfiguration.`
			`.Pp`
			`If the system has finished autoconfiguration,`
			`.Fn boot`
			`does the following:`
			`.Bl -enum -offset indent`
			`.It`
			`If this is the first invocation of`
			`.Fn boot`
			`and the`
			`.Dv RB_NOSYNC`
			`flag is not set in`
			`.Fa howto ,`
			`syncs and unmounts the system disks by calling`
			`.Xr vfs_unmountall 9 .`
			`.It`
			`Disables interrupts.`
			`.It`
			`If rebooting after a crash (i.e. if`
			`.Dv RB_DUMP`
			`is set in`
			`.Fa howto ,`
			`but`
			`.Dv RB_HALT`
			`is not), saves a system crash dump.`
			`.It`
at_shutdown(9) hasn't existed since revision 1.61 of kern_shutdown.c. 2001-09-03 16:42:35 +00:00			`Runs any shutdown hooks previously registered.`
Add boot(9) Obtained from NetBSD w/modifications by me. 1997-02-14 07:06:26 +00:00			`.It`
			`Prints a message indicating that the system is about to be halted`
			`or rebooted.`
			`.It`
			`If`
			`.Dv RB_HALT`
			`is set in`
			`.Fa howto ,`
			`halts the system.`
			`Otherwise, reboots the system.`
			`.El`
			`.Pp`
			`If the system has not finished autoconfiguration,`
			`.Fn boot`
More at_shutdown(9) removal. 2001-09-04 10:12:11 +00:00			`runs any shutdown hooks previously registered,`
Add boot(9) Obtained from NetBSD w/modifications by me. 1997-02-14 07:06:26 +00:00			`prints a message, and halts the system.`
			`.Sh SEE ALSO`
			`.Xr vfs_unmountall 9`