Unleashed v1.4
[unleashed.git] / bin / uadmin / uadmin.8
blob453847f1c1113378fce764759d3d575d388ab14c
1 '\" te
2 .\"  Copyright 1989 AT&T Copyright (c) 2009, 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. You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.
4 .\"  See the License for the specific language governing permissions and limitations under the License. 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
5 .\" the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
6 .TH UADMIN 8 "Mar 25, 2009"
7 .SH NAME
8 uadmin \- administrative control
9 .SH SYNOPSIS
10 .LP
11 .nf
12 \fB/usr/sbin/uadmin\fR \fIcmd\fR \fIfcn\fR [\fImdep\fR]
13 .fi
15 .LP
16 .nf
17 \fB/sbin/uadmin\fR \fIcmd\fR \fIfcn\fR [\fImdep\fR]
18 .fi
20 .SH DESCRIPTION
21 .sp
22 .LP
23 The \fBuadmin\fR command provides control for basic administrative functions.
24 This command is tightly coupled to the system administration procedures and is
25 not intended for general use. It may be invoked only by the super-user.
26 .sp
27 .LP
28 Both the \fIcmd\fR (command) and \fIfcn\fR (function) arguments are converted
29 to integers and passed to the \fBuadmin\fR system call. The optional \fImdep\fR
30 (machine dependent) argument is only available for the \fIcmd\fR values of
31 \fB1\fR (\fBA_REBOOT\fR), \fB2\fR (\fBA_SHUTDOWN\fR), or \fB5\fR
32 (\fBA_DUMP\fR). For any other \fIcmd\fR value, no \fImdep\fR command-line
33 argument is allowed.
34 .sp
35 .LP
36 When passing an \fImdep\fR value that contains whitespaces, the string must be
37 grouped together as a single argument enclosed within quotes, for example:
38 .sp
39 .in +2
40 .nf
41 uadmin 1 1 "\fB-s\fR kernel/unix"
42 .fi
43 .in -2
44 .sp
46 .SH SEE ALSO
47 .sp
48 .LP
49 \fBhalt\fR(8), \fBreboot\fR(8), \fBuadmin\fR(2), \fBattributes\fR(5)
50 .SH WARNINGS
51 .sp
52 .LP
53 Shutting down or halting the system by means of \fBuadmin\fR does not  update
54 the  boot  archive.  Avoid  using  this command after
55 .RS +4
56 .TP
57 .ie t \(bu
58 .el o
59 editing of files such as \fB/etc/system\fR
60 .RE
61 .RS +4
62 .TP
63 .ie t \(bu
64 .el o
65 installing new driver binaries or kernel binaries
66 .RE
67 .RS +4
68 .TP
69 .ie t \(bu
70 .el o
71 updating existing driver binaries or kernel binaries.
72 .RE
73 .sp
74 .LP
75 Use \fBreboot\fR(8) or \fBhalt\fR(8) instead.