Merge commit 'c5bab7026b8e0ac44b25ee08507ea360f177d844' into merges
[unleashed.git] / share / man / man8 / root_archive.8
blobcea12502b48773f29816dce942587096d6ce12bf
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 .\" Copyright 2012 Nexenta Systems, Inc. All rights reserved.
7 .TH ROOT_ARCHIVE 8 "Sep 9, 2009"
8 .SH NAME
9 root_archive \- manage bootable miniroot archives
10 .SH SYNOPSIS
11 .LP
12 .nf
13 \fB/boot/solaris/bin/root_archive\fR pack \fIarchive\fR \fIroot\fR
14 .fi
16 .LP
17 .nf
18 \fB/boot/solaris/bin/root_archive\fR unpack \fIarchive\fR \fIroot\fR
19 .fi
21 .SH DESCRIPTION
22 .sp
23 .LP
24 The \fBroot_archive\fR utility is used to manipulate boot archives.
25 The utility can pack and unpack boot archives and image miniroots. Both \fBufs\fR and \fBhsfs\fR
26 (\fBiso9660\fR) format archives can be unpacked, although only \fBufs\fR format
27 is generated when packing.
28 .sp
29 .LP
30 For normal, boot-related system administration, \fBbootadm\fR(8) is recommended.
31 .SH SUBCOMMANDS
32 .sp
33 .LP
34 The \fBroot_archive\fR command has the following subcommands:
35 .sp
36 .ne 2
37 .na
38 \fB\fBpack\fR \fIarchive\fR \fIroot\fR\fR
39 .ad
40 .RS 21n
41 Pack the contents of the root directory into the boot archive \fIarchive\fR.
42 .RE
44 .sp
45 .ne 2
46 .na
47 \fB\fBunpack\fR \fIarchive\fR \fIroot\fR\fR
48 .ad
49 .sp .6
50 .RS 21n
51 Unpack the contents of the boot archive named \fIarchive\fR to the directory
52 named \fIroot\fR.
53 .RE
55 .SH EXIT STATUS
56 .sp
57 .LP
58 The following exit values are returned:
59 .sp
60 .ne 2
61 .na
62 \fB\fB0\fR\fR
63 .ad
64 .RS 5n
65 The command completed successfully.
66 .RE
68 .sp
69 .ne 2
70 .na
71 \fB\fB1\fR\fR
72 .ad
73 .RS 5n
74 The command exited due to an error.
75 .RE
77 .SH ATTRIBUTES
78 .sp
79 .LP
80 See \fBattributes\fR(5) for descriptions of the following attributes:
81 .sp
83 .sp
84 .TS
85 box;
86 c | c
87 l | l .
88 ATTRIBUTE TYPE  ATTRIBUTE VALUE
90 Interface Stability     Committed
91 .TE
93 .SH SEE ALSO
94 .sp
95 .LP
96 \fBcpio\fR(1), \fBbootadm\fR(8), \fBmount\fR(8), \fBattributes\fR(5),
97 \fBlofi\fR(7D)