]> CyberLeo.Net >> Repos - FreeBSD/releng/10.0.git/blob - share/doc/smm/01.setup/2.t
- Copy stable/10 (r259064) to releng/10.0 as part of the
[FreeBSD/releng/10.0.git] / share / doc / smm / 01.setup / 2.t
1 .\" Copyright (c) 1988, 1993 The Regents of the University of California.
2 .\" All rights reserved.
3 .\"
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
6 .\" are met:
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\"    notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\"    notice, this list of conditions and the following disclaimer in the
11 .\"    documentation and/or other materials provided with the distribution.
12 .\" 3. All advertising materials mentioning features or use of this software
13 .\"    must display the following acknowledgement:
14 .\"     This product includes software developed by the University of
15 .\"     California, Berkeley and its contributors.
16 .\" 4. Neither the name of the University nor the names of its contributors
17 .\"    may be used to endorse or promote products derived from this software
18 .\"    without specific prior written permission.
19 .\"
20 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30 .\" SUCH DAMAGE.
31 .\"
32 .\"     @(#)2.t 8.1 (Berkeley) 7/27/93
33 .\" $FreeBSD$
34 .\"
35 .ds lq ``
36 .ds rq ''
37 .ds LH "Installing/Operating \*(4B
38 .ds RH Bootstrapping
39 .ds CF \*(Dy
40 .Sh 1 "Bootstrap procedure"
41 .PP
42 This section explains the bootstrap procedure that can be used
43 to get the kernel supplied with this distribution running on your machine.
44 If you are not currently running \*(Ps you will
45 have to do a full bootstrap.
46 Section 3 describes how to upgrade a \*(Ps system.
47 An understanding of the operations used in a full bootstrap
48 is helpful in doing an upgrade as well.
49 In either case, it is highly desirable to read and understand
50 the remainder of this document before proceeding.
51 .PP
52 The distribution supports a somewhat wider set of machines than
53 those for which we have built binaries.
54 The architectures that are supported only in source form include:
55 .IP \(bu
56 Intel 386/486-based machines (ISA/AT or EISA bus only)
57 .IP \(bu
58 Sony News MIPS-based workstations
59 .IP \(bu
60 Omron Luna 68000-based workstations
61 .LP
62 If you wish to run one of these architectures,
63 you will have to build a cross compilation environment.
64 Note that the distribution does
65 .B not
66 include the machine support for the Tahoe and VAX architectures
67 found in previous BSD distributions.
68 Our primary development environment is the HP9000/300 series machines.
69 The other architectures are developed and supported by
70 people outside the university.
71 Consequently, we are not able to directly test or maintain these 
72 other architectures, so cannot comment on their robustness,
73 reliability, or completeness.
74 .Sh 2 "Bootstrapping from the tape"
75 .LP
76 The set of files on the distribution tape are as follows:
77 .IP 1)
78 A
79 .Xr dd (1)
80 (HP300),
81 .Xr tar (1)
82 (DECstation), or
83 .Xr dump (8)
84 (SPARC) image of the root filesystem
85 .IP 2)
86 A
87 .Xr tar
88 image of the
89 .Pn /var
90 filesystem
91 .IP 3)
92 A
93 .Xr tar
94 image of the
95 .Pn /usr
96 filesystem
97 .IP 4)
98 A
99 .Xr tar
100 image of
101 .Pn /usr/src/sys
102 .IP 5)
103 A
104 .Xr tar
105 image of
106 .Pn /usr/src
107 except sys and contrib
108 .IP 6)
109 A
110 .Xr tar
111 image of
112 .Pn /usr/src/contrib
113 .IP 7)
114 (8mm Exabyte tape distributions only)
115 A
116 .Xr tar
117 image of
118 .Pn /usr/src/X11R5
119 .LP
120 The tape bootstrap procedure used to create a
121 working system involves the following major steps:
122 .IP 1)
123 Transfer a bootable root filesystem from the tape to a disk
124 and get it booted and running.
125 .IP 2)
126 Build and restore the
127 .Pn /var
128 and
129 .Pn /usr
130 filesystems from tape with
131 .Xr tar (1).
132 .IP 3)
133 Extract the system and utility source files as desired.
134 .PP
135 The following sections describe the above steps in detail.
136 The details of the first step vary between architectures.
137 The specific steps for the HP300, SPARC, and DECstation are
138 given in the next three sections respectively.
139 You should follow the instructions for your particular architecture.
140 In all sections,
141 commands you are expected to type are shown in italics, while that
142 information printed by the system is shown emboldened.
143 .Sh 2 "Booting the HP300"
144 .Sh 3 "Supported hardware"
145 .LP
146 The hardware supported by \*(4B for the HP300/400 is as follows:
147 .TS
148 center box;
149 lw(1i) lw(4i).
150 CPU's   T{
151 68020 based (318, 319, 320, 330 and 350),
152 68030 based (340, 345, 360, 370, 375, 400) and
153 68040 based (380, 425, 433).
154 T}
155 _
156 DISK's  T{
157 HP-IB/CS80 (7912, 7914, 7933, 7936, 7945, 7957, 7958, 7959, 2200, 2203)
158 and SCSI-I (including magneto-optical).
159 T}
160 _
161 TAPE's  T{
162 Low-density CS80 cartridge (7914, 7946, 9144),
163 high-density CS80 cartridge (9145),
164 HP SCSI DAT and
165 SCSI Exabyte.
166 T}
167 _
168 RS232   T{
169 98644 built-in single-port, 98642 4-port and 98638 8-port interfaces.
170 T}
171 _
172 NETWORK T{
173 98643 internal and external LAN cards.
174 T}
175 _
176 GRAPHICS        T{
177 Terminal emulation and raw frame buffer support for
178 98544 / 98545 / 98547 (Topcat color & monochrome),
179 98548 / 98549 / 98550 (Catseye color & monochrome),
180 98700 / 98710 (Gatorbox),
181 98720 / 98721 (Renaissance),
182 98730 / 98731 (DaVinci) and
183 A1096A (Hyperion monochrome).
184 T}
185 _
186 INPUT   T{
187 General interface supporting all HIL devices.
188 (e.g. keyboard, 2 and 3 button mice, ID module, ...)
189 T}
190 _
191 MISC    T{
192 Battery-backed real time clock,
193 builtin and 98625A/B HP-IB interfaces,
194 builtin and 98658A SCSI interfaces,
195 serial printers and plotters on HP-IB,
196 and SCSI autochanger device.
197 T}
198 .TE
199 .LP
200 Major items that are not supported
201 include the 310 and 332 CPU's, 400 series machines
202 configured for Domain/OS, EISA and VME bus adaptors, audio, the centronics
203 port, 1/2" tape drives (7980), CD-ROM, and the PVRX/TVRX 3D graphics displays.
204 .Sh 3 "Standalone device file naming"
205 .LP
206 The standalone system device name syntax on the HP300 is of the form:
207 .DS
208 xx(a,c,u,p)
209 .DE
210 where
211 \fIxx\fP is the device type,
212 \fIa\fP specifies the adaptor to use,
213 \fIc\fP the controller,
214 \fIu\fP the unit, and
215 \fIp\fP a partition.
216 The \fIdevice type\fP differentiates the various disks and tapes and is one of:
217 ``rd'' for HP-IB CS80 disks,
218 ``ct'' for HP-IB CS80 cartridge tapes, or
219 ``sd'' for SCSI-I disks
220 (SCSI-I tapes are currently not supported).
221 The \fIadaptor\fP field is a logical HP-IB or SCSI bus adaptor card number.
222 This will typically be
223 0 for SCSI disks,
224 0 for devices on the ``slow'' HP-IB interface (usually tapes) and
225 1 for devices on the ``fast'' HP-IB interface (usually disks).
226 To get a complete mapping of physical (select-code) to logical card numbers
227 just type a ^C at the standalone prompt.
228 The \fIcontroller\fP field is the disk or tape's target number on the
229 HP-IB or SCSI bus.
230 For SCSI the range is 0 to 6 (7 is the adaptor address) and
231 for HP-IB the range is 0 to 7.
232 The \fIunit\fP field is unused and should be 0.
233 The \fIpartition\fP field is interpreted differently for tapes
234 and disks: for disks it is a disk partition (in the range 0-7),
235 and for tapes it is a file number offset on the tape.
236 Thus, partition 2 of a SCSI disk drive at target 3 on SCSI bus 1
237 would be ``sd(1,3,0,2)''.
238 If you have only one of any type bus adaptor, you may omit the adaptor
239 and controller numbers;
240 e.g. ``sd(0,2)'' could be used instead of ``sd(0,0,0,2)''.
241 The following examples always use the full syntax for clarity.
242 .Sh 3 "The procedure"
243 .LP
244 The basic steps involved in bringing up the HP300 are as follows:
245 .IP 1)
246 Obtain a second disk and format it, if necessary.
247 .IP 2)
248 Copy a root filesystem from the
249 tape onto the beginning of the disk.
250 .IP 3)
251 Boot the UNIX system on the new disk.
252 .IP 4)
253 (Optional) Build a root filesystem optimized for your disk.
254 .IP 5)
255 Label the disks with the
256 .Xr disklabel (8)
257 program.
258 .Sh 4 "Step 1: selecting and formatting a disk"
259 .PP
260 For your first system you will have to obtain a formatted disk
261 of a type given in the ``supported hardware'' list above.
262 If you want to load an entire binary system
263 (i.e., everything except
264 .Pn /usr/src ),
265 on the single disk you will need a minimum of 290MB,
266 ruling out anything smaller than a 7959B/S disk.
267 The disklabel included in the bootstrap root image is laid out
268 to accommodate this scenario.
269 Note that an HP SCSI magneto-optical disk will work fine for this case.
270 \*(4B will boot and run (albeit slowly) using one.
271 If you want to load source on a single disk system,
272 you will need at least 640MB (at least a 2213A SCSI or 2203A HP-IB disk).
273 A disk as small as the 7945A (54MB) can be used for the bootstrap
274 procedure but will hold only the root and primary swap partitions.
275 If you plan to use multiple disks,
276 refer to section 2.5 for suggestions on partitioning.
277 .PP
278 After selecting a disk, you may need to format it.
279 Since most HP disk drives come pre-formatted
280 (except optical media)
281 you probably will not, but if necessary,
282 you can format a disk under HP-UX using the
283 .Xr mediainit (1m)
284 program.
285 Once you have \*(4B up and running on one machine you can use the
286 .Xr scsiformat (8)
287 program to format additional SCSI disks.
288 Any additional HP-IB disks will have to be formatted using HP-UX.
289 .Sh 4 "Step 2: copying the root filesystem from tape to disk"
290 .PP
291 Once you have a formatted second disk you can use the
292 .Xr dd (1)
293 command under HP-UX to copy the root filesystem image from
294 the tape to the beginning of the second disk.
295 For HP's, the root filesystem image is the first file on the tape.
296 It includes a disklabel and bootblock along with the root filesystem.
297 An example command to copy the image from tape to the beginning of a disk is:
298 .DS
299 .ft CW
300 dd if=/dev/rmt/0m of=/dev/rdsk/1s0 bs=\*(Bzb
301 .DE
302 The actual special file syntax may vary depending on unit numbers and
303 the version of HP-UX that is running.
304 Consult the HP-UX
305 .Xr mt (7)
306 and
307 .Xr disk (7)
308 man pages for details.
309 .PP
310 Note that if you have a SCSI disk, you don't necessarily have to use
311 HP-UX (or an HP) to create the boot disk.
312 Any machine and operating system that will allow you to copy the
313 raw disk image out to block 0 of the disk will do.
314 .PP
315 If you have only a single machine with a single disk,
316 you may still be able to install and boot \*(4B if you have an
317 HP-IB cartridge tape drive.
318 If so, you can use a more difficult approach of booting a
319 standalone copy program from the tape, and using that to copy the
320 root filesystem image from the tape to the disk.
321 To do this, you need to extract the first file of the distribution tape
322 (the root image), copy it over to a machine with a cartridge drive
323 and then copy the image onto tape.
324 For example:
325 .DS
326 .ft CW
327 dd if=/dev/rst0 of=bootimage bs=\*(Bzb
328 rcp bootimage foo:/tmp/bootimage
329 <login to foo>
330 dd if=/tmp/bootimage of=/dev/rct/0m bs=\*(Bzb
331 .DE
332 Once this tape is created you can boot and run the standalone tape
333 copy program from it.
334 The copy program is loaded just as any other program would be loaded
335 by the bootrom in ``attended'' mode:
336 reset the CPU,
337 hold down the space bar until the word ``Keyboard'' appears in the
338 installed interface list, and
339 enter the menu selection for SYS_TCOPY.
340 Once loaded and running:
341 .DS
342 .TS
343 lw(2i) l.
344 \fBFrom:\fP \fI^C\fP    (control-C to see logical adaptor assignments)
345 \fBhpib0 at sc7\fP
346 \fBscsi0 at sc14\fP
347 \fBFrom:\fP \fIct(0,7,0,0)\fP   (HP-IB tape, target 7, first tape file)
348 \fBTo:\fP \fIsd(0,0,0,2)\fP     (SCSI disk, target 0, third partition)
349 \fBCopy completed: 1728 records copied\fP
350 .TE
351 .DE
352 .LP
353 This copy will likely take 30 minutes or more.
354 .Sh 4 "Step 3: booting the root filesystem"
355 .PP
356 You now have a bootable root filesystem on the disk.
357 If you were previously running with two disks,
358 it would be best if you shut down the machine and turn off power on
359 the HP-UX drive.
360 It will be less confusing and it will eliminate any chance of accidentally
361 destroying the HP-UX disk.
362 If you used a cartridge tape for booting you should also unload the tape
363 at this point.
364 Whether you booted from tape or copied from disk you should now reboot
365 the machine and do another attended boot (see previous section),
366 this time with SYS_TBOOT.
367 Once loaded and running the boot program will display the CPU type and
368 prompt for a kernel file to boot:
369 .DS
370 .B
371 HP433 CPU
372 Boot
373 .R
374 \fB:\fP \fI/kernel\fP
375 .DE
376 .LP
377 After providing the kernel name, the machine will boot \*(4B with
378 output that looks about like this:
379 .DS
380 .B
381 597480+34120+139288 start 0xfe8019ec
382 Copyright (c) 1982, 1986, 1989, 1991, 1993
383         The Regents of the University of California.
384 Copyright (c) 1992 Hewlett-Packard Company
385 Copyright (c) 1992 Motorola Inc.
386 All rights reserved.
387
388 4.4BSD UNIX #1: Tue Jul 20 11:40:36 PDT 1993
389     mckusick@vangogh.CS.Berkeley.EDU:/usr/obj/sys/compile/GENERIC.hp300
390 HP9000/433 (33MHz MC68040 CPU+MMU+FPU, 4k on-chip physical I/D caches)
391 real mem = xxx
392 avail mem = ###
393 using ### buffers containing ### bytes of memory
394 (... information about available devices ...)
395 root device?
396 .R
397 .DE
398 .PP
399 The first three numbers are printed out by the bootstrap program and
400 are the sizes of different parts of the system (text, initialized and
401 uninitialized data).  The system also allocates several system data
402 structures after it starts running.  The sizes of these structures are
403 based on the amount of available memory and the maximum count of active
404 users expected, as declared in a system configuration description.  This
405 will be discussed later.
406 .PP
407 UNIX itself then runs for the first time and begins by printing out a banner
408 identifying the release and
409 version of the system that is in use and the date that it was compiled. 
410 .PP
411 Next the
412 .I mem
413 messages give the
414 amount of real (physical) memory and the
415 memory available to user programs
416 in bytes.
417 For example, if your machine has 16Mb bytes of memory, then
418 \fBxxx\fP will be 16777216.
419 .PP
420 The messages that come out next show what devices were found on
421 the current processor.  These messages are described in
422 .Xr autoconf (4).
423 The distributed system may not have
424 found all the communications devices you have
425 or all the mass storage peripherals you have, especially
426 if you have more than
427 two of anything.  You will correct this when you create
428 a description of your machine from which to configure a site-dependent
429 version of UNIX.
430 The messages printed at boot here contain much of the information
431 that will be used in creating the configuration.
432 In a correctly configured system most of the information
433 present in the configuration description
434 is printed out at boot time as the system verifies that each device
435 is present.
436 .PP
437 The \*(lqroot device?\*(rq prompt was printed by the system
438 to ask you for the name of the root filesystem to use.
439 This happens because the distribution system is a \fIgeneric\fP
440 system, i.e., it can be bootstrapped on a cpu with its root device
441 and paging area on any available disk drive.
442 You will most likely respond to the root device question with ``sd0''
443 if you are booting from a SCSI disk,
444 or with ``rd0'' if you are booting from an HP-IB disk.
445 This response shows that the disk it is running
446 on is drive 0 of type ``sd'' or ``rd'' respectively.
447 If you have other disks attached to the system,
448 it is possible that the drive you are using will not be configured
449 as logical drive 0.
450 Check the autoconfiguration messages printed out by the kernel to
451 make sure.
452 These messages will show the type of every logical drive
453 and their associated controller and slave addresses.
454 You will later build a system tailored to your configuration
455 that will not prompt you for a root device when it is bootstrapped.
456 .DS
457 \fBroot device?\fP \fI\*(Dk0\fP
458 \fBWARNING: preposterous time in filesystem \-\- CHECK AND RESET THE DATE!\fP
459 \fBerase ^?, kill ^U, intr ^C\fP
460 \fB#\fP
461 .DE
462 .PP
463 The \*(lqerase ...\*(rq message is part of the
464 .Pn /.profile
465 that was executed by the root shell when it started.  This message
466 tells you about the settings of the character erase,
467 line erase, and interrupt characters.
468 .PP
469 UNIX is now running,
470 and the \fIUNIX Programmer's Manual\fP applies.  The ``#'' is the prompt
471 from the Bourne shell, and lets you know that you are the super-user,
472 whose login name is \*(lqroot\*(rq.
473 .PP
474 At this point, the root filesystem is mounted read-only.
475 Before continuing the installation, the filesystem needs to be ``updated''
476 to allow writing and device special files for the following steps need
477 to be created.
478 This is done as follows:
479 .DS
480 .TS
481 lw(2i) l.
482 \fB#\fP \fImount_mfs -s 1000 -T type /dev/null /tmp\fP  (create a writable filesystem)
483 (\fItype\fP is the disk type as determined from /etc/disktab)
484 \fB#\fP \fIcd /tmp\fP   (connect to that directory)
485 \fB#\fP \fImount \-uw /tmp/\*(Dk#a /\fP (read-write mount root filesystem)
486 .TE
487 .DE
488 .Sh 4 "Step 4: (optional) restoring the root filesystem"
489 .PP
490 The root filesystem that you are currently running on is complete,
491 however it probably is not optimally laid out for the disk on
492 which you are running.
493 If you will be cloning copies of the system onto multiple disks for
494 other machines, you are advised to connect one of these disks to
495 this machine, and build and restore a properly laid out root filesystem
496 onto it.
497 If this is the only machine on which you will be running \*(4B
498 or peak performance is not an issue, you can skip this step and
499 proceed directly to step 5.
500 .PP
501 Connect a second disk to your machine.
502 If you bootstrapped using the two disk method, you can
503 overwrite your initial HP-UX disk, as it will no longer
504 be needed (assuming you have no plans to run HP-UX again).
505 .PP
506 To really create the root filesystem on drive 1
507 you should first label the disk as described in step 5 below.
508 Then run the following commands:
509 .DS
510 \fB#\fP\|\fInewfs /dev/r\*(Dk1a\fP
511 \fB#\fP\|\fImount /dev/\*(Dk1a /mnt\fP
512 \fB#\fP\|\fIcd /mnt\fP
513 \fB#\fP\|\fIdump 0f \- /dev/r\*(Dk0a | restore xf \-\fP
514 (Note: restore will ask if you want to ``set owner/mode for '.'''
515 to which you should reply ``yes''.)
516 .DE
517 .PP
518 When this completes,
519 you should then shut down the system, and boot on the disk that
520 you just created following the procedure in step (3) above.
521 .Sh 4 "Step 5: placing labels on the disks"
522 .PP
523 For each disk on the HP300, \*(4B places information about the geometry
524 of the drive and the partition layout at byte offset 1024.
525 This information is written with
526 .Xr disklabel (8).
527 .PP
528 The root image just loaded includes a ``generic'' label intended to allow
529 easy installation of the root and
530 .Pn /usr
531 and may not be suitable for the actual
532 disk on which it was installed.
533 In particular,
534 it may make your disk appear larger or smaller than its real size.
535 In the former case, you lose some capacity.
536 In the latter, some of the partitions may map non-existent sectors
537 leading to errors if those partitions are used.
538 It is also possible that the defined geometry will interact poorly with
539 the filesystem code resulting in reduced performance.
540 However, as long as you are willing to give up a little space,
541 not use certain partitions or suffer minor performance degradation,
542 you might want to avoid this step;
543 especially if you do not know how to use
544 .Xr ed (1).
545 .PP
546 If you choose to edit this label,
547 you can fill in correct geometry information from
548 .Pn /etc/disktab .
549 You may also want to rework the ``e'' and ``f'' partitions used for loading
550 .Pn /usr
551 and
552 .Pn /var .
553 You should not attempt to, and
554 .Xr disklabel
555 will not let you, modify the ``a'', ``b'' and ``d'' partitions.
556 To edit a label:
557 .DS
558 \fB#\fP \fIEDITOR=ed\fP
559 \fB#\fP \fIexport EDITOR\fP
560 \fB#\fP \fIdisklabel  -r  -e  /dev/r\fBXX#\fPd
561 .DE
562 where \fBXX\fP is the type and \fB#\fP is the logical drive number; e.g.
563 .Pn /dev/rsd0d
564 or
565 .Pn /dev/rrd0d .
566 Note the explicit use of the ``d'' partition.
567 This partition includes the bootblock as does ``c''
568 and using it allows you to change the size of ``c''.
569 .PP
570 If you wish to label any additional disks, run the following command for each:
571 .DS
572 \fB#\|\fP\fIdisklabel  -rw  \fBXX#  type\fP  \fI"optional_pack_name"\fP
573 .DE
574 where \fBXX#\fP is the same as in the previous command
575 and \fBtype\fP is the HP300 disk device name as listed in
576 .Pn /etc/disktab .
577 The optional information may contain any descriptive name for the
578 contents of a disk, and may be up to 16 characters long.  This procedure
579 will place the label on the disk using the information found in
580 .Pn /etc/disktab
581 for the disk type named.
582 If you have changed the disk partition sizes,
583 you may wish to add entries for the modified configuration in
584 .Pn /etc/disktab
585 before labeling the affected disks.
586 .PP
587 You have now completed the HP300 specific part of the installation.
588 Now proceed to the generic part of the installation
589 described starting in section 2.5 below.
590 Note that where the disk name ``sd'' is used throughout section 2.5,
591 you should substitute the name ``rd'' if you are running on an HP-IB disk.
592 Also, if you are loading on a single disk with the default disklabel,
593 .Pn /var
594 should be restored to the ``f'' partition and
595 .Pn /usr
596 to the ``e'' partition.
597 .Sh 2 "Booting the SPARC"
598 .Sh 3 "Supported hardware"
599 .LP
600 The hardware supported by \*(4B for the SPARC is as follows:
601 .TS
602 center box;
603 lw(1i) lw(4i).
604 CPU's   T{
605 SPARCstation 1 series (1, 1+, SLC, IPC) and
606 SPARCstation 2 series (2, IPX).
607 T}
608 _
609 DISK's  T{
610 SCSI.
611 T}
612 _
613 TAPE's  T{
614 none.
615 T}
616 _
617 NETWORK T{
618 SPARCstation Lance (le).
619 T}
620 _
621 GRAPHICS        T{
622 bwtwo and cgthree.
623 T}
624 _
625 INPUT   T{
626 Keyboard and mouse.
627 T}
628 _
629 MISC    T{
630 Battery-backed real time clock,
631 built-in serial devices,
632 Sbus SCSI controller,
633 and audio device.
634 T}
635 .TE
636 .LP
637 Major items that are not supported include
638 anything VME-based,
639 the GX (cgsix) display,
640 the floppy disk, and SCSI tapes.
641 .Sh 3 "Limitations"
642 .LP
643 There are several important limitations on the \*(4B distribution
644 for the SPARC:
645 .IP 1)
646 You
647 .B must
648 have SunOS 4.1.x or Solaris to bring up \*(4B.
649 There is no SPARCstation bootstrap code in this distribution.  The
650 Sun-supplied boot loader will be used to boot \*(4B; you must copy
651 this from your SunOS distribution.  This imposes several
652 restrictions on the system, as detailed below.
653 .IP 2)
654 The \*(4B SPARC kernel does not remap SCSI IDs.  A SCSI disk at
655 target 0 will become ``sd0'', where in SunOS the same disk will
656 normally be called ``sd3''.  If your existing SunOS system is
657 diskful, it will be least painful to have SunOS running on the disk
658 on target 0 lun 0 and put \*(4B on the disk on target 3 lun 0.  Both
659 systems will then think they are running on ``sd0'', and you can
660 boot either system as needed simply by changing the EEPROM's boot
661 device.
662 .IP 3)
663 There is no SCSI tape driver.
664 You must have another system for tape reading and backups.
665 .IP 4)
666 Although the \*(4B SPARC kernel will handle existing SunOS shared
667 libraries, it does not use or create them itself, and therefore
668 requires much more disk space than SunOS does.
669 .IP 5)
670 It is currently difficult (though not completely impossible) to
671 run \*(4B diskless.  These instructions assume you will have a local
672 boot, swap, and root filesystem.
673 .IP 6)
674 When using a serial port rather than a graphics display as the console,
675 only port
676 .Pn ttya
677 can be used.
678 Attempts to use port
679 .Pn ttyb
680 will fail when the kernel tries
681 to print the boot up messages to the console.
682 .Sh 3 "The procedure"
683 .PP
684 You must have a spare disk on which to place \*(4B.
685 The steps involved in bootstrapping this tape are as follows:
686 .IP 1)
687 Bring up SunOS (preferably SunOS 4.1.x or Solaris 1.x, although
688 Solaris 2 may work \(em this is untested).
689 .IP 2)
690 Attach auxiliary SCSI disk(s).  Format and label using the
691 SunOS formatting and labeling programs as needed.
692 Note that the root filesystem currently requires at least 10 MB; 16 MB
693 or more is recommended.  The b partition will be used for swap;
694 this should be at least 32 MB.
695 .IP 3)
696 Use the SunOS
697 .Xr newfs
698 to build the root filesystem.  You may also
699 want to build other filesystems at the same time.  (By default, the
700 \*(4B
701 .Xr newfs
702 builds a filesystem that SunOS will not handle; if you
703 plan to switch OSes back and forth you may want to sacrifice the
704 performance gain from the new filesystem format for compatibility.)
705 You can build an old-format filesystem on \*(4B by giving the \-O
706 option to
707 .Xr newfs (8).
708 .Xr Fsck (8)
709 can convert old format filesystems to new format
710 filesystems, but not vice versa,
711 so you may want to initially build old format filesystems so that they
712 can be mounted under SunOS,
713 and then later convert them to new format filesystems when you are
714 satisfied that \*(4B is running properly.
715 In any case,
716 .B
717 you must build an old-style root filesystem
718 .R
719 so that the SunOS boot program will work.
720 .IP 4)
721 Mount the new root, then copy the SunOS
722 .Pn /boot
723 into place and use the SunOS ``installboot'' program
724 to enable disk-based booting.
725 Note that the filesystem must be mounted when you do the ``installboot'':
726 .DS
727 .ft CW
728 # mount /dev/sd3a /mnt
729 # cp /boot /mnt/boot
730 # cd /usr/kvm/mdec
731 # installboot /mnt/boot bootsd /dev/rsd3a
732 .DE
733 The SunOS
734 .Pn /boot
735 will load \*(4B kernels; there is no SPARCstation
736 bootstrap code on the distribution.  Note that the SunOS
737 .Pn /boot
738 does not handle the new \*(4B filesystem format.
739 .IP 5)
740 Restore the contents of the \*(4B root filesystem.
741 .DS
742 .ft CW
743 # cd /mnt
744 # rrestore xf tapehost:/dev/nrst0
745 .DE
746 .IP 6)
747 Boot the supplied kernel:
748 .DS
749 .ft CW
750 # halt
751 ok boot sd(0,3)kernel -s                [for old proms] OR
752 ok boot disk3 -s                        [for new proms]
753 \&... [\*(4B boot messages]
754 .DE
755 .LP
756 To install the remaining filesystems, use the procedure described
757 starting in section 2.5.
758 In these instructions,
759 .Pn /usr
760 should be loaded into the ``e'' partition and
761 .Pn /var
762 in the ``f'' partition.
763 .LP
764 After completing the filesystem installation you may want
765 to set up \*(4B to reboot automatically:
766 .DS
767 .ft CW
768 # halt
769 ok setenv boot-from sd(0,3)kernel       [for old proms] OR
770 ok setenv boot-device disk3             [for new proms]
771 .DE
772 If you build backwards-compatible filesystems, either with the SunOS
773 newfs or with the \*(4B ``\-O'' option, you can mount these under
774 SunOS.  The SunOS fsck will, however, always think that these filesystems
775 are corrupted, as there are several new (previously unused)
776 superblock fields that are updated in \*(4B.  Running ``fsck \-b32''
777 and letting it ``fix'' the superblock will take care of this.
778 .sp 0.5
779 If you wish to run SunOS binaries that use SunOS shared libraries, you
780 simply need to copy all the dynamic linker files from an existing
781 SunOS system:
782 .DS
783 .ft CW
784 # rcp sunos-host:/etc/ld.so.cache /etc/
785 # rcp sunos-host:'/usr/lib/*.so*' /usr/lib/
786 .DE
787 The SunOS compiler and linker should be able to produce SunOS binaries
788 under \*(4B, but this has not been tested.  If you plan to try it you
789 will need the appropriate .sa files as well.
790 .Sh 2 "Booting the DECstation"
791 .Sh 3 "Supported hardware"
792 .LP
793 The hardware supported by \*(4B for the DECstation is as follows:
794 .TS
795 center box;
796 lw(1i) lw(4i).
797 CPU's   T{
798 R2000 based (3100) and
799 R3000 based (5000/200, 5000/20, 5000/25, 5000/1xx).
800 T}
801 _
802 DISK's  T{
803 SCSI-I (tested RZ23, RZ55, RZ57, Maxtor 8760S).
804 T}
805 _
806 TAPE's  T{
807 SCSI-I (tested DEC TK50, Archive DAT, Emulex MT02).
808 T}
809 _
810 RS232   T{
811 Internal DEC dc7085 and AMD 8530 based interfaces.
812 T}
813 _
814 NETWORK T{
815 TURBOchannel PMAD-AA and internal LANCE based interfaces.
816 T}
817 _
818 GRAPHICS        T{
819 Terminal emulation and raw frame buffer support for
820 3100 (color & monochrome),
821 TURBOchannel PMAG-AA, PMAG-BA, PMAG-DV.
822 T}
823 _
824 INPUT   T{
825 Standard DEC keyboard (LK201) and mouse.
826 T}
827 _
828 MISC    T{
829 Battery-backed real time clock,
830 internal and TURBOchannel PMAZ-AA SCSI interfaces.
831 T}
832 .TE
833 .LP
834 Major items that are not supported include the 5000/240
835 (there is code but not compiled in or tested),
836 R4000 based machines, FDDI and audio interfaces.
837 Diskless machines are not supported but booting kernels and bootstrapping
838 over the network is supported on the 5000 series.
839 .Sh 3 "The procedure"
840 .PP
841 The first file on the distribution tape is a tar file that contains
842 four files.
843 The first step requires a running UNIX (or ULTRIX) system that can
844 be used to extract the tar archive from the first file on the tape.
845 The command:
846 .DS
847 .ft CW
848 tar xf /dev/rmt0
849 .DE
850 will extract the following four files:
851 .DS
852 A) root.image: \fIdd\fP image of the root filesystem
853 B) kernel.tape: \fIdd\fP image for creating boot tapes
854 C) kernel.net: file for booting over the network
855 D) root.dump: \fIdump\fP image of the root filesystem
856 .DE
857 There are three basic ways a system can be bootstrapped corresponding to the
858 first three files.
859 You may want to read the section on bootstrapping the HP300
860 since many of the steps are similar.
861 A spare, formatted SCSI disk is also useful.
862 .Sh 4 "Procedure A: copy root filesystem to disk"
863 .PP
864 This procedure is similar to the HP300.
865 If you have an extra disk, the easiest approach is to use \fIdd\fP\|(1)
866 under ULTRIX to copy the root filesystem image to the beginning
867 of the spare disk. 
868 The root filesystem image includes a disklabel and bootblock along with the
869 root filesystem.
870 An example command to copy the image to the beginning of a disk is:
871 .DS
872 .ft CW
873 dd if=root.image of=/dev/rz1c bs=\*(Bzb
874 .DE
875 The actual special file syntax will vary depending on unit numbers and
876 the version of ULTRIX that is running.
877 This system is now ready to boot. You can boot the kernel with one of the
878 following PROM commands. If you are booting on a 3100, the disk must be SCSI
879 id zero because of a bug.
880 .DS
881 .ft CW
882 DEC 3100:    boot \-f rz(0,0,0)kernel
883 DEC 5000:    boot 5/rz0/kernel
884 .DE
885 You can then proceed to section 2.5
886 to create reasonable disk partitions for your machine
887 and then install the rest of the system.
888 .Sh 4 "Procedure B: bootstrap from tape"
889 .PP
890 If you have only a single machine with a single disk,
891 you need to use the more difficult approach of booting a
892 kernel and mini-root from tape or the network, and using it to restore
893 the root filesystem.
894 .PP
895 First, you will need to create a boot tape. This can be done using
896 \fIdd\fP as in the following example.
897 .DS
898 .ft CW
899 dd if=kernel.tape of=/dev/nrmt0 bs=1b
900 dd if=root.dump of=/dev/nrmt0 bs=\*(Bzb
901 .DE
902 The actual special file syntax for the tape drive will vary depending on
903 unit numbers, tape device and the version of ULTRIX that is running.
904 .PP
905 The first file on the boot tape contains a boot header, kernel, and
906 mini-root filesystem that the PROM can copy into memory.
907 Installing from tape has only been tested
908 on a 3100 and a 5000/200 using a TK50 tape drive. Here are two example
909 PROM commands to boot from tape.
910 .DS
911 .ft CW
912 DEC 3100:    boot \-f tz(0,5,0) m    # 5 is the SCSI id of the TK50
913 DEC 5000:    boot 5/tz6 m           # 6 is the SCSI id of the TK50
914 .DE
915 The `m' argument tells the kernel to look for a root filesystem in memory.
916 Next you should proceed to section 2.4.3 to build a disk-based root filesystem.
917 .Sh 4 "Procedure C: bootstrap over the network"
918 .PP
919 You will need a host machine that is running the \fIbootp\fP server 
920 with the
921 .Pn kernel.net
922 file installed in the default directory defined by the
923 configuration file for
924 .Xr bootp .
925 Here are two example PROM commands to boot across the net:
926 .DS
927 .ft CW
928 DEC 3100:       boot \-f tftp()kernel.net m
929 DEC 5000:       boot 6/tftp/kernel.net m
930 .DE
931 This command should load the kernel and mini-root into memory and
932 run the same as the tape install (procedure B).
933 The rest of the steps are the same except
934 you will need to start the network
935 (if you are unsure how to fill in the <name> fields below,
936 see sections 4.4 and 5).
937 Execute the following to start the networking:
938 .DS
939 .ft CW
940 # mount \-uw /
941 # echo 127.0.0.1 localhost >> /etc/hosts
942 # echo <your.host.inet.number> myname.my.domain myname >> /etc/hosts
943 # echo <friend.host.inet.number> myfriend.my.domain myfriend >> /etc/hosts
944 # ifconfig le0 inet myname
945 .DE
946 Next you should proceed to section 2.4.3 to build a disk-based root filesystem.
947 .Sh 3 "Label disk and create the root filesystem"
948 .LP
949 There are five steps to create a disk-based root filesystem.
950 .IP 1)
951 Label the disk.
952 .DS
953 .ft CW
954 # disklabel -W /dev/rrz?c               # This enables writing the label
955 # disklabel -w -r -B /dev/rrz?c $DISKTYPE
956 # newfs /dev/rrz?a
957 \&...
958 # fsck /dev/rrz?a
959 \&...
960 .DE
961 Supported disk types are listed in
962 .Pn /etc/disktab .
963 .IP 2)
964 Restore the root filesystem.
965 .DS
966 .ft CW
967 # mount \-uw /
968 # mount /dev/rz?a /a
969 # cd /a
970 .DE
971 .ti +0.4i
972 If you are restoring locally (procedure B), run:
973 .DS
974 .ft CW
975 # mt \-f /dev/nrmt0 rew
976 # restore \-xsf 2 /dev/rmt0
977 .DE
978 .ti +0.4i
979 If you are restoring across the net (procedure c), run:
980 .DS
981 .ft CW
982 # rrestore xf myfriend:/path/to/root.dump
983 .DE
984 .ti +0.4i
985 When the restore finishes, clean up with:
986 .DS
987 .ft CW
988 # cd /
989 # sync
990 # umount /a
991 # fsck /dev/rz?a
992 .DE
993 .IP 3)
994 Reset the system and initialize the PROM monitor to boot automatically.
995 .DS
996 .ft CW
997 DEC 3100:       setenv bootpath boot \-f rz(0,?,0)kernel
998 DEC 5000:       setenv bootpath 5/rz?/kernel -a
999 .DE
1000 .IP 4)
1001 After booting UNIX, you will need to create
1002 .Pn /dev/mouse
1003 to run X Window System as in the following example.
1004 .DS
1005 .ft CW
1006 rm /dev/mouse
1007 ln /dev/xx /dev/mouse
1008 .DE
1009 The 'xx' should be one of the following:
1010 .DS
1011 pm0     raw interface to PMAX graphics devices
1012 cfb0    raw interface to TURBOchannel PMAG-BA color frame buffer
1013 xcfb0   raw interface to maxine graphics devices
1014 mfb0    raw interface to mono graphics devices
1015 .DE
1016 You can then proceed to section 2.5 to install the rest of the system.
1017 Note that where the disk name ``sd'' is used throughout section 2.5,
1018 you should substitute the name ``rz''.
1019 .Sh 2 "Disk configuration"
1020 .PP
1021 All architectures now have a root filesystem up and running and
1022 proceed from this point to layout filesystems to make use
1023 of the available space and to balance disk load for better system
1024 performance.
1025 .Sh 3 "Disk naming and divisions"
1026 .PP
1027 Each physical disk drive can be divided into up to 8 partitions;
1028 UNIX typically uses only 3 or 4 partitions.
1029 For instance, the first partition, \*(Dk0a,
1030 is used for a root filesystem, a backup thereof,
1031 or a small filesystem like,
1032 .Pn /var/tmp ;
1033 the second partition, \*(Dk0b,
1034 is used for paging and swapping; and
1035 a third partition, typically \*(Dk0e,
1036 holds a user filesystem.
1037 .PP
1038 The space available on a disk varies per device.
1039 Each disk typically has a paging area of 30 to 100 megabytes
1040 and a root filesystem of about 17 megabytes.
1041 .\" XXX check
1042 The distributed system binaries occupy about 150 (180 with X11R5) megabytes
1043 .\" XXX check
1044 while the major sources occupy another 250 (340 with X11R5) megabytes.
1045 The
1046 .Pn /var
1047 filesystem as delivered on the tape is only 2Mb,
1048 however it should have at least 50Mb allocated to it just for
1049 normal system activity.
1050 Usually it is allocated the last partition on the disk
1051 so that it can provide as much space as possible to the
1052 .Pn /var/users
1053 filesystem.
1054 See section 2.5.4 for further details on disk layouts.
1055 .PP
1056 Be aware that the disks have their sizes
1057 measured in disk sectors (usually 512 bytes), while the UNIX filesystem
1058 blocks are variable sized.
1059 If
1060 .Sm BLOCKSIZE=1k
1061 is set in the user's environment, all user programs report
1062 disk space in kilobytes, otherwise,
1063 disk sizes are always reported in units of 512-byte sectors\**.
1064 .FS
1065 You can thank System V intransigence and POSIX duplicity for
1066 requiring that 512-byte blocks be the units that programs report.
1067 .FE
1068 The
1069 .Pn /etc/disktab
1070 file used in labelling disks and making filesystems
1071 specifies disk partition sizes in sectors.
1072 .Sh 3 "Layout considerations"
1073 .PP
1074 There are several considerations in deciding how
1075 to adjust the arrangement of things on your disks.
1076 The most important is making sure that there is adequate space
1077 for what is required; secondarily, throughput should be maximized.
1078 Paging space is an important parameter.
1079 The system, as distributed, sizes the configured
1080 paging areas each time the system is booted.  Further,
1081 multiple paging areas of different sizes may be interleaved.
1082 .PP
1083 Many common system programs (C, the editor, the assembler etc.)
1084 create intermediate files in the
1085 .Pn /tmp
1086 directory, so the filesystem where this is stored also should be made
1087 large enough to accommodate most high-water marks.
1088 Typically,
1089 .Pn /tmp
1090 is constructed from a memory-based filesystem (see
1091 .Xr mount_mfs (8)).
1092 Programs that want their temporary files to persist
1093 across system reboots (such as editors) should use
1094 .Pn /var/tmp .
1095 If you plan to use a disk-based
1096 .Pn /tmp
1097 filesystem to avoid loss across system reboots, it makes
1098 sense to mount this in a ``root'' (i.e. first partition)
1099 filesystem on another disk.
1100 All the programs that create files in
1101 .Pn /tmp
1102 take care to delete them, but are not immune to rare events
1103 and can leave dregs.
1104 The directory should be examined every so often and the old
1105 files deleted.
1106 .PP
1107 The efficiency with which UNIX is able to use the CPU
1108 is often strongly affected by the configuration of disk controllers;
1109 it is critical for good performance to balance disk load.
1110 There are at least five components of the disk load that you can
1111 divide between the available disks:
1112 .IP 1)
1113 The root filesystem.
1114 .IP 2)
1115 The
1116 .Pn /var
1117 and
1118 .Pn /var/tmp
1119 filesystems.
1120 .IP 3)
1121 The
1122 .Pn /usr
1123 filesystem.
1124 .IP 4)
1125 The user filesystems.
1126 .IP 5)
1127 The paging activity.
1128 .LP
1129 The following possibilities are ones we have used at times
1130 when we had 2, 3 and 4 disks:
1131 .TS
1132 center doublebox;
1133 l | c s s
1134 l | lw(5) | lw(5) | lw(5).
1135         disks
1136 what    2       3       4
1137 _
1138 root    0       0       0
1139 var     1       2       3
1140 usr     1       1       1
1141 paging  0+1     0+2     0+2+3
1142 users   0       0+2     0+2
1143 archive x       x       3
1144 .TE
1145 .PP
1146 The most important things to consider are to
1147 even out the disk load as much as possible, and to do this by
1148 decoupling filesystems (on separate arms) between which heavy copying occurs.
1149 Note that a long term average balanced load is not important; it is
1150 much more important to have an instantaneously balanced
1151 load when the system is busy.
1152 .PP
1153 Intelligent experimentation with a few filesystem arrangements can
1154 pay off in much improved performance.  It is particularly easy to
1155 move the root, the
1156 .Pn /var
1157 and
1158 .Pn /var/tmp
1159 filesystems and the paging areas.  Place the
1160 user files and the
1161 .Pn /usr
1162 directory as space needs dictate and experiment
1163 with the other, more easily moved filesystems.
1164 .Sh 3 "Filesystem parameters"
1165 .PP
1166 Each filesystem is parameterized according to its block size,
1167 fragment size, and the disk geometry characteristics of the
1168 medium on which it resides.  Inaccurate specification of the disk
1169 characteristics or haphazard choice of the filesystem parameters
1170 can result in substantial throughput degradation or significant
1171 waste of disk space.  As distributed,
1172 filesystems are configured according to the following table.
1173 .DS
1174 .TS
1175 center;
1176 l l l.
1177 Filesystem      Block size      Fragment size
1178 _
1179 root    8 kbytes        1 kbytes
1180 usr     8 kbytes        1 kbytes
1181 users   4 kbytes        512 bytes
1182 .TE
1183 .DE
1184 .PP
1185 The root filesystem block size is
1186 made large to optimize bandwidth to the associated disk.
1187 The large block size is important as many of the most
1188 heavily used programs are demand paged out of the
1189 .Pn /bin
1190 directory.
1191 The fragment size of 1 kbyte is a ``nominal'' value to use
1192 with a filesystem.  With a 1 kbyte fragment size
1193 disk space utilization is about the same
1194 as with the earlier versions of the filesystem.
1195 .PP
1196 The filesystems for users have a 4 kbyte block
1197 size with 512 byte fragment size.  These parameters
1198 have been selected based on observations of the
1199 performance of our user filesystems.  The 4 kbyte
1200 block size provides adequate bandwidth while the
1201 512 byte fragment size provides acceptable space compaction
1202 and disk fragmentation.
1203 .PP
1204 Other parameters may be chosen in constructing filesystems,
1205 but the factors involved in choosing a block
1206 size and fragment size are many and interact in complex
1207 ways.  Larger block sizes result in better
1208 throughput to large files in the filesystem as
1209 larger I/O requests will then be done by the
1210 system.  However,
1211 consideration must be given to the average file sizes
1212 found in the filesystem and the performance of the
1213 internal system buffer cache.   The system
1214 currently provides space in the inode for
1215 12 direct block pointers, 1 single indirect block
1216 pointer, 1 double indirect block pointer,
1217 and 1 triple indirect block pointer.
1218 If a file uses only direct blocks, access time to
1219 it will be optimized by maximizing the block size.
1220 If a file spills over into an indirect block,
1221 increasing the block size of the filesystem may
1222 decrease the amount of space used
1223 by eliminating the need to allocate an indirect block.
1224 However, if the block size is increased and an indirect
1225 block is still required, then more disk space will be
1226 used by the file because indirect blocks are allocated
1227 according to the block size of the filesystem.
1228 .PP
1229 In selecting a fragment size for a filesystem, at least
1230 two considerations should be given.  The major performance
1231 tradeoffs observed are between an 8 kbyte block filesystem
1232 and a 4 kbyte block filesystem.  Because of implementation
1233 constraints, the block size versus fragment size ratio can not
1234 be greater than 8.  This means that an 8 kbyte filesystem
1235 will always have a fragment size of at least 1 kbytes.  If
1236 a filesystem is created with a 4 kbyte block size and a
1237 1 kbyte fragment size, then upgraded to an 8 kbyte block size
1238 and 1 kbyte fragment size, identical space compaction will be
1239 observed.  However, if a filesystem has a 4 kbyte block size
1240 and 512 byte fragment size, converting it to an 8K/1K
1241 filesystem will result in 4-8% more space being
1242 used.  This implies that 4 kbyte block filesystems that
1243 might be upgraded to 8 kbyte blocks for higher performance should
1244 use fragment sizes of at least 1 kbytes to minimize the amount
1245 of work required in conversion.
1246 .PP
1247 A second, more important, consideration when selecting the
1248 fragment size for a filesystem is the level of fragmentation
1249 on the disk.  With an 8:1 fragment to block ratio, storage fragmentation
1250 occurs much sooner, particularly with a busy filesystem running
1251 near full capacity.  By comparison, the level of fragmentation in a
1252 4:1 fragment to block ratio filesystem is one tenth as severe.  This
1253 means that on filesystems where many files are created and
1254 deleted, the 512 byte fragment size is more likely to result in apparent
1255 space exhaustion because of fragmentation.  That is, when the filesystem
1256 is nearly full, file expansion that requires locating a
1257 contiguous area of disk space is more likely to fail on a 512
1258 byte filesystem than on a 1 kbyte filesystem.  To minimize
1259 fragmentation problems of this sort, a parameter in the super
1260 block specifies a minimum acceptable free space threshold.  When
1261 normal users (i.e. anyone but the super-user) attempt to allocate
1262 disk space and the free space threshold is exceeded, the user is
1263 returned an error as if the filesystem were really full.  This
1264 parameter is nominally set to 5%; it may be changed by supplying
1265 a parameter to
1266 .Xr newfs (8),
1267 or by updating the super block of an existing filesystem using
1268 .Xr tunefs (8).
1269 .PP
1270 Finally, a third, less common consideration is the attributes of
1271 the disk itself.  The fragment size should not be smaller than the
1272 physical sector size of the disk.  As an example, the HP magneto-optical
1273 disks have 1024 byte physical sectors.  Using a 512 byte fragment size
1274 on such disks will work but is extremely inefficient.
1275 .PP
1276 Note that the above discussion considers block sizes of up to only 8k.
1277 As of the 4.4 release, the maximum block size has been increased to 64k.
1278 This allows an entirely new set of block/fragment combinations for which
1279 there is little experience to date.
1280 In general though, unless a filesystem is to be used
1281 for a special purpose application (for example, storing
1282 image processing data), we recommend using the
1283 values supplied above.
1284 Remember that the current
1285 implementation limits the block size to at most 64 kbytes
1286 and the ratio of block size versus fragment size must be 1, 2, 4, or 8.
1287 .PP
1288 The disk geometry information used by the filesystem
1289 affects the block layout policies employed.  The file
1290 .Pn /etc/disktab ,
1291 as supplied, contains the data for most
1292 all drives supported by the system.  Before constructing
1293 a filesystem with
1294 .Xr newfs (8)
1295 you should label the disk (if it has not yet been labeled,
1296 and the driver supports labels).
1297 If labels cannot be used, you must instead
1298 specify the type of disk on which the filesystem resides;
1299 .Xr newfs
1300 then reads
1301 .Pn /etc/disktab
1302 instead of the pack label.
1303 This file also contains the default
1304 filesystem partition
1305 sizes, and default block and fragment sizes.  To
1306 override any of the default values you can modify the file,
1307 edit the disk label,
1308 or use an option to
1309 .Xr newfs .
1310 .Sh 3 "Implementing a layout"
1311 .PP
1312 To put a chosen disk layout into effect, you should use the
1313 .Xr newfs (8)
1314 command to create each new filesystem.
1315 Each filesystem must also be added to the file
1316 .Pn /etc/fstab
1317 so that it will be checked and mounted when the system is bootstrapped.
1318 .PP
1319 First we will consider a system with a single disk.
1320 There is little real choice on how to do the layout;
1321 the root filesystem goes in the ``a'' partition,
1322 .Pn /usr
1323 goes in the ``e'' partition, and
1324 .Pn /var
1325 fills out the remainder of the disk in the ``f'' partition.
1326 This is the organization used if you loaded the disk-image root filesystem.
1327 With the addition of a memory-based
1328 .Pn /tmp
1329 filesystem, its fstab entry would be as follows:
1330 .TS
1331 center;
1332 lfC lfC l l n n.
1333 /dev/\*(Dk0a    /       ufs     rw      1       1
1334 /dev/\*(Dk0b    none    swap    sw      0       0
1335 /dev/\*(Dk0b    /tmp    mfs     rw,-s=14000,-b=8192,-f=1024,-T=sd660    0       0
1336 /dev/\*(Dk0e    /usr    ufs     ro      1       2
1337 /dev/\*(Dk0f    /var    ufs     rw      1       2
1338 .TE
1339 .PP
1340 If we had a second disk, we would split the load between the drives.
1341 On the second disk, we place the
1342 .Pn /usr
1343 and
1344 .Pn /var
1345 filesystems in their usual \*(Dk1e and \*(Dk1f
1346 partitions respectively.
1347 The \*(Dk1b partition would be used as a second paging area,
1348 and the \*(Dk1a partition left as a spare root filesystem
1349 (alternatively \*(Dk1a could be used for
1350 .Pn /var/tmp ).
1351 The first disk still holds the
1352 the root filesystem in \*(Dk0a, and the primary swap area in \*(Dk0b.
1353 The \*(Dk0e partition is used to hold home directories in
1354 .Pn /var/users .
1355 The \*(Dk0f partition can be used for
1356 .Pn /usr/src
1357 or alternately the \*(Dk0e partition can be extended to cover
1358 the rest of the disk with
1359 .Xr disklabel (8).
1360 As before, the
1361 .Pn /tmp
1362 directory is a memory-based filesystem.
1363 Note that to interleave the paging between the two disks
1364 you must build a system configuration that specifies:
1365 .DS
1366 config  kernel  root on \*(Dk0 swap on \*(Dk0 and \*(Dk1
1367 .DE
1368 The
1369 .Pn /etc/fstab
1370 file would then contain
1371 .TS
1372 center;
1373 lfC lfC l l n n.
1374 /dev/\*(Dk0a    /       ufs     rw      1       1
1375 /dev/\*(Dk0b    none    swap    sw      0       0
1376 /dev/\*(Dk1b    none    swap    sw      0       0
1377 /dev/\*(Dk0b    /tmp    mfs     rw,-s=14000,-b=8192,-f=1024,-T=sd660    0       0
1378 /dev/\*(Dk1e    /usr    ufs     ro      1       2
1379 /dev/\*(Dk0f    /usr/src        ufs     rw      1       2
1380 /dev/\*(Dk1f    /var    ufs     rw      1       2
1381 /dev/\*(Dk0e    /var/users      ufs     rw      1       2
1382 .TE
1383 .PP
1384 To make the
1385 .Pn /var
1386 filesystem we would do:
1387 .DS
1388 \fB#\fP \fIdisklabel -wr \*(Dk1 "disk type" "disk name"\fP
1389 \fB#\fP \fInewfs \*(Dk1f\fP
1390 (information about filesystem prints out)
1391 \fB#\fP \fImkdir /var\fP
1392 \fB#\fP \fImount /dev/\*(Dk1f /var\fP
1393 .DE
1394 .Sh 2 "Installing the rest of the system"
1395 .PP
1396 At this point you should have your disks partitioned.
1397 The next step is to extract the rest of the data from the tape.
1398 At a minimum you need to set up the
1399 .Pn /var
1400 and
1401 .Pn /usr
1402 filesystems.
1403 You may also want to extract some or all the program sources.
1404 Since not all architectures support tape drives or don't support the
1405 correct ones, you may need to extract the files indirectly using
1406 .Xr rsh (1).
1407 For example, for a directly connected tape drive you might do:
1408 .DS
1409 \fB#\fP \fImt -f /dev/nr\*(Mt0 fsf\fP
1410 \fB#\fP \fItar xbpf \*(Bz /dev/nr\*(Mt0\fP
1411 .DE
1412 The equivalent indirect procedure (where the tape drive is on machine ``foo'')
1413 is:
1414 .DS
1415 \fB#\fP \fIrsh foo mt -f /dev/nr\*(Mt0 fsf\fP
1416 \fB#\fP \fIrsh foo dd if=/dev/nr\*(Mt0 bs=\*(Bzb | tar xbpf \*(Bz -\fP
1417 .DE
1418 Obviously, the target machine must be connected to the local network
1419 for this to work.
1420 To do this:
1421 .DS
1422 \fB#\fP \fIecho  127.0.0.1  localhost >> /etc/hosts\fP
1423 \fB#\fP \fIecho  \fPyour.host.inet.number  myname.my.domain  myname\fI >> /etc/hosts\fP
1424 \fB#\fP \fIecho  \fPfriend.host.inet.number  myfriend.my.domain  myfriend\fI >> /etc/hosts\fP
1425 \fB#\fP \fIifconfig  le0  inet  \fPmyname
1426 .DE
1427 where the ``host.inet.number'' fields are the IP addresses for your host and
1428 the host with the tape drive
1429 and the ``my.domain'' fields are the names of your machine and the tape-hosting
1430 machine.
1431 See sections 4.4 and 5 for more information on setting up the network.
1432 .PP
1433 Assuming a directly connected tape drive, here is how to extract and
1434 install
1435 .Pn /var
1436 and
1437 .Pn /usr :
1438 .br
1439 .ne 5
1440 .TS
1441 lw(2i) l.
1442 \fB#\fP \fImount \-uw /dev/\*(Dk#a /\fP (read-write mount root filesystem)
1443 \fB#\fP \fIdate yymmddhhmm\fP   (set date, see \fIdate\fP\|(1))
1444 \&....
1445 \fB#\fP \fIpasswd -l root\fP    (set password for super-user)
1446 \fBNew password:\fP     (password will not echo)
1447 \fBRetype new password:\fP
1448 \fB#\fP \fIpasswd -l toor\fP    (set password for super-user)
1449 \fBNew password:\fP     (password will not echo)
1450 \fBRetype new password:\fP
1451 \fB#\fP \fIhostname mysitename\fP       (set your hostname)
1452 \fB#\fP \fInewfs r\*(Dk#p\fP    (create empty user filesystem)
1453 (\fI\*(Dk\fP is the disk type, \fI#\fP is the unit number,
1454 \fIp\fP is the partition; this takes a few minutes)
1455 \fB#\fP \fImount /dev/\*(Dk#p /var\fP   (mount the var filesystem)
1456 \fB#\fP \fIcd /var\fP   (make /var the current directory)
1457 \fB#\fP \fImt -f /dev/nr\*(Mt0 fsf\fP   (space to end of previous tape file)
1458 \fB#\fP \fItar xbpf \*(Bz /dev/nr\*(Mt0\fP      (extract all of var)
1459 (this takes a few minutes)
1460 \fB#\fP \fInewfs r\*(Dk#p\fP    (create empty user filesystem)
1461 (as before \fI\*(Dk\fP is the disk type, \fI#\fP is the unit number,
1462 \fIp\fP is the partition)
1463 \fB#\fP \fImount /dev/\*(Dk#p /mnt\fP   (mount the new /usr in temporary location)
1464 \fB#\fP \fIcd /mnt\fP   (make /mnt the current directory)
1465 \fB#\fP \fImt -f /dev/nr\*(Mt0 fsf\fP   (space to end of previous tape file)
1466 \fB#\fP \fItar xbpf \*(Bz /dev/nr\*(Mt0\fP      (extract all of usr except usr/src)
1467 (this takes about 15-20 minutes)
1468 \fB#\fP \fIcd /\fP      (make / the current directory)
1469 \fB#\fP \fIumount /mnt\fP       (unmount from temporary mount point)
1470 \fB#\fP \fIrm -r /usr/*\fP      (remove excess bootstrap binaries)
1471 \fB#\fP \fImount /dev/\*(Dk#p /usr\fP   (remount /usr)
1472 .TE
1473 If no disk label has been installed on the disk, the
1474 .Xr newfs
1475 command will require a third argument to specify the disk type,
1476 using one of the names in
1477 .Pn /etc/disktab .
1478 If the tape had been rewound or positioned incorrectly before the
1479 .Xr tar ,
1480 to extract
1481 .Pn /var
1482 it may be repositioned by the following commands.
1483 .DS
1484 \fB#\fP \fImt -f /dev/nr\*(Mt0 rew\fP
1485 \fB#\fP \fImt -f /dev/nr\*(Mt0 fsf 1\fP
1486 .DE
1487 The data on the second and third tape files has now been extracted.
1488 If you are using 6250bpi tapes, the first reel of the
1489 distribution is no longer needed; you should now mount the second
1490 reel instead.  The installation procedure continues from this
1491 point on the 8mm tape.
1492 The next step is to extract the sources.
1493 As previously noted,
1494 .Pn /usr/src
1495 .\" XXX Check
1496 requires about 250-340Mb of space.
1497 Ideally sources should be in a separate filesystem;
1498 if you plan to put them into your
1499 .Pn /usr
1500 filesystem, it will need at least 500Mb of space.
1501 Assuming that you will be using a separate filesystem on \*(Dk0f for
1502 .Pn /usr/src ,
1503 you will start by creating and mounting it:
1504 .DS
1505 \fB#\fP \fInewfs \*(Dk0f\fP
1506 (information about filesystem prints out)
1507 \fB#\fP \fImkdir /usr/src\fP
1508 \fB#\fP \fImount /dev/\*(Dk0f /usr/src\fP
1509 .DE
1510 .LP
1511 First you will extract the kernel source:
1512 .DS
1513 .TS
1514 lw(2i) l.
1515 \fB#\fP \fIcd /usr/src\fP
1516 \fB#\fP \fImt -f /dev/nr\*(Mt0 fsf\fP   (space to end of previous tape file)
1517 (this should only be done on Exabyte distributions)
1518 \fB#\fP \fItar xpbf \*(Bz /dev/nr\*(Mt0\fP      (extract the kernel sources)
1519 (this takes about 15-30 minutes)
1520 .TE
1521 .DE
1522 .LP
1523 The next tar file contains the sources for the utilities.
1524 It is extracted as follows:
1525 .DS
1526 .TS
1527 lw(2i) l.
1528 \fB#\fP \fIcd /usr/src\fP
1529 \fB#\fP \fImt -f /dev/nr\*(Mt0 fsf\fP   (space to end of previous tape file)
1530 \fB#\fP \fItar xpbf \*(Bz /dev/rmt12\fP         (extract the utility source)
1531 (this takes about 30-60 minutes)
1532 .TE
1533 .DE
1534 .PP
1535 If you are using 6250bpi tapes, the second reel of the
1536 distribution is no longer needed; you should now mount the third
1537 reel instead.  The installation procedure continues from this
1538 point on the 8mm tape.
1539 .PP
1540 The next tar file contains the sources for the contributed software.
1541 It is extracted as follows:
1542 .DS
1543 .TS
1544 lw(2i) l.
1545 \fB#\fP \fIcd /usr/src\fP
1546 \fB#\fP \fImt -f /dev/nr\*(Mt0 fsf\fP   (space to end of previous tape file)
1547 (this should only be done on Exabyte distributions)
1548 \fB#\fP \fItar xpbf \*(Bz /dev/rmt12\fP         (extract the contributed software source)
1549 (this takes about 30-60 minutes)
1550 .TE
1551 .DE
1552 .PP
1553 If you received a distribution on 8mm Exabyte tape,
1554 there is one additional tape file on the distribution tape
1555 that has not been installed to this point; it contains the
1556 sources for X11R5 in
1557 .Xr tar (1)
1558 format.  As distributed, X11R5 should be placed in
1559 .Pn /usr/src/X11R5 .
1560 .DS
1561 .TS
1562 lw(2i) l.
1563 \fB#\fP \fIcd /usr/src\fP
1564 \fB#\fP \fImt -f /dev/nr\*(Mt0 fsf\fP   (space to end of previous tape file)
1565 \fB#\fP \fItar xpbf \*(Bz /dev/nr\*(Mt0\fP      (extract the X11R5 source)
1566 (this takes about 30-60 minutes)
1567 .TE
1568 .DE
1569 Many of the X11 utilities search using the path
1570 .Pn /usr/X11 ,
1571 so be sure that you have a symbolic link that points at
1572 the location of your X11 binaries (here, X11R5).
1573 .PP
1574 Having now completed the extraction of the sources, 
1575 you may want to verify that your
1576 .Pn /usr/src
1577 filesystem is consistent.
1578 To do so, you must unmount it, and run
1579 .Xr fsck (8);
1580 assuming that you used \*(Dk0f you would proceed as follows:
1581 .DS
1582 .TS
1583 lw(2i) l.
1584 \fB#\fP \fIcd /\fP      (change directory, back to the root)
1585 \fB#\fP \fIumount /usr/src\fP   (unmount /usr/src)
1586 \fB#\fP \fIfsck /dev/r\*(Dk0f\fP
1587 .TE
1588 .DE
1589 The output from
1590 .Xr fsck
1591 should look something like:
1592 .DS
1593 .B
1594 ** /dev/r\*(Dk0f
1595 ** Last Mounted on /usr/src
1596 ** Phase 1 - Check Blocks and Sizes
1597 ** Phase 2 - Check Pathnames
1598 ** Phase 3 - Check Connectivity
1599 ** Phase 4 - Check Reference Counts
1600 ** Phase 5 - Check Cyl groups
1601 23000 files, 261000 used, 39000 free (2200 frags, 4600 blocks)
1602 .R
1603 .DE
1604 .PP
1605 If there are inconsistencies in the filesystem, you may be prompted
1606 to apply corrective action; see the
1607 .Xr fsck (8)
1608 or \fIFsck \(en The UNIX File System Check Program\fP (SMM:3) for more details.
1609 .PP
1610 To use the
1611 .Pn /usr/src
1612 filesystem, you should now remount it with:
1613 .DS
1614 \fB#\fP \fImount /dev/\*(Dk0f /usr/src\fP
1615 .DE
1616 or if you have made an entry for it in
1617 .Pn /etc/fstab
1618 you can remount it with:
1619 .DS
1620 \fB#\fP \fImount /usr/src\fP
1621 .DE
1622 .Sh 2 "Additional conversion information"
1623 .PP
1624 After setting up the new \*(4B filesystems, you may restore the user
1625 files that were saved on tape before beginning the conversion.
1626 Note that the \*(4B
1627 .Xr restore
1628 program does its work on a mounted filesystem using normal system operations.
1629 This means that filesystem dumps may be restored even
1630 if the characteristics of the filesystem changed.
1631 To restore a dump tape for, say, the
1632 .Pn /a
1633 filesystem something like the following would be used:
1634 .DS
1635 \fB#\fP \fImkdir /a\fP
1636 \fB#\fP \fInewfs \*(Dk#p\fI
1637 \fB#\fP \fImount /dev/\*(Dk#p /a\fP
1638 \fB#\fP \fIcd /a\fP
1639 \fB#\fP \fIrestore x\fP
1640 .DE
1641 .PP
1642 If
1643 .Xr tar
1644 images were written instead of doing a dump, you should
1645 be sure to use its `\-p' option when reading the files back.  No matter
1646 how you restore a filesystem, be sure to unmount it and check its
1647 integrity with
1648 .Xr fsck (8)
1649 when the job is complete.