xref: /dragonfly/share/man/man9/boot.9 (revision 984263bc)
1.\"	$NetBSD: boot.9,v 1.2 1996/09/24 07:01:26 ghudson Exp $
2.\"
3.\" Copyright (c) 1997
4.\" 	Mike Pritchard.  All rights reserved.
5.\"
6.\" Copyright (c) 1994 Christopher G. Demetriou
7.\" All rights reserved.
8.\"
9.\" Redistribution and use in source and binary forms, with or without
10.\" modification, are permitted provided that the following conditions
11.\" are met:
12.\" 1. Redistributions of source code must retain the above copyright
13.\"    notice, this list of conditions and the following disclaimer.
14.\" 2. Redistributions in binary form must reproduce the above copyright
15.\"    notice, this list of conditions and the following disclaimer in the
16.\"    documentation and/or other materials provided with the distribution.
17.\" 3. All advertising materials mentioning features or use of this software
18.\"    must display the following acknowledgement:
19.\"      This product includes software developed by Christopher G. Demetriou
20.\"      for the NetBSD Project.
21.\" 3. The name of the author may not be used to endorse or promote products
22.\"    derived from this software without specific prior written permission
23.\"
24.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
25.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
26.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
27.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
28.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
29.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
30.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
31.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
32.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
33.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34.\"
35.\" $FreeBSD: src/share/man/man9/boot.9,v 1.4.2.2 2001/12/17 11:30:18 ru Exp $
36.\"
37.Dd February 14, 1997
38.Dt BOOT 9
39.Os
40.Sh NAME
41.Nm boot
42.Nd halt or reboot the system
43.Sh SYNOPSIS
44.In sys/types.h
45.In sys/systm.h
46.In sys/reboot.h
47.Ft void
48.Fn boot "int howto"
49.Sh DESCRIPTION
50The
51.Fn boot
52function handles final system shutdown, and either halts or reboots
53the system.  The exact action to be taken is determined by the
54flags passed in
55.Fa howto
56and by whether or not the system has finished autoconfiguration.
57.Pp
58If the system has finished autoconfiguration,
59.Fn boot
60does the following:
61.Bl -enum -offset indent
62.It
63If this is the first invocation of
64.Fn boot
65and the
66.Dv RB_NOSYNC
67flag is not set in
68.Fa howto ,
69syncs and unmounts the system disks by calling
70.Xr vfs_unmountall 9 .
71.It
72Disables interrupts.
73.It
74If rebooting after a crash (i.e. if
75.Dv RB_DUMP
76is set in
77.Fa howto ,
78but
79.Dv RB_HALT
80is not), saves a system crash dump.
81.It
82Runs any shutdown hooks previously set by
83.Xr at_shutdown 9 .
84.It
85Prints a message indicating that the system is about to be halted
86or rebooted.
87.It
88If
89.Dv RB_HALT
90is set in
91.Fa howto ,
92halts the system.
93Otherwise, reboots the system.
94.El
95.Pp
96If the system has not finished autoconfiguration,
97.Fn boot
98runs any shutdown hooks previously set by
99.Xr at_shutdown 9 ,
100prints a message, and halts the system.
101.Sh SEE ALSO
102.Xr at_shutdown 9 ,
103.Xr vfs_unmountall 9
104