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>
| Split |
Close |
| Expand all |
| Collapse all |
--- old/usr/src/tools/scripts/Install.1onbld
+++ new/usr/src/tools/scripts/Install.1onbld
1 1 .\"
2 2 .\" Copyright 2010 Sun Microsystems, Inc. All rights reserved.
3 3 .\" Use is subject to license terms.
4 4 .\"
5 5 .\" CDDL HEADER START
6 6 .\"
7 7 .\" The contents of this file are subject to the terms of the
8 8 .\" Common Development and Distribution License (the "License").
9 9 .\" You may not use this file except in compliance with the License.
10 10 .\"
11 11 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
12 12 .\" or http://www.opensolaris.org/os/licensing.
13 13 .\" See the License for the specific language governing permissions
|
↓ open down ↓ |
13 lines elided |
↑ open up ↑ |
14 14 .\" and limitations under the License.
15 15 .\"
16 16 .\" When distributing Covered Code, include this CDDL HEADER in each
17 17 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
18 18 .\" If applicable, add the following below this CDDL HEADER, with the
19 19 .\" fields enclosed by brackets "[]" replaced with your own identifying
20 20 .\" information: Portions Copyright [yyyy] [name of copyright owner]
21 21 .\"
22 22 .\" CDDL HEADER END
23 23 .\"
24 -.TH Install 1ONBLD "14 Jan 2010"
24 +.TH INSTALL 1ONBLD "Jan 14, 2010"
25 25 .SH NAME
26 26 Install \- install a kernel from an ON workspace
27 27 .SH SYNOPSIS
28 28 .TP 8n
29 29 .B Install
30 30 .RB [ " \-w "
31 31 .IR workspace " ]"
32 32 .RB [ " \-s "
33 33 .IR "source dir" " ]"
34 34 .br
35 35 .RB [ " \-k "
36 36 .IR "kernel arch" " ]"
37 37 .RB "[ " \-n " | " \-t|T
38 38 .IR target " ]"
39 39 .br
40 40 .RB [ " \-u|m|a " ]
41 41 .RB [ " \-v|V|q " ]
42 42 .RB [ " \-c|p " ]
43 43 .br
44 44 .RB [ " \-l "
45 45 .IR "library file" " ]"
46 46 .RB [ " \-L " ]
47 47 .RB [ " \-3 " ]
48 48 .RB [ " \-6 " ]
49 49 .RB [ " \-K " ]
50 50 .br
51 51 .RB [ " \-o "
52 52 {
53 53 .BR obj " | "
54 54 .B debug
55 55 }
56 56 ]
57 57 .RB [ " \-d "
58 58 .IR "work dir" " ]"
59 59 .br
60 60 .RB [ " \-D "
61 61 .IR "library dir" " ]"
62 62 .RB [ " \-G "
63 63 .IB glomname " ]"
64 64 .RI [ " module ... " ]
65 65 .LP
66 66 or
67 67 .LP
68 68 .BR "Install \-R " "[ options ]"
69 69 .SH DESCRIPTION
70 70 .LP
71 71 .B Install
72 72 is a utility which simplifies the process of installing a 5.0 system.
73 73 .B Install
74 74 goes into a built ON workspace (or any kernel source tree),
75 75 looks at the Makefiles,
76 76 and figures out how to construct the /kernel and /usr/kernel directories.
77 77 It then creates a tarfile
78 78 .RB "(see " tar "(1))"
79 79 containing /kernel, /usr/kernel, and a few related /etc files. If a
80 80 .I target ([user@]machine:/dir)
81 81 is specified, the tarfile is either copied to
82 82 .IR machine:/dir " (-T) or untarred on " "machine" " in " "/dir" " (-t),"
83 83 using the remote user id
84 84 .IR user ,
85 85 if specified.
86 86 With no options,
87 87 .B Install
88 88 creates a sun4c system from files in the current workspace (as indicated
|
↓ open down ↓ |
54 lines elided |
↑ open up ↑ |
89 89 by $SRC) and places the tarfile in /tmp/Install.username/Install.sun4c.tar.
90 90
91 91 .SH OPTIONS
92 92 .TP 20n
93 93 .BI "-w" " ws"
94 94 Install the system built in the ON workspace
95 95 .I ws. ws
96 96 must be a built ON workspace \(em
97 97 .B Install
98 98 will not automatically invoke
99 -.BR make "(1). If " \-w " is not specified, " Install " uses the current
99 +.BR make (1) .
100 +If \-w is not specified,
101 +.B Install
102 +uses the current
100 103 workspace (as indicated by $CODEMGR_WS). If there is no current workspace,
101 104 .B Install
102 105 checks to see if you are in an appropriate source directory, e.g. uts/sun4c;
103 106 if so,
104 107 .B Install
105 108 takes files from there. Otherwise,
106 109 .B Install
107 110 looks for files under $SRC/uts.
108 111 .TP
109 112 .BI "-s" " source directory"
110 113 where to look for files [default: $SRC/uts].
111 114 .TP
112 115 .BI "-k" " kernel arch"
113 116 the type of kernel to install. The default is sun4c; however, if you invoke
114 117 .B Install
115 118 from $SRC/uts/sun4z,
116 119 .B Install
117 120 assumes you want a sun4z kernel.
118 121 .TP
119 122 .B "-n"
120 123 No target; just create the tarfile in
121 124 /tmp/Install.username/Install.sun4c.tar [default].
122 125 .BR "-n" " implies " "-p" .
123 126 .TP
124 127 .BI "-t" " target"
125 128 Install the system on
126 129 .I target ([user@]machine:/dir).
127 130 This means that kernel/unix is copied to
128 131 .I machine:/dir/kernel/unix,
129 132 etc.
130 133 .IR /dir " is typically either " / " or " /mnt.
131 134 .BR "-t" " implies " "-c" .
132 135 The default remote user id is the same as the local one ($LOGNAME).
133 136 .TP
134 137 .BI "-T" " target"
135 138 Copy the tarfile to
136 139 .I target ([user@]machine:/dir).
137 140 This creates the file
138 141 .I /dir/Install.tar
139 142 on
140 143 .I machine.
141 144 To finish the install, log on to
142 145 .I machine
143 146 as root, and type
144 147 .RB `` "cd /; tar xvf /dir/Install.tar" "''."
145 148 .BR "-T" " implies " "-c" .
146 149 .TP
147 150 .B "-u"
148 151 Install unix only.
149 152 .TP
150 153 .B "-m"
151 154 Install modules only.
152 155 .TP
153 156 .B "-a"
154 157 Install unix and all modules [default].
155 158 .TP
156 159 .B "-v"
157 160 Verbose mode.
158 161 .TP
159 162 .B "-V"
160 163 REALLY verbose mode. Useful mainly for debugging.
161 164 .TP
162 165 .B "-q"
163 166 Quiet mode [default]. Only fatal messages are printed.
164 167 .TP
165 168 .B "-c"
166 169 Clean up. After a successful install, delete the files created in
167 170 /tmp/Install.username. This is the default behavior if a
168 171 .I target
169 172 is specified with
170 173 .BR "-t" " or " "-T" .
171 174 .TP
172 175 .B "-p"
173 176 Preserve temp files. This is the default behavior when no
174 177 .I target
175 178 is specified
176 179 .RB ( "-n" ).
177 180 .TP
178 181 .B "-R"
179 182 Recover from a failed
180 183 .BR Install .
181 184 This is not required, it's just faster than restarting.
182 185 A typical scenario is for
183 186 .B Install
184 187 to run smoothly right up to the very end, but then die with
185 188 "Permission denied" when it tries to rsh/rcp to the target machine.
186 189 At this point, you log on to the target machine, diddle the permissions,
187 190 log off, and type
188 191 .RB `` "Install -R" "''."
189 192 .B Install
190 193 will only have to retry the rsh/rcp,
191 194 rather than rebuild the tarfile from scratch.
192 195 .TP
193 196 .BI "-d" " temp directory"
194 197 specifies where
195 198 .B Install
196 199 should create its temp files [default: /tmp/Install.username]. This is
197 200 useful if you have limited space in /tmp (\fBInstall\fR can take as
198 201 much as 100MB).
199 202 The suffix "Install.username" is always appended.
200 203 .TP
201 204 .B "-L"
202 205 add a system to your library. This allows you to build a personal
203 206 collection of installable systems from various environments and for
204 207 various architectures. When you type
205 208 .RB `` "Install -w /ws/ws_name -k arch -L" "'', " Install
206 209 creates a tarfile called
207 210 .I ws_name.arch.tar
|
↓ open down ↓ |
98 lines elided |
↑ open up ↑ |
208 211 in your library directory (~/LibInstall by default).
209 212 .BR "-L" " implies " "-c" .
210 213 .TP
211 214 .BI "-l" " library file"
212 215 Installs the system contained in
213 216 .I library file.
214 217 You may omit the ``.tar'' suffix. For example,
215 218 .RB `` "Install -l my_ws.sun4c -t machine:/" ''
216 219 installs a system you previously built with
217 220 .B "-L"
218 -(from sun4c files in my_ws) on
221 +(from sun4c files in my_ws) on
219 222 .IR machine:/ .
220 223 This is equivalent to typing
221 224 .RB `` "rsh machine '(cd /; tar xvf -)' <~/LibInstall/my_ws.sun4c.tar" '',
222 225 but it's easier to remember.
223 226 .TP
224 227 .BI "-D" " lib directory"
225 228 specifies the library directory [default: $HOME/LibInstall].
226 229 .TP
227 230 .BI "-G " glomname
228 231 gloms /kernel and /usr/kernel together into a single /kernel directory.
229 232 Useful for development work, e.g. use "Install -G good [...]" to create a
230 233 "/kernel.good".
231 234 .TP
232 235 .BR "-o " "{ \fBobj\fP | \fBdebug\fP }"
233 236 object directory. The default is "debug".
234 237 .TP
235 238 .B \-3
236 239 32-bit modules only
237 240 .TP
238 241 .B \-6
239 242 64-bit modules only
240 243 .TP
241 244 .B \-K
242 245 Do not include kmdb misc module or dmods
243 246 .TP
244 247 .B "-h"
245 248 Help. Prints a brief summary of
246 249 .BR Install "'s"
247 250 options.
248 251 .LP
249 252 If you are in a directory like $SRC/uts/sun4z when you invoke
250 253 .BR Install ,
251 254 it will infer that you want to install a sun4z system
252 255 from the current workspace.
253 256 .LP
254 257 If you supply a list of modules, it overrides any of the
255 258 .B "-uma"
|
↓ open down ↓ |
27 lines elided |
↑ open up ↑ |
256 259 options. You only need to specify the basename of the
257 260 module(s), e.g. ``\fBInstall ufs nfs le\fR''.
258 261 ``\fBInstall unix\fR'' is equivalent to ``\fBInstall -u\fR'', and
259 262 ``\fBInstall modules\fR'' is equivalent to ``\fBInstall -m\fR''.
260 263 .LP
261 264 You can customize
262 265 .B Install
263 266 by creating a .Installrc file in your home directory. .Installrc
264 267 should consist of a list of command-line-style options, e.g:
265 268 .LP
269 +.nf
266 270 .B
267 271 -w /ws/foo
272 +.fi
268 273 .br
274 +.nf
269 275 .B
270 276 -t labmachine:/mnt -pv
277 +.fi
271 278 .LP
272 279 .B Install
273 280 processes default options first, then .Installrc
274 281 options, then command-line options. In the case of
275 282 conflicting options (e.g. \fB-uma\fR), the last one wins.
276 283 .LP
277 284 In order to use the most convenient form of
278 285 .BR Install " (``" "Install -t machine:/" "''),"
279 286 you will need to do the following on the target machine:
280 287 .LP
281 288 .br
289 +.nf
282 290 (1) add your machine name to the /etc/hosts.equiv file
291 +.fi
283 292 .br
293 +.nf
284 294 (2) add your username to the /etc/{passwd,shadow} files
295 +.fi
285 296 .br
297 +.nf
286 298 (3) chown -R yourself /kernel /usr/kernel
299 +.fi
287 300 .br
301 +.nf
288 302 (4) chmod -R u+w /kernel /usr/kernel
303 +.fi
289 304 .SH "ENVIRONMENT"
290 305 .LP
291 306 You can set the following variables in your environment:
292 307 .LP
293 308 ON_CRYPTO_BINS
294 309 .IP
295 310 file containing signed cryptographic binaries. This is only needed if
296 311 you are not building the closed-source tree.
297 312 .LP
298 313 INSTALL_RC [default: $HOME/.Installrc]
299 314 .IP
300 315 file containing default options for \fBInstall\fR
301 316 .LP
302 317 INSTALL_STATE [default: $HOME/.Install.state]
303 318 .IP
304 319 where \fBInstall\fR keeps its state information
305 320 .LP
306 321 INSTALL_DIR [default: /tmp/Install.username]
307 322 .IP
308 323 where \fBInstall\fR does its work. This can be overridden on
309 324 the command line with \fB\-d\fR.
310 325 .LP
311 326 INSTALL_LIB [default: $HOME/LibInstall]
312 327 .IP
|
↓ open down ↓ |
14 lines elided |
↑ open up ↑ |
313 328 where \fBInstall\fR gets/puts library files. This can be overridden on
314 329 the command line with \fB\-D\fR.
315 330 .LP
316 331 INSTALL_CP [default: cp -p]
317 332 .IP
318 333 the command to copy files locally
319 334 .LP
320 335 INSTALL_RCP [default: rcp -p]
321 336 .IP
322 337 the command to copy files remotely
323 -.bp
324 338 .SH "EXAMPLES"
325 339 .LP
326 340 .B
327 341 Install -w /ws/blort -t machine:/
328 342 .IP
329 343 .RI "installs the system built in workspace " /ws/blort " on " machine:/
330 344 .LP
331 345 .B
332 346 Install -w /ws/blort -T machine:/tmp
333 347 .br
334 348 .B
335 349 rsh machine -l root "cd /; tar xvf /tmp/Install.tar"
336 350 .IP
337 351 is an equivalent way to do the previous example
338 352 .LP
339 353 .B Install
340 354 .IP
341 355 makes a tarfile containing a sun4c kernel,
342 356 and places it in /tmp/Install.username/Install.sun4c.tar. However, if you
343 357 are in one of the arch directories (e.g. $SRC/uts/sun4m) when you invoke
344 358 .BR Install ,
345 359 you will get a tarfile for that architecture instead.
346 360 .LP
347 361 .B
348 362 Install -k sun4m -w /ws/on493 -t mpbox:/ ufs
349 363 .IP
350 364 installs a new sun4m ufs module from workspace /ws/on493 on mpbox:/
351 365 .SH "FILES"
352 366 $HOME/.Installrc, $HOME/.Install.state
353 367 .SH "SEE ALSO"
354 368 .BR tar "(1), " rsh "(1), " rcp "(1)"
355 369 .SH "BUGS"
356 370 .BR tar "(1) and " rsh "(1)"
357 371 do not have particularly useful exit codes. To compensate,
358 372 .B Install
359 373 feeds stderr through grep -v and throws away error messages which it
360 374 considers harmless. If there's anything left,
361 375 .B Install
362 376 assumes it is fatal. It's a hack, but it works.
|
↓ open down ↓ |
29 lines elided |
↑ open up ↑ |
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX