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