xref: /openbsd/lib/libc/sys/reboot.2 (revision 07ea8d15)
1.\"   $OpenBSD: reboot.2,v 1.2 1996/10/08 01:20:13 michaels Exp $
2.\"	$NetBSD: reboot.2,v 1.5 1995/02/27 12:36:02 cgd Exp $
3.\"
4.\" Copyright (c) 1980, 1991, 1993
5.\"	The Regents of the University of California.  All rights reserved.
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.\" 3. All advertising materials mentioning features or use of this software
16.\"    must display the following acknowledgement:
17.\"	This product includes software developed by the University of
18.\"	California, Berkeley and its contributors.
19.\" 4. Neither the name of the University nor the names of its contributors
20.\"    may be used to endorse or promote products derived from this software
21.\"    without specific prior written permission.
22.\"
23.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
24.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
27.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33.\" SUCH DAMAGE.
34.\"
35.\"     @(#)reboot.2	8.1 (Berkeley) 6/4/93
36.\"
37.Dd June 4, 1993
38.Dt REBOOT 2
39.Os BSD 4
40.Sh NAME
41.Nm reboot
42.Nd reboot system or halt processor
43.Sh SYNOPSIS
44.Fd #include <unistd.h>
45.Fd #include <sys/reboot.h>
46.Ft int
47.Fn reboot "int howto"
48.Sh DESCRIPTION
49.Fn Reboot
50reboots the system.
51Only the super-user may reboot a machine on demand.
52However, a reboot is invoked
53automatically in the event of unrecoverable system failures.
54.Pp
55.Fa Howto
56is a mask of options; the system call interface allows the following
57options, defined in the include file
58.Aq Pa sys/reboot.h ,
59to be passed
60to the new kernel or the new bootstrap and init programs.
61.Bl -tag -width RB_INITNAMEA
62.It Dv RB_AUTOBOOT
63The default, causing the system to reboot in its usual fashion.
64.It Dv RB_ASKNAME
65Interpreted by the bootstrap program itself, causing it to
66prompt on the console as to what file should be booted.
67Normally, the system is booted from the file
68.Dq Em xx Ns No (0,0)bsd ,
69where
70.Em xx
71is the default disk name,
72without prompting for the file name.
73.It Dv RB_DFLTROOT
74Use the compiled in root device.
75Normally, the system uses the device from which it was booted
76as the root device if possible.
77(The default behavior is dependent on the ability of the bootstrap program
78to determine the drive from which it was loaded, which is not possible
79on all systems.)
80.It Dv RB_DUMP
81Dump kernel memory before rebooting; see
82.Xr savecore 8
83for more information.
84.It Dv RB_HALT
85the processor is simply halted; no reboot takes place.
86This option should be used with caution.
87.It Dv RB_INITNAME
88An option allowing the specification of an init program (see
89.Xr init 8 )
90other than
91.Pa /sbin/init
92to be run when the system reboots.
93This switch is not currently available.
94.It Dv RB_KDB
95Load the symbol table and enable a built-in debugger in the system.
96This option will have no useful function if the kernel is not configured
97for debugging.
98Several other options have different meaning if combined
99with this option, although their use may not be possible
100via the
101.Fn reboot
102call.
103See
104.Xr kadb 4
105for more information.
106.It Dv RB_NOSYNC
107Normally, the disks are sync'd (see
108.Xr sync 8 )
109before the processor is halted or rebooted.
110This option may be useful if file system changes have been made manually
111or if the processor is on fire.
112.It Dv RB_RDONLY
113Initially mount the root file system read-only.
114This is currently the default, and this option has been deprecated.
115.It Dv RB_SINGLE
116Normally, the reboot procedure involves an automatic disk consistency
117check and then multi-user operations.
118.Dv RB_SINGLE
119prevents this, booting the system with a single-user shell
120on the console.
121.Dv RB_SINGLE
122is actually interpreted by the
123.Xr init 8
124program in the newly booted system.
125.Pp
126When no options are given (i.e.,
127.Dv RB_AUTOBOOT
128is used), the system is
129rebooted from file ``bsd'' in the root file system of unit 0
130of a disk chosen in a processor specific way.
131An automatic consistency check of the disks is normally performed
132(see
133.Xr fsck 8 ) .
134.El
135.Sh RETURN VALUES
136If successful, this call never returns.
137Otherwise, a -1 is returned and an error is returned in the global
138variable
139.Va errno .
140.Sh ERRORS
141.Bl -tag -width Er
142.It Bq Er EPERM
143The caller is not the super-user.
144.El
145.Sh SEE ALSO
146.Xr kadb 4 ,
147.Xr crash 8 ,
148.Xr halt 8 ,
149.Xr init 8 ,
150.Xr reboot 8 ,
151.Xr savecore 8
152.Sh BUGS
153The HP300 implementation supports neither
154.Dv RB_DFLTROOT
155nor
156.Dv RB_KDB .
157.Sh HISTORY
158The
159.Fn reboot
160function call appeared in
161.Bx 4.0 .
162