usr/src/man/man1m/add_allocatable.1m

   1 '\" te
   2 .\" Copyright (c) 2007, 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 ADD_ALLOCATABLE 1M "Jul 20, 2007"
   7 .SH NAME
   8 add_allocatable \- add entries to allocation databases
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fB/usr/sbin/add_allocatable\fR [\fB-f\fR] [\fB-s\fR] [\fB-d\fR] \fB-n\fR \fIname\fR \fB-t\fR \fItype\fR \fB-l\fR \fIdevice-list\fR
  13     [\fB-a\fR \fIauthorization\fR] [\fB-c\fR \fIclean\fR] [\fB-o\fR \fIkey\fR=\fIvalue\fR]
  14 .fi
  15
  16 .SH DESCRIPTION
  17 .sp
  18 .LP
  19 \fBadd_allocatable\fR creates new entries for user allocatable devices that are
  20 to be managed by the device allocation mechanism. \fBadd_allocatable\fR can
  21 also be used to update existing entries of such devices.
  22 .sp
  23 .LP
  24 \fBadd_allocatable\fR can also create and update entries for non-allocatable
  25 devices, such as printers, whose label range is managed by the device
  26 allocation mechanism.
  27 .sp
  28 .LP
  29 \fBadd_allocatable\fR can be used in shell scripts, such as installation
  30 scripts for driver packages, to automate the administrative work of setting up
  31 a new device.
  32 .sp
  33 .LP
  34 Use \fBlist_devices\fR(1) to see the names and types of allocatable devices,
  35 their attributes, and device paths.
  36 .SH OPTIONS
  37 .sp
  38 .ne 2
  39 .na
  40 \fB\fB-f\fR\fR
  41 .ad
  42 .RS 20n
  43 Force an update of an already-existing entry with the specified information.
  44 \fBadd_allocatable\fR exits with an error if this option is not specified when
  45 an entry with the specified device name already exists.
  46 .RE
  47
  48 .sp
  49 .ne 2
  50 .na
  51 \fB\fB-s\fR\fR
  52 .ad
  53 .RS 20n
  54 Turn on silent mode. \fBadd_allocatable\fR does not print any error or warning
  55 messages.
  56 .RE
  57
  58 .sp
  59 .ne 2
  60 .na
  61 \fB\fB-d\fR\fR
  62 .ad
  63 .RS 20n
  64 If this option is present, \fBadd_allocatable\fR updates the system-supplied
  65 default attributes of the device type specified with \fB-t\fR.
  66 .RE
  67
  68 .sp
  69 .ne 2
  70 .na
  71 \fB\fB-n\fR \fIname\fR\fR
  72 .ad
  73 .RS 20n
  74 Adds or updates an entry for device that is specified by \fIname\fR.
  75 .RE
  76
  77 .sp
  78 .ne 2
  79 .na
  80 \fB\fB-t\fR \fItype\fR\fR
  81 .ad
  82 .RS 20n
  83 Adds or updates device entries that are of a type that are specified by
  84 \fItype\fR.
  85 .RE
  86
  87 .sp
  88 .ne 2
  89 .na
  90 \fB\fB-l\fR \fIdevice-list\fR\fR
  91 .ad
  92 .RS 20n
  93 Adds or updates device paths to the device that is specified with \fB-n\fR.
  94 Multiple paths in \fIdevice-list\fR must be separated by white spaces and the
  95 list must be quoted.
  96 .RE
  97
  98 .sp
  99 .ne 2
 100 .na
 101 \fB\fB-a\fR \fIauthorization\fR\fR
 102 .ad
 103 .RS 20n
 104 Adds or updates the authorization that is associated with either the device
 105 that is specified with \fB-n\fR or with devices of the type that is specified
 106 with \fB-t\fR. When more than one authorization is specified, the list must be
 107 separated by commas and must be quoted. When the device is not allocatable,
 108 \fIauthorization\fR is specified with an asterisk (*) and must be quoted. When
 109 the device is allocatable by any user, \fIauthorization\fR is specified with
 110 the at sign (@) and must be quoted. Default authorization is '@'.
 111 .RE
 112
 113 .sp
 114 .ne 2
 115 .na
 116 \fB\fB-c\fR \fIclean\fR\fR
 117 .ad
 118 .RS 20n
 119 Specifies the \fBdevice_clean\fR(5) program \fIclean\fR to be used with the
 120 device that is specified with \fB-n\fR or with devices of the type that is
 121 specified with \fB-t\fR. The default clean program is \fB/bin/true\fR.
 122 .RE
 123
 124 .sp
 125 .ne 2
 126 .na
 127 \fB\fB-o\fR \fIkey\fR=\fIvalue\fR\fR
 128 .ad
 129 .RS 20n
 130 Accepts a string of colon-separated \fB\fIkey\fR=\fIvalue\fR\fR pairs for a
 131 device that is specified with \fB-n\fR or with devices of the type that is
 132 specified with \fB-t\fR. The following keys are currently interpreted by the
 133 system:
 134 .sp
 135 .ne 2
 136 .na
 137 \fB\fBminlabel\fR\fR
 138 .ad
 139 .RS 12n
 140 The minimum label at which the device can be used.
 141 .RE
 142
 143 .sp
 144 .ne 2
 145 .na
 146 \fB\fBmaxlabel\fR\fR
 147 .ad
 148 .RS 12n
 149 The maximum label at which the device can be used.
 150 .RE
 151
 152 .sp
 153 .ne 2
 154 .na
 155 \fB\fBclass\fR\fR
 156 .ad
 157 .RS 12n
 158 Specifies a logical  grouping of devices. For example, all Sun
 159 Ray\u\s-2TM\s+2\d devices of all device types is a logical grouping. The
 160 \fBclass\fR keyword has no default value.
 161 .RE
 162
 163 .sp
 164 .ne 2
 165 .na
 166 \fB\fBxdpy\fR\fR
 167 .ad
 168 .RS 12n
 169 Specifies the display name of the X session. This keyword is used to identify
 170 devices that are associated with the X session. The \fBxdpy\fR keyword has no
 171 default value.
 172 .RE
 173
 174 .RE
 175
 176 .SH EXIT STATUS
 177 .sp
 178 .LP
 179 When successful, \fBadd_allocate\fR returns an exit status of \fB0\fR (true).
 180 \fBadd_allocate\fR returns a nonzero exit status in the event of an error. The
 181 exit codes are as follows:
 182 .sp
 183 .ne 2
 184 .na
 185 \fB\fB1\fR\fR
 186 .ad
 187 .RS 5n
 188 Invocation syntax error
 189 .RE
 190
 191 .sp
 192 .ne 2
 193 .na
 194 \fB\fB2\fR\fR
 195 .ad
 196 .RS 5n
 197 Unknown system error
 198 .RE
 199
 200 .sp
 201 .ne 2
 202 .na
 203 \fB\fB3\fR\fR
 204 .ad
 205 .RS 5n
 206 An entry already exists for the specified device. This error occurs only when
 207 the \fB-f\fR option is not specified.
 208 .RE
 209
 210 .sp
 211 .ne 2
 212 .na
 213 \fB\fB4\fR\fR
 214 .ad
 215 .RS 5n
 216 Permission denied. User does not have DAC or MAC access record updates.
 217 .RE
 218
 219 .SH ATTRIBUTES
 220 .sp
 221 .LP
 222 See \fBattributes\fR(5) for descriptions of the following attributes:
 223 .sp
 224
 225 .sp
 226 .TS
 227 box;
 228 c | c
 229 l | l .
 230 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 231 _
 232 Interface Stability     See below.
 233 .TE
 234
 235 .sp
 236 .LP
 237 The invocation is Uncommitted. The options are Uncommitted. The output is
 238 Not-an-Interface.
 239 .SH SEE ALSO
 240 .sp
 241 .LP
 242 \fBallocate\fR(1), \fBdeallocate\fR(1), \fBlist_devices\fR(1),
 243 \fBremove_allocatable\fR(1M), \fBattributes\fR(5), \fBdevice_clean\fR(5)
 244 .SH NOTES
 245 .sp
 246 .LP
 247 The functionality described on this manual page is available only if the system
 248 is configured with Trusted Extensions.