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

   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 ITU 1M "Sep 23, 2009"
   7 .SH NAME
   8 itu \- convert packages to Driver Update format and patch Solaris install media
   9 for Install Time Update
  10 .SH SYNOPSIS
  11 .LP
  12 .nf
  13 \fBitu makedu\fR \fB-r\fR \fIsolaris_release\fR [\fB-v\fR] [\fB-f\fR] [\fB-d\fR \fIoutput_dir\fR] [\fB-o\fR \fIiso_file\fR]
  14      [\fB-l\fR \fIiso_label\fR] \fIpackage\fR [\fIpackage\fR...]
  15 .fi
  16
  17 .LP
  18 .nf
  19 \fBitu updatemedia\fR \fB-R\fR \fImedia_root\fR [\fB-v\fR] [\fB-f\fR] [\fB-o\fR \fIiso_file\fR]
  20      [\fB-l\fR \fIiso_label\fR] \fIpkg\fR [\fIpkg\fR...]
  21 .fi
  22
  23 .LP
  24 .nf
  25 \fBitu makeiso\fR \fB-o\fR \fIiso_file\fR [\fB-v\fR] [\fB-l\fR \fIiso_label\fR] \fImedia_root\fR
  26 .fi
  27
  28 .SH DESCRIPTION
  29 .sp
  30 .LP
  31 The \fBitu\fR utility converts driver packages to Driver Update (DU) format and
  32 patches a Solaris install media with driver packages for Install Time Update
  33 (ITU). \fBitu\fR has three subcommands: \fBmakedu\fR, \fBupdatemedia\fR and
  34 \fBmakeiso\fR.
  35 .SH OPTIONS
  36 .sp
  37 .LP
  38 The following options are supported:
  39 .sp
  40 .ne 2
  41 .na
  42 \fB\fB-d\fR \fIoutput_dir\fR\fR
  43 .ad
  44 .sp .6
  45 .RS 4n
  46 Directory where the Driver Update directory is to be created.
  47 .RE
  48
  49 .sp
  50 .ne 2
  51 .na
  52 \fB\fB-f\fR\fR
  53 .ad
  54 .sp .6
  55 .RS 4n
  56 If \fIoutput_dir\fR/DU or \fIiso_file\fR already exists, remove it without
  57 asking first.
  58 .RE
  59
  60 .sp
  61 .ne 2
  62 .na
  63 \fB\fB-l\fR \fIiso_label\fR\fR
  64 .ad
  65 .sp .6
  66 .RS 4n
  67 Label/volume name of the ISO image (if \fB-o\fR option is specified).
  68 .RE
  69
  70 .sp
  71 .ne 2
  72 .na
  73 \fB\fB-o\fR \fIiso_file\fR\fR
  74 .ad
  75 .sp .6
  76 .RS 4n
  77 Path of the ISO image file to be created. For subcommands \fBupdatemedia\fR and
  78 \fBmakeiso\fR, it will be a bootable ISO image. This option must be specified
  79 for subcommand \fBmakeiso\fR.
  80 .RE
  81
  82 .sp
  83 .ne 2
  84 .na
  85 \fB\fB-R\fR \fImedia_root\fR\fR
  86 .ad
  87 .sp .6
  88 .RS 4n
  89 Top-level directory of on-disk image of Solaris installation media. This option
  90 must be specified for subcommand \fBupdatemedia\fR.
  91 .RE
  92
  93 .sp
  94 .ne 2
  95 .na
  96 \fB\fB-r\fR \fIsolaris_release\fR\fR
  97 .ad
  98 .sp .6
  99 .RS 4n
 100 Solaris release number for which the Driver Update is intended. It takes the
 101 form of the output of \fBuname\fR \fB-r\fR, for example, \fB5.10\fR. This
 102 option must be specified for subcommand \fBmakedu\fR.
 103 .RE
 104
 105 .sp
 106 .ne 2
 107 .na
 108 \fB\fB-v\fR\fR
 109 .ad
 110 .sp .6
 111 .RS 4n
 112 Verbose. Multiple \fB-v\fR options increase verbosity.
 113 .RE
 114
 115 .SH SUB-COMMANDS
 116 .sp
 117 .LP
 118 The \fBitu\fR subcommands are described as follows.
 119 .SS "\fBmakedu\fR"
 120 .sp
 121 .LP
 122 The \fBmakedu\fR subcommand takes one or more driver packages as input and
 123 converts them to DU format. At the beginning of an interactive Solaris
 124 installation session, these driver updates can be applied to the running
 125 kernel, which will then also automatically apply them to the newly installed
 126 Solaris at the end of the installation process.
 127 .sp
 128 .LP
 129 The \fB-r\fR option is required to specify the Solaris release number for which
 130 the driver updates apply. The \fIsolaris_release\fR option argument takes the
 131 form \fBuname\fR \fB-r\fR output, for example, \fB5.10\fR or \fB5.11\fR.
 132 .sp
 133 .LP
 134 If the \fB-d\fR option is specified, the resulting DU directory tree is placed
 135 in the directory \fIoutput_dir\fR.
 136 .sp
 137 .LP
 138 If the \fB-o\fR option is specified, a (non-bootable) ISO image of the DU
 139 directory tree is written in the file \fIiso_file\fR. This ISO image can be
 140 burned onto a CD/DVD using \fBcdrw\fR(1) or \fBcdrecord(1)\fR (not a SunOS man
 141 page). See the "Examples" section below for an example of creating a DU on a
 142 floppy.
 143 .sp
 144 .LP
 145 At least one of \fB-d\fR and \fB-o\fR option must be specified. If both are
 146 specified, then both an ISO image and a directory tree are generated.
 147 .SS "\fBupdatemedia\fR"
 148 .sp
 149 .LP
 150 The \fBupdatemedia\fR subcommand takes a list of driver packages as input and
 151 applies them to the miniroot of a Solaris install media. It also places them in
 152 a subdirectory called \fBITUs\fR under the Solaris install media's top-level
 153 directory:
 154 .sp
 155 .in +2
 156 .nf
 157 \fImedia_root\fR/ITUs
 158 .fi
 159 .in -2
 160 .sp
 161
 162 .sp
 163 .LP
 164 When booting a system from the updated media, the  packages will be part of the
 165 booted Solaris image. They will also be applied to the target system being
 166 installed at the end of the installation process.
 167 .sp
 168 .LP
 169 The \fB-R\fR option must be entered on the command line to specify the Solaris
 170 install media. Note that the install media must be on a location that is
 171 writable by \fBitu\fR.
 172 .sp
 173 .LP
 174 If the \fB-o\fR option is specified, a bootable ISO image of the patched
 175 install media is also created in the file \fIiso_file\fR. The ISO image can
 176 then be burned onto a CD or DVD.
 177 .SS "\fBmakeiso\fR"
 178 .sp
 179 .LP
 180 The \fBmakeiso\fR subcommand runs \fBmkisofs(8)\fR to create a bootable Solaris
 181 ISO image of the Solaris install media \fImedia_root\fR and writes it to the
 182 file \fIiso_file\fR. The ISO image file can then be burned onto a CD or DVD
 183 with utilities such as \fBcdrw\fR(1) or \fBcdrecord(1)\fR. (Note that
 184 \fBmkisofs(8)\fR and \fBcdrecord(1)\fR are not SunOS man pages.)
 185 .LP
 186 Caution -
 187 .sp
 188 .RS 2
 189 The Solaris install media \fImedia-root\fR must contain the file
 190 \fBboot/grub/stage2_eltorito\fR, which will be written to the media boot
 191 sectors. This file will be modified with some boot information, thus it has to
 192 be writable. If necessary, first save a copy, prior to running this subcommand.
 193 .RE
 194 .SH OPERANDS
 195 .sp
 196 .LP
 197 The following operands are supported:
 198 .sp
 199 .ne 2
 200 .na
 201 \fB\fIpackage\fR [\fIpackage\fR...]\fR
 202 .ad
 203 .sp .6
 204 .RS 4n
 205 One or more driver packages.
 206 .RE
 207
 208 .sp
 209 .ne 2
 210 .na
 211 \fB\fIpkg\fR [\fIpkg\fR...]\fR
 212 .ad
 213 .sp .6
 214 .RS 4n
 215 One or more packages.
 216 .RE
 217
 218 .sp
 219 .ne 2
 220 .na
 221 \fB\fImedia_root\fR\fR
 222 .ad
 223 .sp .6
 224 .RS 4n
 225 The top-level directory of a Solaris install media.
 226 .RE
 227
 228 .SH EXAMPLES
 229 .LP
 230 \fBExample 1 \fRCreating a DU CD/DVD
 231 .sp
 232 .LP
 233 The following commands create a Driver Update CD/DVD containing the packages
 234 \fBSAMPLEpkg1\fR and \fBSAMPLEpkg2\fR.
 235
 236 .sp
 237 .in +2
 238 .nf
 239 # \fBitu makedu -r 5.10 -o my.iso SAMPLEpkg1 SAMPLEpkg2\fR
 240 # \fBcdrw -i my.iso\fR
 241 .fi
 242 .in -2
 243 .sp
 244
 245 .LP
 246 \fBExample 2 \fRCreating a DU Floppy
 247 .sp
 248 .LP
 249 The following commands create a Driver Update floppy containing the driver
 250 package \fBMYdriver\fR.
 251
 252 .sp
 253 .in +2
 254 .nf
 255 # \fBrmformat -F quick /dev/rdiskette\fR
 256 # \fBmkfs -F pcfs /dev/rdiskette\fR
 257 # \fBmount -F pcfs /dev/diskette /mnt\fR
 258 # \fB/usr/bin/itu makedu -r 5.10 -d /mnt /export/MYdriver\fR
 259 # \fBumount /mnt\fR
 260 # \fBdd if=/dev/rdiskette of=floppy.dd\fR
 261 .fi
 262 .in -2
 263 .sp
 264
 265 .sp
 266 .LP
 267 The \fBitu\fR command above creates the DU directly onto the floppy mounted on
 268 \fB/mnt\fR. The \fBdd\fR invocation stores an image of the floppy in the file
 269 \fBfloppy.dd\fR. This is useful for distributing a DU floppy in file form. From
 270 the file, the floppy can then be recreated as follows:
 271
 272 .sp
 273 .in +2
 274 .nf
 275 # \fBdd if=floppy.dd of=/dev/rdiskette\fR
 276 .fi
 277 .in -2
 278 .sp
 279
 280 .LP
 281 \fBExample 3 \fRCreating a Bootable ISO Image
 282 .sp
 283 .LP
 284 The following commands create the bootable ISO image \fBmydvd.iso\fR of the
 285 Solaris install image \fB/export/solaris-10u1\fR with ISO label
 286 "\fBSpecial-S10\fR".
 287
 288 .sp
 289 .in +2
 290 .nf
 291 # \fB/usr/bin/itu makeiso -o mydvd.iso -l "Special-S10" \e
 292      /export/solaris-10u1\fR
 293 # \fBcdrw -i mydvd.iso\fR
 294 .fi
 295 .in -2
 296 .sp
 297
 298 .SH ATTRIBUTES
 299 .sp
 300 .LP
 301 See \fBattributes\fR(5) for descriptions of the following attributes:
 302 .sp
 303
 304 .sp
 305 .TS
 306 box;
 307 c | c
 308 l | l .
 309 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 310 _
 311 Interface Stability     Committed
 312 .TE
 313
 314 .SH SEE ALSO
 315 .sp
 316 .LP
 317 \fBcdrw\fR(1), \fBpkgadd\fR(1M), \fBattributes\fR(5)
 318 .sp
 319 .LP
 320 \fBmkisofs(8)\fR, (\fB/usr/share/man/man8/mkisofs.8\fR), in the
 321 \fBSUNWfsman\fR package (not a SunOS man page)