Print this page
6282 ONBLD man pages not pbchk clean
Reviewed by: Yuri Pankov <yuri.pankov@nexenta.com>
Reviewed by: Josef Sipek <jeffpc@josefsipek.net>


   4 .\"
   5 .\" CDDL HEADER START
   6 .\"
   7 .\" The contents of this file are subject to the terms of the
   8 .\" Common Development and Distribution License (the "License").
   9 .\" You may not use this file except in compliance with the License.
  10 .\"
  11 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
  12 .\" or http://www.opensolaris.org/os/licensing.
  13 .\" See the License for the specific language governing permissions
  14 .\" and limitations under the License.
  15 .\"
  16 .\" When distributing Covered Code, include this CDDL HEADER in each
  17 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  18 .\" If applicable, add the following below this CDDL HEADER, with the
  19 .\" fields enclosed by brackets "[]" replaced with your own identifying
  20 .\" information: Portions Copyright [yyyy] [name of copyright owner]
  21 .\"
  22 .\" CDDL HEADER END
  23 .\"
  24 .TH Install 1ONBLD "14 Jan 2010"
  25 .SH NAME
  26 Install \- install a kernel from an ON workspace
  27 .SH SYNOPSIS
  28 .TP 8n
  29 .B Install
  30 .RB [ " \-w "
  31 .IR workspace " ]"
  32 .RB [ " \-s "
  33 .IR "source dir" " ]"
  34 .br
  35 .RB [ " \-k  "
  36 .IR "kernel arch" " ]"
  37 .RB "[ " \-n " | " \-t|T
  38 .IR target " ]"
  39 .br
  40 .RB [ " \-u|m|a " ]
  41 .RB [ " \-v|V|q " ]
  42 .RB [ " \-c|p " ]
  43 .br
  44 .RB [ " \-l "


  79 containing /kernel, /usr/kernel, and a few related /etc files.  If a
  80 .I target ([user@]machine:/dir)
  81 is specified, the tarfile is either copied to
  82 .IR machine:/dir " (-T) or untarred on " "machine" " in " "/dir" " (-t),"
  83 using the remote user id
  84 .IR user ,
  85 if specified.
  86 With no options,
  87 .B Install
  88 creates a sun4c system from files in the current workspace (as indicated
  89 by $SRC) and places the tarfile in /tmp/Install.username/Install.sun4c.tar.
  90 
  91 .SH OPTIONS
  92 .TP 20n
  93 .BI "-w" " ws"
  94 Install the system built in the ON workspace
  95 .I ws.  ws
  96 must be a built ON workspace \(em
  97 .B Install
  98 will not automatically invoke
  99 .BR make "(1).  If " \-w " is not specified, " Install " uses the current



 100 workspace (as indicated by $CODEMGR_WS).  If there is no current workspace,
 101 .B Install
 102 checks to see if you are in an appropriate source directory, e.g. uts/sun4c;
 103 if so,
 104 .B Install
 105 takes files from there.  Otherwise,
 106 .B Install
 107 looks for files under $SRC/uts.
 108 .TP
 109 .BI "-s" " source directory"
 110 where to look for files [default: $SRC/uts].
 111 .TP
 112 .BI "-k" " kernel arch"
 113 the type of kernel to install.  The default is sun4c; however, if you invoke
 114 .B Install
 115 from $SRC/uts/sun4z,
 116 .B Install
 117 assumes you want a sun4z kernel.
 118 .TP
 119 .B "-n"


 246 .BR Install "'s"
 247 options.
 248 .LP
 249 If you are in a directory like $SRC/uts/sun4z when you invoke
 250 .BR Install ,
 251 it will infer that you want to install a sun4z system
 252 from the current workspace.
 253 .LP
 254 If you supply a list of modules, it overrides any of the
 255 .B "-uma"
 256 options.  You only need to specify the basename of the
 257 module(s), e.g. ``\fBInstall ufs nfs le\fR''.
 258 ``\fBInstall unix\fR'' is equivalent to ``\fBInstall -u\fR'', and
 259 ``\fBInstall modules\fR'' is equivalent to ``\fBInstall -m\fR''.
 260 .LP
 261 You can customize
 262 .B Install
 263 by creating a .Installrc file in your home directory.  .Installrc
 264 should consist of a list of command-line-style options, e.g:
 265 .LP

 266 .B
 267         -w /ws/foo

 268 .br

 269 .B
 270         -t labmachine:/mnt -pv

 271 .LP
 272 .B Install
 273 processes default options first, then .Installrc
 274 options, then command-line options.  In the case of
 275 conflicting options (e.g. \fB-uma\fR), the last one wins.
 276 .LP
 277 In order to use the most convenient form of
 278 .BR Install " (``" "Install -t machine:/" "''),"
 279 you will need to do the following on the target machine:
 280 .LP
 281 .br

 282         (1) add your machine name to the /etc/hosts.equiv file

 283 .br

 284         (2) add your username to the /etc/{passwd,shadow} files

 285 .br

 286         (3) chown -R yourself /kernel /usr/kernel

 287 .br

 288         (4) chmod -R u+w /kernel /usr/kernel

 289 .SH "ENVIRONMENT"
 290 .LP
 291 You can set the following variables in your environment:
 292 .LP
 293 ON_CRYPTO_BINS
 294 .IP
 295 file containing signed cryptographic binaries.  This is only needed if
 296 you are not building the closed-source tree.
 297 .LP
 298 INSTALL_RC [default: $HOME/.Installrc]
 299 .IP
 300 file containing default options for \fBInstall\fR
 301 .LP
 302 INSTALL_STATE [default: $HOME/.Install.state]
 303 .IP
 304 where \fBInstall\fR keeps its state information
 305 .LP
 306 INSTALL_DIR [default: /tmp/Install.username]
 307 .IP
 308 where \fBInstall\fR does its work.  This can be overridden on
 309 the command line with \fB\-d\fR.
 310 .LP
 311 INSTALL_LIB [default: $HOME/LibInstall]
 312 .IP
 313 where \fBInstall\fR gets/puts library files.  This can be overridden on
 314 the command line with \fB\-D\fR.
 315 .LP
 316 INSTALL_CP [default: cp -p]
 317 .IP
 318 the command to copy files locally
 319 .LP
 320 INSTALL_RCP [default: rcp -p]
 321 .IP
 322 the command to copy files remotely
 323 .bp
 324 .SH "EXAMPLES"
 325 .LP
 326 .B
 327 Install -w /ws/blort -t machine:/
 328 .IP
 329 .RI "installs the system built in workspace " /ws/blort " on " machine:/
 330 .LP
 331 .B
 332 Install -w /ws/blort -T machine:/tmp
 333 .br
 334 .B
 335 rsh machine -l root "cd /; tar xvf /tmp/Install.tar"
 336 .IP
 337 is an equivalent way to do the previous example
 338 .LP
 339 .B Install
 340 .IP
 341 makes a tarfile containing a sun4c kernel,
 342 and places it in /tmp/Install.username/Install.sun4c.tar.  However, if you
 343 are in one of the arch directories (e.g. $SRC/uts/sun4m) when you invoke


   4 .\"
   5 .\" CDDL HEADER START
   6 .\"
   7 .\" The contents of this file are subject to the terms of the
   8 .\" Common Development and Distribution License (the "License").
   9 .\" You may not use this file except in compliance with the License.
  10 .\"
  11 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
  12 .\" or http://www.opensolaris.org/os/licensing.
  13 .\" See the License for the specific language governing permissions
  14 .\" and limitations under the License.
  15 .\"
  16 .\" When distributing Covered Code, include this CDDL HEADER in each
  17 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  18 .\" If applicable, add the following below this CDDL HEADER, with the
  19 .\" fields enclosed by brackets "[]" replaced with your own identifying
  20 .\" information: Portions Copyright [yyyy] [name of copyright owner]
  21 .\"
  22 .\" CDDL HEADER END
  23 .\"
  24 .TH INSTALL 1ONBLD "Jan 14, 2010"
  25 .SH NAME
  26 Install \- install a kernel from an ON workspace
  27 .SH SYNOPSIS
  28 .TP 8n
  29 .B Install
  30 .RB [ " \-w "
  31 .IR workspace " ]"
  32 .RB [ " \-s "
  33 .IR "source dir" " ]"
  34 .br
  35 .RB [ " \-k  "
  36 .IR "kernel arch" " ]"
  37 .RB "[ " \-n " | " \-t|T
  38 .IR target " ]"
  39 .br
  40 .RB [ " \-u|m|a " ]
  41 .RB [ " \-v|V|q " ]
  42 .RB [ " \-c|p " ]
  43 .br
  44 .RB [ " \-l "


  79 containing /kernel, /usr/kernel, and a few related /etc files.  If a
  80 .I target ([user@]machine:/dir)
  81 is specified, the tarfile is either copied to
  82 .IR machine:/dir " (-T) or untarred on " "machine" " in " "/dir" " (-t),"
  83 using the remote user id
  84 .IR user ,
  85 if specified.
  86 With no options,
  87 .B Install
  88 creates a sun4c system from files in the current workspace (as indicated
  89 by $SRC) and places the tarfile in /tmp/Install.username/Install.sun4c.tar.
  90 
  91 .SH OPTIONS
  92 .TP 20n
  93 .BI "-w" " ws"
  94 Install the system built in the ON workspace
  95 .I ws.  ws
  96 must be a built ON workspace \(em
  97 .B Install
  98 will not automatically invoke
  99 .BR make (1) .
 100 If \-w is not specified,
 101 .B Install
 102 uses the current
 103 workspace (as indicated by $CODEMGR_WS).  If there is no current workspace,
 104 .B Install
 105 checks to see if you are in an appropriate source directory, e.g. uts/sun4c;
 106 if so,
 107 .B Install
 108 takes files from there.  Otherwise,
 109 .B Install
 110 looks for files under $SRC/uts.
 111 .TP
 112 .BI "-s" " source directory"
 113 where to look for files [default: $SRC/uts].
 114 .TP
 115 .BI "-k" " kernel arch"
 116 the type of kernel to install.  The default is sun4c; however, if you invoke
 117 .B Install
 118 from $SRC/uts/sun4z,
 119 .B Install
 120 assumes you want a sun4z kernel.
 121 .TP
 122 .B "-n"


 249 .BR Install "'s"
 250 options.
 251 .LP
 252 If you are in a directory like $SRC/uts/sun4z when you invoke
 253 .BR Install ,
 254 it will infer that you want to install a sun4z system
 255 from the current workspace.
 256 .LP
 257 If you supply a list of modules, it overrides any of the
 258 .B "-uma"
 259 options.  You only need to specify the basename of the
 260 module(s), e.g. ``\fBInstall ufs nfs le\fR''.
 261 ``\fBInstall unix\fR'' is equivalent to ``\fBInstall -u\fR'', and
 262 ``\fBInstall modules\fR'' is equivalent to ``\fBInstall -m\fR''.
 263 .LP
 264 You can customize
 265 .B Install
 266 by creating a .Installrc file in your home directory.  .Installrc
 267 should consist of a list of command-line-style options, e.g:
 268 .LP
 269 .nf
 270 .B
 271         -w /ws/foo
 272 .fi
 273 .br
 274 .nf
 275 .B
 276         -t labmachine:/mnt -pv
 277 .fi
 278 .LP
 279 .B Install
 280 processes default options first, then .Installrc
 281 options, then command-line options.  In the case of
 282 conflicting options (e.g. \fB-uma\fR), the last one wins.
 283 .LP
 284 In order to use the most convenient form of
 285 .BR Install " (``" "Install -t machine:/" "''),"
 286 you will need to do the following on the target machine:
 287 .LP
 288 .br
 289 .nf
 290         (1) add your machine name to the /etc/hosts.equiv file
 291 .fi
 292 .br
 293 .nf
 294         (2) add your username to the /etc/{passwd,shadow} files
 295 .fi
 296 .br
 297 .nf
 298         (3) chown -R yourself /kernel /usr/kernel
 299 .fi
 300 .br
 301 .nf
 302         (4) chmod -R u+w /kernel /usr/kernel
 303 .fi
 304 .SH "ENVIRONMENT"
 305 .LP
 306 You can set the following variables in your environment:
 307 .LP
 308 ON_CRYPTO_BINS
 309 .IP
 310 file containing signed cryptographic binaries.  This is only needed if
 311 you are not building the closed-source tree.
 312 .LP
 313 INSTALL_RC [default: $HOME/.Installrc]
 314 .IP
 315 file containing default options for \fBInstall\fR
 316 .LP
 317 INSTALL_STATE [default: $HOME/.Install.state]
 318 .IP
 319 where \fBInstall\fR keeps its state information
 320 .LP
 321 INSTALL_DIR [default: /tmp/Install.username]
 322 .IP
 323 where \fBInstall\fR does its work.  This can be overridden on
 324 the command line with \fB\-d\fR.
 325 .LP
 326 INSTALL_LIB [default: $HOME/LibInstall]
 327 .IP
 328 where \fBInstall\fR gets/puts library files.  This can be overridden on
 329 the command line with \fB\-D\fR.
 330 .LP
 331 INSTALL_CP [default: cp -p]
 332 .IP
 333 the command to copy files locally
 334 .LP
 335 INSTALL_RCP [default: rcp -p]
 336 .IP
 337 the command to copy files remotely

 338 .SH "EXAMPLES"
 339 .LP
 340 .B
 341 Install -w /ws/blort -t machine:/
 342 .IP
 343 .RI "installs the system built in workspace " /ws/blort " on " machine:/
 344 .LP
 345 .B
 346 Install -w /ws/blort -T machine:/tmp
 347 .br
 348 .B
 349 rsh machine -l root "cd /; tar xvf /tmp/Install.tar"
 350 .IP
 351 is an equivalent way to do the previous example
 352 .LP
 353 .B Install
 354 .IP
 355 makes a tarfile containing a sun4c kernel,
 356 and places it in /tmp/Install.username/Install.sun4c.tar.  However, if you
 357 are in one of the arch directories (e.g. $SRC/uts/sun4m) when you invoke