original/man2/reboot.2

   1 .\" Copyright (c) 1998 Andries Brouwer (aeb@cwi.nl), 24 September 1998
   2 .\"
   3 .\" %%%LICENSE_START(VERBATIM)
   4 .\" Permission is granted to make and distribute verbatim copies of this
   5 .\" manual provided the copyright notice and this permission notice are
   6 .\" preserved on all copies.
   7 .\"
   8 .\" Permission is granted to copy and distribute modified versions of this
   9 .\" manual under the conditions for verbatim copying, provided that the
  10 .\" entire resulting derived work is distributed under the terms of a
  11 .\" permission notice identical to this one.
  12 .\"
  13 .\" Since the Linux kernel and libraries are constantly changing, this
  14 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
  15 .\" responsibility for errors or omissions, or for damages resulting from
  16 .\" the use of the information contained herein.  The author(s) may not
  17 .\" have taken the same level of care in the production of this manual,
  18 .\" which is licensed free of charge, as they might when working
  19 .\" professionally.
  20 .\"
  21 .\" Formatted or processed versions of this manual, if unaccompanied by
  22 .\" the source, must acknowledge the copyright and authors of this work.
  23 .\" %%%LICENSE_END
  24 .\"
  25 .\" Modified, 27 May 2004, Michael Kerrisk <mtk.manpages@gmail.com>
  26 .\"     Added notes on capability requirements
  27 .\"
  28 .TH REBOOT 2 2013-12-28 "Linux" "Linux Programmer's Manual"
  29 .SH NAME
  30 reboot \- reboot or enable/disable Ctrl-Alt-Del
  31 .SH SYNOPSIS
  32 /* For libc4 and libc5 the library call and the system call
  33    are identical, and since kernel version 2.1.30 there are
  34    symbolic names LINUX_REBOOT_* for the constants and a
  35    fourth argument to the call: */
  36 .sp
  37 .B #include <unistd.h>
  38 .br
  39 .B #include <linux/reboot.h>
  40 .sp
  41 .BI "int reboot(int " magic ", int " magic2 ", int " cmd ", void *" arg );
  42 .sp
  43 /* Under glibc some of the constants involved have gotten
  44    symbolic names RB_*, and the library call is a 1-argument
  45    wrapper around the 3-argument system call: */
  46 .sp
  47 .B #include <unistd.h>
  48 .br
  49 .B #include <sys/reboot.h>
  50 .sp
  51 .BI "int reboot(int " cmd );
  52 .SH DESCRIPTION
  53 The
  54 .BR reboot ()
  55 call reboots the system, or enables/disables the reboot keystroke
  56 (abbreviated CAD, since the default is Ctrl-Alt-Delete;
  57 it can be changed using
  58 .BR loadkeys (1)).
  59 .PP
  60 This system call will fail (with
  61 .BR EINVAL )
  62 unless
  63 .I magic
  64 equals
  65 .B LINUX_REBOOT_MAGIC1
  66 (that is, 0xfee1dead) and
  67 .I magic2
  68 equals
  69 .B LINUX_REBOOT_MAGIC2
  70 (that is, 672274793).
  71 However, since 2.1.17 also
  72 .B LINUX_REBOOT_MAGIC2A
  73 (that is, 85072278)
  74 and since 2.1.97 also
  75 .B LINUX_REBOOT_MAGIC2B
  76 (that is, 369367448)
  77 and since 2.5.71 also
  78 .B LINUX_REBOOT_MAGIC2C
  79 (that is, 537993216)
  80 are permitted as value for
  81 .IR magic2 .
  82 (The hexadecimal values of these constants are meaningful.)
  83 The
  84 .I cmd
  85 argument can have the following values:
  86 .TP
  87 .B LINUX_REBOOT_CMD_CAD_OFF
  88 .RB ( RB_DISABLE_CAD ,
  89 0).
  90 CAD is disabled.
  91 This means that the CAD keystroke will cause a
  92 .B SIGINT
  93 signal to be
  94 sent to init (process 1), whereupon this process may decide upon a
  95 proper action (maybe: kill all processes, sync, reboot).
  96 .TP
  97 .B LINUX_REBOOT_CMD_CAD_ON
  98 .RB ( RB_ENABLE_CAD ,
  99 0x89abcdef).
 100 CAD is enabled.
 101 This means that the CAD keystroke will immediately cause
 102 the action associated with
 103 .BR LINUX_REBOOT_CMD_RESTART .
 104 .TP
 105 .B LINUX_REBOOT_CMD_HALT
 106 .RB ( RB_HALT_SYSTEM ,
 107 0xcdef0123; since Linux 1.1.76).
 108 The message "System halted." is printed, and the system is halted.
 109 Control is given to the ROM monitor, if there is one.
 110 If not preceded by a
 111 .BR sync (2),
 112 data will be lost.
 113 .TP
 114 .BR LINUX_REBOOT_CMD_KEXEC
 115 .RB ( RB_KEXEC ,
 116 0x45584543, since Linux 2.6.13).
 117 Execute a kernel that has been loaded earlier with
 118 .BR kexec_load (2).
 119 This option is available only if the kernel was configured with
 120 .BR CONFIG_KEXEC .
 121 .TP
 122 .B LINUX_REBOOT_CMD_POWER_OFF
 123 .RB ( RB_POWER_OFF ,
 124 0x4321fedc; since Linux 2.1.30).
 125 The message "Power down." is printed, the system is stopped,
 126 and all power is removed from the system, if possible.
 127 If not preceded by a
 128 .BR sync (2),
 129 data will be lost.
 130 .TP
 131 .B LINUX_REBOOT_CMD_RESTART
 132 .RB ( RB_AUTOBOOT ,
 133 0x1234567).
 134 The message "Restarting system." is printed, and a default
 135 restart is performed immediately.
 136 If not preceded by a
 137 .BR sync (2),
 138 data will be lost.
 139 .TP
 140 .B LINUX_REBOOT_CMD_RESTART2
 141 (0xa1b2c3d4; since Linux 2.1.30).
 142 The message "Restarting system with command \(aq%s\(aq" is printed,
 143 and a restart (using the command string given in
 144 .IR arg )
 145 is performed immediately.
 146 If not preceded by a
 147 .BR sync (2),
 148 data will be lost.
 149 .TP
 150 .BR LINUX_REBOOT_CMD_SW_SUSPEND
 151 .RB ( RB_SW_SUSPEND ,
 152 0xd000fce1; since Linux 2.5.18).
 153 The system is suspended (hibernated) to disk.
 154 This option is available only if the kernel was configured with
 155 .BR CONFIG_HIBERNATION .
 156 .LP
 157 Only the superuser may call
 158 .BR reboot ().
 159 .LP
 160 The precise effect of the above actions depends on the architecture.
 161 For the i386 architecture, the additional argument does not do
 162 anything at present (2.1.122), but the type of reboot can be
 163 determined by kernel command-line arguments ("reboot=...") to be
 164 either warm or cold, and either hard or through the BIOS.
 165 .SH RETURN VALUE
 166 For the values of
 167 .I cmd
 168 that stop or restart the system,
 169 a successful call to
 170 .BR reboot ()
 171 does not return.
 172 For the other
 173 .I cmd
 174 values, zero is returned on success.
 175 In all cases, \-1 is returned on failure, and
 176 .I errno
 177 is set appropriately.
 178 .SH ERRORS
 179 .TP
 180 .B EFAULT
 181 Problem with getting user-space data under
 182 .BR LINUX_REBOOT_CMD_RESTART2 .
 183 .TP
 184 .B EINVAL
 185 Bad magic numbers or \fIcmd\fP.
 186 .TP
 187 .B EPERM
 188 The calling process has insufficient privilege to call
 189 .BR reboot ();
 190 the
 191 .B CAP_SYS_BOOT
 192 capability is required.
 193 .SH CONFORMING TO
 194 .BR reboot ()
 195 is Linux-specific,
 196 and should not be used in programs intended to be portable.
 197 .SH SEE ALSO
 198 .BR sync (2),
 199 .BR bootparam (7),
 200 .BR capabilities (7),
 201 .BR ctrlaltdel (8),
 202 .BR halt (8),
 203 .BR reboot (8)
 204 .SH COLOPHON
 205 This page is part of release 3.67 of the Linux
 206 .I man-pages
 207 project.
 208 A description of the project,
 209 information about reporting bugs,
 210 and the latest version of this page,
 211 can be found at
 212 \%http://www.kernel.org/doc/man\-pages/.