xref: /dragonfly/lib/libc/sys/reboot.2 (revision 984263bc)
1.\" Copyright (c) 1980, 1991, 1993
2.\"	The Regents of the University of California.  All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\" 3. All advertising materials mentioning features or use of this software
13.\"    must display the following acknowledgement:
14.\"	This product includes software developed by the University of
15.\"	California, Berkeley and its contributors.
16.\" 4. Neither the name of the University nor the names of its contributors
17.\"    may be used to endorse or promote products derived from this software
18.\"    without specific prior written permission.
19.\"
20.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30.\" SUCH DAMAGE.
31.\"
32.\"     @(#)reboot.2	8.1 (Berkeley) 6/4/93
33.\" $FreeBSD: src/lib/libc/sys/reboot.2,v 1.9.2.4 2001/12/14 18:34:01 ru Exp $
34.\"
35.Dd June 4, 1993
36.Dt REBOOT 2
37.Os
38.Sh NAME
39.Nm reboot
40.Nd reboot system or halt processor
41.Sh LIBRARY
42.Lb libc
43.Sh SYNOPSIS
44.In unistd.h
45.In 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)kernel ,
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_POWEROFF
88After halting, the shutdown code will do what it can to turn
89off the power.
90This requires hardware support.
91.It Dv RB_INITNAME
92An option allowing the specification of an init program (see
93.Xr init 8 )
94other than
95.Pa /sbin/init
96to be run when the system reboots.
97This switch is not currently available.
98.It Dv RB_KDB
99Load the symbol table and enable a built-in debugger in the system.
100This option will have no useful function if the kernel is not configured
101for debugging.
102Several other options have different meaning if combined
103with this option, although their use may not be possible
104via the
105.Fn reboot
106call.
107See
108.Xr ddb 4
109for more information.
110.It Dv RB_NOSYNC
111Normally, the disks are sync'd (see
112.Xr sync 8 )
113before the processor is halted or rebooted.
114This option may be useful if file system changes have been made manually
115or if the processor is on fire.
116.It Dv RB_RDONLY
117Initially mount the root file system read-only.
118This is currently the default, and this option has been deprecated.
119.It Dv RB_SINGLE
120Normally, the reboot procedure involves an automatic disk consistency
121check and then multi-user operations.
122.Dv RB_SINGLE
123prevents this, booting the system with a single-user shell
124on the console.
125.Dv RB_SINGLE
126is actually interpreted by the
127.Xr init 8
128program in the newly booted system.
129.El
130.Pp
131When no options are given (i.e.,
132.Dv RB_AUTOBOOT
133is used), the system is
134rebooted from file
135.Dq kernel
136in the root file system of unit 0
137of a disk chosen in a processor specific way.
138An automatic consistency check of the disks is normally performed
139(see
140.Xr fsck 8 ) .
141.Sh RETURN VALUES
142If successful, this call never returns.
143Otherwise, a -1 is returned and an error is returned in the global
144variable
145.Va errno .
146.Sh ERRORS
147.Bl -tag -width Er
148.It Bq Er EPERM
149The caller is not the super-user.
150.El
151.Sh SEE ALSO
152.Xr crash 8 ,
153.Xr halt 8 ,
154.Xr init 8 ,
155.Xr reboot 8 ,
156.Xr savecore 8
157.Sh BUGS
158The HP300 implementation supports neither
159.Dv RB_DFLTROOT
160nor
161.Dv RB_KDB .
162.Sh HISTORY
163The
164.Fn reboot
165function call appeared in
166.Bx 4.0 .
167