1 '\" te |
1 '\" te |
2 .\" Copyright (c) 2011, Oracle and/or its affiliates. |
2 .\" Copyright (c) 2011, 2012, Oracle and/or its affiliates. All rights reserved. |
3 .\" All rights reserved. |
3 .TH distro_const 1M "29 May 2012" "SunOS 5.11" "System Administration Commands" |
4 .TH distro_const 1M "14 July 2011" "SunOS 5.11" "System Administration Commands" |
|
5 .SH NAME |
4 .SH NAME |
6 distro_const \- Utility for creating Oracle Solaris images and media |
5 distro_const \- Utility for creating Oracle Solaris images and media |
7 .SH SYNOPSIS |
6 .SH SYNOPSIS |
8 .LP |
7 .LP |
9 .nf |
8 .nf |
10 /usr/bin/distro_const |
9 /usr/bin/distro_const -h |
11 .fi |
10 .fi |
12 |
11 |
13 .LP |
12 .LP |
14 .nf |
13 .nf |
15 distro_const --help |
14 /usr/bin/distro_const build [-v] [-r \fIcheckpoint_name\fR] |
16 .fi |
15 [-p \fIcheckpoint_name\fR] [-l] \fImanifest\fR |
17 |
|
18 .LP |
|
19 .nf |
|
20 distro_const build [\fB-v\fR] [\fB -r \fR \fIcheckpoint name\fR] [\fB-p\fR \fIcheckpoint name\fR] [\fB-l\fR] \fImanifest\fR |
|
21 .fi |
16 .fi |
22 |
17 |
23 .SH DESCRIPTION |
18 .SH DESCRIPTION |
24 .sp |
19 .sp |
25 .LP |
20 .LP |
26 The \fBdistro_const\fR command enables users to create an image by using a specified manifest file as the blueprint for the image. |
21 The \fBdistro_const\fR command enables users to create an image by using a specified manifest file as the blueprint for the image. |
27 .sp |
22 .sp |
28 .LP |
23 .LP |
29 You can create a text installer image that can be used to install the Oracle Solaris operating system on either x86 systems or SPARC systems. |
24 You can create any of the following images: |
30 .sp |
25 .RS +4 |
31 .LP |
26 .TP |
32 Or, you can create an ISO image that is comparable to a live CD image containing the Oracle Solaris operating system. |
27 .ie t \(bu |
33 .sp |
28 .el o |
34 .LP |
29 A text installer image that can be used to install the Oracle Solaris operating system on either x86 systems or SPARC systems. |
35 Alternately, you can create a SPARC AI ISO image that can be used for network installations of the Oracle Solaris OS on SPARC clients, or an x86 AI ISO image that can be used for network installations of the Oracle Solaris OS on x86 clients. |
30 .RE |
36 .sp |
31 .RS +4 |
37 .LP |
32 .TP |
38 Or, you can create a custom ISO image. |
33 .ie t \(bu |
39 .sp |
34 .el o |
40 .LP |
35 An ISO image that is comparable to a Live DVD image containing the Oracle Solaris operating system. |
41 The basic \fBdistro_const\fR command with no options creates a full image in one step. |
36 .RE |
42 .sp |
37 .RS +4 |
43 .LP |
38 .TP |
44 The command options enable users to pause and resume the image-creation process at various "checkpoints," thus enabling users to review status of the image and to check for bugs at each stage. Checkpointing saves time during builds by allowing you to bypass lengthy steps which have already been done at least once. |
39 .ie t \(bu |
|
40 .el o |
|
41 A SPARC AI ISO image that can be used for network installations of the Oracle Solaris OS on SPARC clients, or an x86 AI ISO image that can be used for network installations of the Oracle Solaris OS on x86 clients. |
|
42 .RE |
|
43 .RS +4 |
|
44 .TP |
|
45 .ie t \(bu |
|
46 .el o |
|
47 A custom ISO image. |
|
48 .RE |
|
49 .sp |
|
50 .LP |
|
51 The \fBdistro_const build\fR command with no options creates a full image in one step. |
|
52 .sp |
|
53 .LP |
|
54 Options enable you to pause and resume the image creation process at various checkpoints, thus enabling you to review status of the image and to check for bugs at each stage. Checkpointing saves time during builds by allowing you to bypass lengthy steps that have already been done at least once. |
45 .LP |
55 .LP |
46 Note - |
56 Note - |
47 .sp |
57 .sp |
48 .RS 2 |
58 .RS 2 |
49 You must assume the root role or have root privileges to run the \fBdistro_const\fR command. |
59 You must assume the root role or have root privileges to run the \fBdistro_const\fR command. |
50 .LP |
60 .RE |
51 When using the distribution constructor, you can create only SPARC images on a SPARC system. And, you can create only x86 images on an x86 system. And, the operating system release version on your system must be the same release version as the image that you are building. |
61 .sp |
52 .RE |
62 .LP |
|
63 When using the distribution constructor, you can create only SPARC images on a SPARC system, and you can create only x86 images on an x86 system. Also, the operating system release version on your system must be the same release version as the image that you are building. |
|
64 .SH OPTIONS |
|
65 .sp |
|
66 .ne 2 |
|
67 .mk |
|
68 .na |
|
69 \fB\fB-h\fR\fR |
|
70 .ad |
|
71 .br |
|
72 .na |
|
73 \fB\fB--help\fR\fR |
|
74 .ad |
|
75 .sp .6 |
|
76 .RS 4n |
|
77 Display a usage message. |
|
78 .RE |
|
79 |
53 .SH SUB-COMMANDS |
80 .SH SUB-COMMANDS |
54 .sp |
81 .sp |
55 .LP |
82 .LP |
56 The \fBdistro_const\fR command has the subcommand and options listed below. Also see the Examples section. |
83 The \fBdistro_const\fR command has the subcommand and options listed below. Also see the "Examples" section. |
57 .sp |
84 .sp |
58 .ne 2 |
85 .ne 2 |
59 .mk |
86 .mk |
60 .na |
87 .na |
61 \fB\fB--help\fR\fR |
88 \fB\fBbuild\fR [\fB-v\fR] [\fB-r\fR \fIresume_checkpoint\fR] [\fB-p\fR \fIpause_checkpoint\fR] [\fB-l\fR] \fImanifest\fR\fR |
62 .ad |
89 .ad |
63 .sp .6 |
90 .sp .6 |
64 .RS 4n |
91 .RS 4n |
65 Displays usage. |
92 With no options, create a full image, using the specified manifest file as the blueprint for that image. |
66 .RE |
93 .sp |
67 |
94 .ne 2 |
68 .sp |
95 .mk |
69 .ne 2 |
96 .na |
70 .mk |
97 \fB\fB-v\fR\fR |
71 .na |
98 .ad |
72 \fBbuild\fR |
99 .br |
73 .ad |
100 .na |
74 .sp .6 |
101 \fB\fB--verbose\fR\fR |
75 .RS 4n |
102 .ad |
76 \fBdistro_const build\fR \fImanifest\fR |
103 .sp .6 |
77 .sp |
104 .RS 4n |
78 The subcommand, "build", is required. |
105 Show verbose output. |
79 .sp |
106 .RE |
80 Creates a full image, using the specified manifest file as the blueprint for that image. The manifest name is required. |
107 |
81 .RE |
108 .sp |
82 |
109 .ne 2 |
83 .sp |
110 .mk |
84 .ne 2 |
111 .na |
85 .mk |
112 \fB\fB-l\fR\fR |
86 .na |
113 .ad |
87 \fB\fB-v\fR \fBdistro_const build\fR \fB-v\fR\fR |
114 .br |
88 .ad |
115 .na |
89 .sp .6 |
116 \fB\fB--list\fR\fR |
90 .RS 4n |
117 .ad |
91 Specifies the verbose mode. |
118 .sp .6 |
92 .RE |
119 .RS 4n |
93 |
120 List all valid checkpoints at which you can choose to pause or resume building an image. This option queries the \fImanifest\fR manifest file for valid checkpoints. Use the names provided by this option as valid values for the other checkpointing options. |
94 .sp |
121 .RE |
95 .ne 2 |
122 |
96 .mk |
123 .sp |
97 .na |
124 .ne 2 |
98 \fB\fB-l\fR \fBdistro_const build\fR [\fB-l\fR] \fImanifest\fR\fR |
125 .mk |
99 .ad |
126 .na |
100 .sp .6 |
127 \fB\fB-p\fR \fIpause_checkpoint\fR\fR |
101 .RS 4n |
128 .ad |
102 Lists all valid checkpoints at which you can choose to pause or resume building an image. This command option queries the manifest file for valid checkpoints. Use the names provided by this command as valid values for the other checkpointing command options. The build subcommand is required. |
129 .br |
103 .sp |
130 .na |
104 The checkpoint values depend on entries in the manifest file. |
131 \fB\fB--pause\fR \fIpause_checkpoint\fR\fR |
105 .RE |
132 .ad |
106 |
133 .sp .6 |
107 .sp |
134 .RS 4n |
108 .ne 2 |
135 Build an image, pausing at the specified checkpoint name. Use the \fB-l\fR option to find valid checkpoint names. You can combine the \fB-p\fR and \fB-r\fR options. |
109 .mk |
136 .RE |
110 .na |
137 |
111 \fB\fB-p\fR \fBdistro_const build\fR [\fB-p\fR \fIcheckpoint\fR] \fImanifest\fR\fR |
138 .sp |
112 .ad |
139 .ne 2 |
113 .sp .6 |
140 .mk |
114 .RS 4n |
141 .na |
115 Builds an image, but pauses building the image at the specified checkpoint name. Use the -l option to find valid names. You can combine the -r option and the -p option. The checkpoint name and manifest name are required. The build subcommand is required. |
142 \fB\fB-r\fR \fIresume_checkpoint\fR\fR |
116 .RE |
143 .ad |
117 |
144 .br |
118 .sp |
145 .na |
119 .ne 2 |
146 \fB\fB--resume\fR \fIresume_checkpoint\fR\fR |
120 .mk |
147 .ad |
121 .na |
148 .sp .6 |
122 \fB\fB-r\fR \fBdistro_const build\fR [\fB-r\fR \fIcheckpoint\fR] \fImanifest\fR\fR |
149 .RS 4n |
123 .ad |
150 Resume building the image from the specified checkpoint name. The specified checkpoint name must be either the checkpoint at which the previous build stopped executing, or an earlier checkpoint. A later checkpoint is not valid. Use the \fB-l\fR option to determine which checkpoints are resumable. You can combine the \fB-r\fR and \fB-p\fR options. |
124 .sp .6 |
151 .RE |
125 .RS 4n |
152 |
126 Resumes building the image from the specified checkpoint name. The specified name must be either the checkpoint at which the previous build stopped executing, or an earlier checkpoint. A later checkpoint is not valid. Use the -l option to determine which checkpoints are resumable. The -p option can be combined with the -r option. The checkpoint name and manifest name are required. The build subcommand is required. |
|
127 .RE |
|
128 |
|
129 .sp |
|
130 .ne 2 |
|
131 .mk |
|
132 .na |
|
133 \fB\fB-h\fR \fBdistro_const\fR [\fB-h\fR]\fR |
|
134 .ad |
|
135 .sp .6 |
|
136 .RS 4n |
|
137 Displays command usage. |
|
138 .RE |
153 .RE |
139 |
154 |
140 .SH EXAMPLES |
155 .SH EXAMPLES |
141 .LP |
156 .LP |
142 \fBExample 1 \fRCreate an Image Using Checkpoint Options |
157 \fBExample 1 \fRCreate an Image Using Checkpoint Options |
143 .RS +4 |
158 .RS +4 |
144 .TP |
159 .TP |
145 1. |
160 1. |
146 Check which checkpoints are available. The manifest name in this example is \fBdc_livecd.xml\fR. |
161 Check which checkpoints are available. |
147 .sp |
162 .sp |
148 .in +2 |
163 .in +2 |
149 .nf |
164 .nf |
150 # \fBdistro_const build -l /usr/share/distro_const/dc_livecd.xml\fR |
165 # \fBdistro_const build -l /usr/share/distro_const/dc_text_x86.xml\fR |
151 .fi |
166 Checkpoint Resumable Description |
152 .in -2 |
167 ----------- --------- ----------------------- |
153 .sp |
168 transfer-ips-install X Transfer pkg contents from IPS |
154 |
169 set-ips-attributes X Set post-install IPS attributes |
155 The valid checkpoint names are displayed, as in this sample output. |
170 pre-pkg-img-mod X Pre-package image modification |
156 .sp |
171 ba-init X Boot archive initialization |
157 .in +2 |
172 ba-config X Boot archive configuration |
158 .nf |
173 ba-arch X Boot archive archival |
159 |
174 boot-setup X Set up GRUB menu |
160 |
175 pkg-img-mod X Pkg image area modification |
161 Checkpoint Resumable Description |
176 create-iso ISO media creation |
162 -------------------------------------------- |
177 create-usb USB media creation |
163 transfer-ips-install X Transfer pkg contents from IPS |
|
164 set-ips-attributes X Set post-install IPS attributes |
|
165 pre-pkg-img-mod X Pre-package image modification |
|
166 ba-init X Boot archive initialization |
|
167 ba-config X Boot archive configuration |
|
168 ba-arch X Boot archive archival |
|
169 grub-setup X Set up GRUB menu |
|
170 pkg-img-mod X Pkg image area modification |
|
171 create-iso ISO media creation |
|
172 create-usb USB media creation |
|
173 .fi |
178 .fi |
174 .in -2 |
179 .in -2 |
175 .sp |
180 .sp |
176 |
181 |
177 .RE |
182 .RE |
178 .RS +4 |
183 .RS +4 |
179 .TP |
184 .TP |
180 2. |
185 2. |
181 Start building the image and pause at the ba-init checkpoint. |
186 Start building the image and pause at the \fBba-init\fR checkpoint. |
182 .sp |
187 .sp |
183 .in +2 |
188 .in +2 |
184 .nf |
189 .nf |
185 # \fBdistro_const build -p ba-init /usr/share/distro_const/dc_livecd.xml\fR |
190 # \fBdistro_const build -p ba-init /usr/share/distro_const/dc_text_x86.xml\fR |
186 .fi |
191 .fi |
187 .in -2 |
192 .in -2 |
188 .sp |
193 .sp |
189 |
194 |
190 .RE |
195 .RE |
191 .RS +4 |
196 .RS +4 |
192 .TP |
197 .TP |
193 3. |
198 3. |
194 Restart the build from the ba-init checkpoint. Finish creating the image. |
199 Restart the build from the \fBba-init\fR checkpoint. Finish creating the image. |
195 .sp |
200 .sp |
196 .in +2 |
201 .in +2 |
197 .nf |
202 .nf |
198 # \fBdistro_const build -r ba-init /usr/share/distro_const/dc_livecd.xml\fR |
203 # \fBdistro_const build -r ba-init /usr/share/distro_const/dc_text_x86.xml\fR |
199 .fi |
204 .fi |
200 .in -2 |
205 .in -2 |
201 .sp |
206 .sp |
202 |
207 |
203 .RE |
208 .RE |
204 .LP |
209 .LP |
205 \fBExample 2 \fRCreate an Image in One Step |
210 \fBExample 2 \fRCreate an Image in One Step |
206 .sp |
211 .sp |
207 .LP |
212 .LP |
208 To run a complete build of an image without pausing, use the basic \fBdistro_const\fR command without checkpointing options. The manifest file name is dc_livecd.xml. |
213 To run a complete build of an image without pausing, use the \fBdistro_const\fR command with no options. |
209 |
214 |
210 .sp |
215 .sp |
211 .in +2 |
216 .in +2 |
212 .nf |
217 .nf |
213 # \fBdistro_const build /usr/share/distro_const/dc_livecd.xml\fR |
218 # \fBdistro_const build /usr/share/distro_const/dc_text_x86.xml\fR |
214 .fi |
219 .fi |
215 .in -2 |
220 .in -2 |
216 .sp |
221 .sp |
217 |
222 |
218 .SH ATTRIBUTES |
223 .SH ATTRIBUTES |