usr/src/man/man3c/reboot.3c

   1 '\" te
   2 .\" Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved.
   3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH REBOOT 3C "Mar 22, 2004"
   7 .SH NAME
   8 reboot \- reboot system or halt processor
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 #include <sys/reboot.h>
  13
  14 \fBint\fR \fBreboot\fR(\fBint\fR \fIhowto\fR, \fBchar *\fR\fIbootargs\fR);
  15 .fi
  16
  17 .SH DESCRIPTION
  18 .sp
  19 .LP
  20 The \fBreboot()\fR function reboots the system.  The \fIhowto\fR argument
  21 specifies the behavior of the system while rebooting and is a mask constructed
  22 by a bitwise-inclusive-OR of flags from the following list:
  23 .sp
  24 .ne 2
  25 .na
  26 \fB\fBRB_AUTOBOOT\fR\fR
  27 .ad
  28 .RS 15n
  29 The machine is rebooted from the root filesystem on the default boot device.
  30 This is the default behavior. See \fBboot\fR(1M) and \fBkernel\fR(1M).
  31 .RE
  32
  33 .sp
  34 .ne 2
  35 .na
  36 \fB\fBRB_HALT\fR\fR
  37 .ad
  38 .RS 15n
  39 The processor is simply halted; no reboot takes place. This option should be
  40 used with caution.
  41 .RE
  42
  43 .sp
  44 .ne 2
  45 .na
  46 \fB\fBRB_ASKNAME\fR\fR
  47 .ad
  48 .RS 15n
  49 Interpreted by the bootstrap program and kernel, causing the user to be asked
  50 for pathnames during the bootstrap.
  51 .RE
  52
  53 .sp
  54 .ne 2
  55 .na
  56 \fB\fBRB_DUMP\fR\fR
  57 .ad
  58 .RS 15n
  59 The system is forced to panic immediately without any further processing and a
  60 crash dump is written to the dump device (see \fBdumpadm\fR(1M)) before
  61 rebooting.
  62 .RE
  63
  64 .sp
  65 .LP
  66 Any other \fIhowto\fR argument causes the kernel file to boot.
  67 .sp
  68 .LP
  69 The interpretation of the \fIbootargs\fR argument is platform-dependent.
  70 .SH RETURN VALUES
  71 .sp
  72 .LP
  73 Upon successful completion, \fBreboot()\fR never returns.  Otherwise,
  74 \fB\(mi1\fR is returned and \fBerrno\fR is set to indicate the error.
  75 .SH ERRORS
  76 .sp
  77 .LP
  78 The \fBreboot()\fR function will fail if:
  79 .sp
  80 .ne 2
  81 .na
  82 \fB\fBEPERM\fR\fR
  83 .ad
  84 .RS 9n
  85 The {\fBPRIV_SYS_CONFIG\fR} privilege is not asserted in the effective set of
  86 the calling process.
  87 .RE
  88
  89 .SH SEE ALSO
  90 .sp
  91 .LP
  92 \fBIntro\fR(1M), \fBboot\fR(1M), \fBdumpadm\fR(1M), \fBhalt\fR(1M),
  93 \fBinit\fR(1M), \fBkernel\fR(1M), \fBreboot\fR(1M), \fBuadmin\fR(2)