Merge commit '008b34be09d7b9c3e7a18d3ce9ef8b5c4f4ff8b8'
[unleashed.git] / share / man / man1 / allocate.1
blob137801a6fdf95d9cb57336e571f54e732aa70b85
1 '\" te
2 .\" Copyright (c) 2008, 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 ALLOCATE 1 "Mar 6, 2017"
7 .SH NAME
8 allocate \- device allocation
9 .SH SYNOPSIS
10 .LP
11 .nf
12 \fBallocate\fR [\fB-s\fR] [\fB-w\fR] [\fB-F\fR] [\fB-U\fR \fIuname\fR] [\fB-z\fR \fIzonename\fR] \fIdevice\fR
13 .fi
15 .LP
16 .nf
17 \fBallocate\fR [\fB-s\fR] [\fB-w\fR] [\fB-F\fR] [\fB-U\fR \fIuname\fR] [\fB-z\fR \fIzonename\fR] \fB-g\fR \fIdev-type\fR
18 .fi
20 .SH DESCRIPTION
21 .LP
22 The \fBallocate\fR utility manages the ownership of devices through its
23 allocation mechanism. It ensures that each device is used by only one qualified
24 user at a time.
25 .sp
26 .LP
27 The \fIdevice\fR argument specifies the device to be manipulated. To preserve
28 the integrity of the device's owner, the allocate operation is executed on all
29 the device special files associated with that device.
30 .sp
31 .LP
32 The default allocate operation allocates the device special files associated
33 with \fIdevice\fR to the \fBuid\fR of the current process.
34 .sp
35 .LP
36 Only authorized users may allocate a device. The required authorizations are
37 specified in \fBdevice_allocate\fR(4).
38 .SH OPTIONS
39 .LP
40 The following options are supported:
41 .sp
42 .ne 2
43 .na
44 \fB\fB-F\fR \fIdevice\fR\fR
45 .ad
46 .RS 18n
47 Force allocates either free or pre-allocated devices. This option is often used
48 with the \fB-U\fR option to allocate/reallocate devices to a specific user.
49 Only those users that have \fBsolaris.device.revoke\fR authorization are
50 allowed to use this option.
51 .RE
53 .sp
54 .ne 2
55 .na
56 \fB\fB-g\fR \fIdev\(mitype\fR\fR
57 .ad
58 .RS 18n
59 Allocates devices with a device\(mitype matching \fIdev\(mitype\fR. The
60 \fIdev\(mitype\fR argument specifies the device type to be operated on.
61 .RE
63 .sp
64 .ne 2
65 .na
66 \fB\fB-s\fR\fR
67 .ad
68 .RS 18n
69 Silent. Suppresses any diagnostic output.
70 .RE
72 .sp
73 .ne 2
74 .na
75 \fB\fB-U\fR \fIuname\fR\fR
76 .ad
77 .RS 18n
78 Uses the user ID \fIuname\fR instead of the user ID of the current process when
79 performing the allocate operation. Only a user with the
80 \fBsolaris.device.revoke\fR authorization is permitted to use this option.
81 .RE
83 .SH OPERANDS
84 .LP
85 The following operands are supported:
86 .sp
87 .ne 2
88 .na
89 \fB\fIdevice\fR\fR
90 .ad
91 .RS 10n
92 Specifies the name of the device to be allocated.
93 .RE
95 .SH EXIT STATUS
96 .LP
97 The following exit values are returned:
98 .sp
99 .ne 2
101 \fB\fB0\fR\fR
103 .RS 15n
104 Successful completion.
108 .ne 2
110 \fB\fB20\fR\fR
112 .RS 15n
113 No entry for the specified device.
117 .ne 2
119 \fB\fIother value\fR\fR
121 .RS 15n
122 An error occurred.
125 .SH FILES
127 \fB/etc/security/device_allocate\fR
130 \fB/etc/security/device_maps\fR
133 \fB/etc/security/dev/*\fR
136 \fB/etc/security/lib/*\fR
137 .SH ATTRIBUTES
139 See \fBattributes\fR(5) for descriptions of the following attributes:
144 box;
145 c | c
146 l | l .
147 ATTRIBUTE TYPE  ATTRIBUTE VALUE
149 Interface Stability     See below.
154 The invocation is Uncommitted. The options are Uncommitted. The output is
155 Not-an-Interface.
156 .SH SEE ALSO
158 \fBdeallocate\fR(1), \fBlist_devices\fR(1),
159 \fBdminfo\fR(8), \fBmkdevalloc\fR(8), \fBmkdevmaps\fR(8),
160 \fBdevice_allocate\fR(4), \fBdevice_maps\fR(4), \fBattributes\fR(5)
161 .SH NOTES
163 \fB/etc/security/dev\fR, \fBmkdevalloc\fR(8), and \fBmkdevmaps\fR(8) might
164 not be supported in a future release of the Solaris Operating Environment.