1 '\" te
   2 .\" Copyright (c) 2009, 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. You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.
   4 .\"  See the License for the specific language governing permissions and limitations under the License. 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
   5 .\" fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   6 .TH ROOT_ARCHIVE 1M "Sep 9, 2009"
   7 .SH NAME
   8 root_archive \- manage bootable miniroot archives
   9 .SH SYNOPSIS
  10 .LP
  11 .nf
  12 \fB/boot/solaris/bin/root_archive\fR pack \fIarchive\fR \fIroot\fR
  13 .fi
  14 
  15 .LP
  16 .nf
  17 \fB/boot/solaris/bin/root_archive\fR unpack \fIarchive\fR \fIroot\fR
  18 .fi
  19 
  20 .LP
  21 .nf
  22 \fB/boot/solaris/bin/root_archive\fR packmedia \fIsolaris_image\fR \fIroot\fR
  23 .fi
  24 
  25 .LP
  26 .nf
  27 \fB/boot/solaris/bin/root_archive\fR unpackmedia \fIsolaris_image\fR \fIroot\fR
  28 .fi
  29 
  30 .SH DESCRIPTION
  31 .sp
  32 .LP
  33 The \fBroot_archive\fR utility is used to manipulate boot archives and the
  34 bootable miniroot(s) in a Solaris install image. The utility can pack and
  35 unpack boot archives and image miniroots. Both \fBufs\fR and \fBhsfs\fR
  36 (\fBiso9660\fR) format archives can be unpacked, although only \fBufs\fR format
  37 is generated when packing.
  38 .sp
  39 .LP
  40 For normal, boot-related system administration, \fBbootadm\fR(1M) is
  41 recommended. \fBroot_archive\fR's primary purpose is to enable OEMs to add or
  42 update a driver or other component on the Solaris install media.
  43 .sp
  44 .LP
  45 A miniroot and a boot archive is closely associated with the release it is
  46 intended to boot. To ensure that the tools and system services used to
  47 construct the miniroot match, miniroot manipulation must be performed only on a
  48 system running the same release for which the miniroot is intended to install.
  49 .SH SUBCOMMANDS
  50 .sp
  51 .LP
  52 The \fBroot_archive\fR command has the following subcommands:
  53 .sp
  54 .ne 2
  55 .na
  56 \fB\fBpack\fR \fIarchive\fR \fIroot\fR\fR
  57 .ad
  58 .RS 21n
  59 Pack the contents of the root directory into the boot archive \fIarchive\fR.
  60 .RE
  61 
  62 .sp
  63 .ne 2
  64 .na
  65 \fB\fBunpack\fR \fIarchive\fR \fIroot\fR\fR
  66 .ad
  67 .sp .6
  68 .RS 4n
  69 Unpack the contents of the boot archive named \fIarchive\fR to the directory
  70 named \fIroot\fR.
  71 .RE
  72 
  73 .sp
  74 .ne 2
  75 .na
  76 \fB\fBpackmedia\fR \fIsolaris_image\fR \fIroot\fR\fR
  77 .ad
  78 .sp .6
  79 .RS 4n
  80 Create and pack the miniroot(s) in \fIsolaris_image\fR from the contents of the
  81 directory named \fIroot\fR.
  82 .RE
  83 
  84 .sp
  85 .ne 2
  86 .na
  87 \fB\fBunpackmedia\fR \fIsolaris_image\fR \fIroot\fR\fR
  88 .ad
  89 .sp .6
  90 .RS 4n
  91 Unpack the contents of the miniroot(s) in \fIsolaris_image\fR to the directory
  92 named \fIroot\fR.
  93 .RE
  94 
  95 .sp
  96 .LP
  97 The contents of a miniroot are constructed to need the requirements of the
  98 release. When unpacking a miniroot, all the contents of the miniroot(s) are
  99 unpacked. When packing a miniroot, the source directory must contain all the
 100 necessary components with which to construct a miniroot. In general, this can
 101 only be achieved by first unpacking an existing miniroot.
 102 .SH EXAMPLES
 103 .LP
 104 \fBExample 1 \fRUnpacking the Miniroots in a Solaris x86 Install Image
 105 .sp
 106 .LP
 107 The following command unpacks the miniroots in a Solaris image to the root
 108 directory in \fB/export/release/latest\fR.
 109 
 110 .sp
 111 .in +2
 112 .nf
 113 # \fBroot_archive unpackmedia \e\fR
 114 \fB/export/nv/solarisdvd.nvx_dvd/latest /export/release/latest/root\fR
 115 .fi
 116 .in -2
 117 .sp
 118 
 119 .sp
 120 .LP
 121 In the preceding, \fB/export/nv/solarisdvd.nvx_dvd/latest\fR represents a path
 122 to a Solaris x86 install image and \fB/export/release/latest/root\fR is a
 123 directory that will be purged or created, as necessary.
 124 
 125 .LP
 126 \fBExample 2 \fRPacking the Miniroots in a Solaris x86 Install Image
 127 .sp
 128 .LP
 129 The following command creates and packs the miniroot(s) in a Solaris image from
 130 the contents of the directory \fB/export/release/latest/root\fR.
 131 
 132 .sp
 133 .in +2
 134 .nf
 135 # \fBroot_archive packmedia \e\fR
 136 \fB/export/nv/solarisdvd.nvx_dvd/latest /export/release/latest/root\fR
 137 .fi
 138 .in -2
 139 .sp
 140 
 141 .SH EXIT STATUS
 142 .sp
 143 .LP
 144 The following exit values are returned:
 145 .sp
 146 .ne 2
 147 .na
 148 \fB\fB0\fR\fR
 149 .ad
 150 .RS 5n
 151 The command completed successfully.
 152 .RE
 153 
 154 .sp
 155 .ne 2
 156 .na
 157 \fB\fB1\fR\fR
 158 .ad
 159 .RS 5n
 160 The command exited due to an error.
 161 .RE
 162 
 163 .SH ATTRIBUTES
 164 .sp
 165 .LP
 166 See \fBattributes\fR(5) for descriptions of the following attributes:
 167 .sp
 168 
 169 .sp
 170 .TS
 171 box;
 172 c | c
 173 l | l .
 174 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 175 _
 176 Interface Stability     Committed
 177 .TE
 178 
 179 .SH SEE ALSO
 180 .sp
 181 .LP
 182 \fBcpio\fR(1), \fBbootadm\fR(1M), \fBmount\fR(1M), \fBattributes\fR(5),
 183 \fBlofi\fR(7D)