usr/src/man/man4/admin.4

   1 '\" te
   2 .\"  Copyright (c) 2017 Peter Tribble.
   3 .\"  Copyright 1989 AT&T Copyright (c) 1997, Sun Microsystems, Inc. All Rights Reserved
   4 .\" 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.
   5 .\" 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.
   6 .\" 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]
   7 .TH ADMIN 4 "Mar 2, 2017"
   8 .SH NAME
   9 admin \- installation defaults file
  10 .SH DESCRIPTION
  11 .LP
  12 \fBadmin\fR is a generic name for an \fBASCII\fR file that defines default
  13 installation actions by assigning values to installation parameters. For
  14 example, it allows administrators to define how to proceed when the package
  15 being installed already exists on the system.
  16 .sp
  17 .LP
  18 \fB/var/sadm/install/admin/default\fR is the default \fBadmin\fR file delivered
  19 with this release. The default file is not writable, so to assign values
  20 different from this file, create a new \fBadmin\fR file. There are no naming
  21 restrictions for \fBadmin\fR files. Name the file when installing a package
  22 with the \fB-a\fR option of \fBpkgadd\fR(1M). If the \fB-a\fR option is not
  23 used, the default \fBadmin\fR file is used.
  24 .sp
  25 .LP
  26 Each entry in the \fBadmin\fR file is a line that establishes the value of a
  27 parameter in the following form:
  28 .sp
  29 .LP
  30 \fIparam\fR\fB=\fR\fIvalue\fR
  31 .sp
  32 .LP
  33 All of the parameters listed below can be defined in an \fBadmin\fR file, but
  34 it is not required to assign values to all of these. If a value is not
  35 assigned, \fBpkgadd\fR(1M) asks the installer how to proceed.
  36 .sp
  37 .LP
  38 The valid parameters and their possible values are shown below except as noted.
  39 They can be specified in any order. Any of these parameters (except the
  40 \fBmail\fR parameter) can be assigned the value \fBask\fR,
  41 which means that, when the parameter is reached during the installation
  42 sequence, the installer is notified and asked to supply instructions (see
  43 \fBNOTES\fR).
  44 .sp
  45 .ne 2
  46 .na
  47 \fB\fBbasedir\fR\fR
  48 .ad
  49 .RS 30n
  50 Indicates the base directory where relocatable packages are to be installed. If
  51 there is no \fBbasedir\fR entry in the file, the installer will be prompted for
  52 a path name, as if the file contained the entry \fBbasedir=ask\fR. This
  53 parameter can also be set to \fBdefault\fR (entry is \fBbasedir=default\fR). In
  54 this instance, the package is installed into the base directory specified by
  55 the \fBBASEDIR\fR parameter in the \fBpkginfo\fR(4) file.
  56 .RE
  57
  58 .sp
  59 .ne 2
  60 .na
  61 \fB\fBmail\fR\fR
  62 .ad
  63 .RS 30n
  64 Defines a list of users to whom mail should be sent following installation of a
  65 package. If the list is empty, no mail is sent. If the parameter is not present
  66 in the \fBadmin\fR file, the default value of \fBroot\fR is used. The \fBask\fR
  67 value cannot be used with this parameter.
  68 .RE
  69
  70 .sp
  71 .ne 2
  72 .na
  73 \fB\fBrunlevel\fR\fR
  74 .ad
  75 .RS 30n
  76 Indicates resolution if the run level is not correct for the installation or
  77 removal of a package. Options are:
  78 .sp
  79 .ne 2
  80 .na
  81 \fB\fBnocheck\fR\fR
  82 .ad
  83 .RS 11n
  84 Do not check for run level.
  85 .RE
  86
  87 .sp
  88 .ne 2
  89 .na
  90 \fB\fBquit\fR\fR
  91 .ad
  92 .RS 11n
  93 Abort installation if run level is not met.
  94 .RE
  95
  96 .RE
  97
  98 .sp
  99 .ne 2
 100 .na
 101 \fB\fBconflict\fR\fR
 102 .ad
 103 .RS 30n
 104 Specifies what to do if an installation expects to overwrite a previously
 105 installed file, thus creating a conflict between packages. Options are:
 106 .sp
 107 .ne 2
 108 .na
 109 \fB\fBnocheck\fR\fR
 110 .ad
 111 .RS 12n
 112 Do not check for conflict; files in conflict will be overwritten.
 113 .RE
 114
 115 .sp
 116 .ne 2
 117 .na
 118 \fB\fBquit\fR\fR
 119 .ad
 120 .RS 12n
 121 Abort installation if conflict is detected.
 122 .RE
 123
 124 .sp
 125 .ne 2
 126 .na
 127 \fB\fBnochange\fR\fR
 128 .ad
 129 .RS 12n
 130 Override installation of conflicting files; they will not be installed.
 131 .RE
 132
 133 .RE
 134
 135 .sp
 136 .ne 2
 137 .na
 138 \fB\fBsetuid\fR\fR
 139 .ad
 140 .RS 30n
 141 Checks for executables which will have setuid or setgid bits enabled after
 142 installation. Options are:
 143 .sp
 144 .ne 2
 145 .na
 146 \fB\fBnocheck\fR\fR
 147 .ad
 148 .RS 12n
 149 Do not check for setuid executables.
 150 .RE
 151
 152 .sp
 153 .ne 2
 154 .na
 155 \fB\fBquit\fR\fR
 156 .ad
 157 .RS 12n
 158 Abort installation if setuid processes are detected.
 159 .RE
 160
 161 .sp
 162 .ne 2
 163 .na
 164 \fB\fBnochange\fR\fR
 165 .ad
 166 .RS 12n
 167 Override installation of setuid processes; processes will be installed without
 168 setuid bits enabled.
 169 .RE
 170
 171 .RE
 172
 173 .sp
 174 .ne 2
 175 .na
 176 \fB\fBaction\fR\fR
 177 .ad
 178 .RS 30n
 179 Determines if action scripts provided by package developers contain possible
 180 security impact. Options are:
 181 .sp
 182 .ne 2
 183 .na
 184 \fB\fBnocheck\fR\fR
 185 .ad
 186 .RS 11n
 187 Ignore security impact of action scripts.
 188 .RE
 189
 190 .sp
 191 .ne 2
 192 .na
 193 \fB\fBquit\fR\fR
 194 .ad
 195 .RS 11n
 196 Abort installation if action scripts may have a negative security impact.
 197 .RE
 198
 199 .RE
 200
 201 .sp
 202 .ne 2
 203 .na
 204 \fB\fBpartial\fR\fR
 205 .ad
 206 .RS 30n
 207 Checks to see if a version of the package is already partially installed on the
 208 system. Options are:
 209 .sp
 210 .ne 2
 211 .na
 212 \fB\fBnocheck\fR\fR
 213 .ad
 214 .RS 11n
 215 Do not check for a partially installed package.
 216 .RE
 217
 218 .sp
 219 .ne 2
 220 .na
 221 \fB\fBquit\fR\fR
 222 .ad
 223 .RS 11n
 224 Abort installation if a partially installed package exists.
 225 .RE
 226
 227 .RE
 228
 229 .sp
 230 .ne 2
 231 .na
 232 \fB\fBinstance\fR\fR
 233 .ad
 234 .RS 30n
 235 Determines how to handle installation if a previous version of the package
 236 (including a partially installed instance) already exists. Options are:
 237 .sp
 238 .ne 2
 239 .na
 240 \fB\fBquit\fR\fR
 241 .ad
 242 .RS 13n
 243 Exit without installing if an instance of the package already exists (does not
 244 overwrite existing packages).
 245 .RE
 246
 247 .sp
 248 .ne 2
 249 .na
 250 \fB\fBoverwrite\fR\fR
 251 .ad
 252 .RS 13n
 253 Overwrite an existing package if only one instance exists. If there is more
 254 than one instance, but only one has the same architecture, it overwrites that
 255 instance. Otherwise, the installer is prompted with existing instances and
 256 asked which to overwrite.
 257 .RE
 258
 259 .sp
 260 .ne 2
 261 .na
 262 \fB\fBunique\fR\fR
 263 .ad
 264 .RS 13n
 265 Do not overwrite an existing instance of a package. Instead, a new instance of
 266 the package is created. The new instance will be assigned the next available
 267 instance identifier.
 268 .RE
 269
 270 .RE
 271
 272 .sp
 273 .ne 2
 274 .na
 275 \fB\fBidepend\fR\fR
 276 .ad
 277 .RS 30n
 278 Controls resolution if the package to be installed depends on other packages
 279 and if other packages depend on the one to be installed. Options are:
 280 .sp
 281 .ne 2
 282 .na
 283 \fB\fBnocheck\fR\fR
 284 .ad
 285 .RS 11n
 286 Do not check package dependencies.
 287 .RE
 288
 289 .sp
 290 .ne 2
 291 .na
 292 \fB\fBquit\fR\fR
 293 .ad
 294 .RS 11n
 295 Abort installation if package dependencies are not met.
 296 .RE
 297
 298 .RE
 299
 300 .sp
 301 .ne 2
 302 .na
 303 \fB\fBrdepend\fR\fR
 304 .ad
 305 .RS 30n
 306 Controls resolution if other packages depend on the package to be removed. Also
 307 determines behavior if registered products components to be removed. See
 308 \fBlibwsreg\fR(3LIB) and \fBprodreg\fR(1M) for a definition of product
 309 components. Options are:
 310 .sp
 311 .ne 2
 312 .na
 313 \fB\fBnocheck\fR\fR
 314 .ad
 315 .RS 11n
 316 Do not check package or product dependencies.
 317 .RE
 318
 319 .sp
 320 .ne 2
 321 .na
 322 \fB\fBquit\fR\fR
 323 .ad
 324 .RS 11n
 325 Abort removal if package or product dependencies are not met.
 326 .RE
 327
 328 .RE
 329
 330 .sp
 331 .ne 2
 332 .na
 333 \fB\fBspace\fR\fR
 334 .ad
 335 .RS 30n
 336 Controls resolution if disk space requirements for package are not met. Options
 337 are:
 338 .sp
 339 .ne 2
 340 .na
 341 \fB\fBnocheck\fR\fR
 342 .ad
 343 .RS 11n
 344 Do not check space requirements (installation fails if it runs out of space).
 345 .RE
 346
 347 .sp
 348 .ne 2
 349 .na
 350 \fB\fBquit\fR\fR
 351 .ad
 352 .RS 11n
 353 Abort installation if space requirements are not met.
 354 .RE
 355
 356 .RE
 357
 358 .sp
 359 .ne 2
 360 .na
 361 \fB\fBrscriptalt=root | noaccess\fR\fR
 362 .ad
 363 .RS 30n
 364 Determines the user that will run request scripts. This parameter can have
 365 either of the values described below. See \fBpkgadd\fR(1M) for details on the
 366 conditions under which this parameter is useful.
 367 .sp
 368 .ne 2
 369 .na
 370 \fB\fBroot\fR\fR
 371 .ad
 372 .RS 12n
 373 Run request script as user \fBinstall\fR, if such a user exists, with the
 374 privileges of that user. Otherwise, run script as user \fBroot\fR, with UID
 375 equal to 0 and with all/zone privileges. (See \fBzones\fR(5).)
 376 .RE
 377
 378 .sp
 379 .ne 2
 380 .na
 381 \fB\fBnoaccess\fR\fR
 382 .ad
 383 .RS 12n
 384 Run request script as user \fBinstall\fR, if such a user exists, with the
 385 privileges of that user. Otherwise, run script as user \fBnoaccess\fR, with the
 386 basic privileges of the unprivileged user \fBnoaccess\fR.
 387 .RE
 388
 389 If this parameter is not present or has a null value, the user \fBnoaccess\fR
 390 is assumed. Likewise, if this parameter is set to anything other than the
 391 values described here, a warning is issued, and \fBnoaccess\fR is assumed.
 392 \fBrscriptalt\fR is not present in the default  \fBadmin\fR file,
 393 \fB/var/sadm/install/admin/default\fR. In this case, request scripts are run as
 394 the user \fBnoaccess\fR.
 395 .RE
 396
 397 .SH EXAMPLES
 398 .LP
 399 \fBExample 1 \fRDefault \fBadmin\fR File
 400 .sp
 401 .LP
 402 The default \fBadmin\fR file, named \fBdefault\fR, is shipped with user-,
 403 group-, and world-read privileges (444). Its contents are as follows:
 404
 405 .sp
 406 .in +2
 407 .nf
 408 mail=
 409 instance=unique
 410 partial=ask
 411 runlevel=ask
 412 idepend=ask
 413 rdepend=ask
 414 space=ask
 415 setuid=ask
 416 conflict=ask
 417 action=ask
 418 basedir=default
 419 .fi
 420 .in -2
 421 .sp
 422
 423 .LP
 424 \fBExample 2 \fRSample \fBadmin\fR file.
 425 .sp
 426 .LP
 427 Below is a sample \fBadmin\fR file.
 428
 429 .sp
 430 .in +2
 431 .nf
 432 basedir=default
 433 runlevel=quit
 434 conflict=quit
 435 setuid=quit
 436 action=quit
 437 partial=quit
 438 instance=unique
 439 idepend=quit
 440 rdepend=quit
 441 space=quit
 442 .fi
 443 .in -2
 444 .sp
 445
 446 .SH FILES
 447 .LP
 448 The default \fBadmin\fR file is consulted during package installation when no
 449 other \fBadmin\fR file is specified.
 450 .sp
 451 .ne 2
 452 .na
 453 \fB\fB/var/sadm/install/admin/default\fR\fR
 454 .ad
 455 .sp .6
 456 .RS 4n
 457 default \fBadmin\fR file
 458 .RE
 459
 460 .SH ATTRIBUTES
 461 .LP
 462 See \fBattributes\fR(5) for descriptions of the following attributes:
 463 .sp
 464
 465 .sp
 466 .TS
 467 box;
 468 c | c
 469 l | l .
 470 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 471 _
 472 Interface Stability     Evolving
 473 .TE
 474
 475 .SH SEE ALSO
 476 .LP
 477 \fBpkgadd\fR(1M), \fBprodreg\fR(1M), \fBlibwsreg\fR(3LIB), \fBpkginfo\fR(4),
 478 \fBattributes\fR(5), \fBzones\fR(5)
 479 .SH NOTES
 480 .LP
 481 The value \fBask\fR should not be defined in an \fBadmin\fR file that will be
 482 used for non-interactive installation (because, by definition, there is no
 483 installer interaction). Doing so causes installation to fail at the point when
 484 input is needed.