Sync usage with man page.
[netbsd-mini2440.git] / distrib / notes / common / xfer
blobbaed157cc04c82f5e78be6d8113f3e458f70c6b7
1 .\"     $NetBSD: xfer,v 1.65 2009/04/25 10:34:43 snj Exp $
2 .\"
3 .\" Copyright (c) 1999-2004 The NetBSD Foundation, Inc.
4 .\" All rights reserved.
5 .\"
6 .\" Redistribution and use in source and binary forms, with or without
7 .\" modification, are permitted provided that the following conditions
8 .\" are met:
9 .\" 1. Redistributions of source code must retain the above copyright
10 .\"    notice, this list of conditions and the following disclaimer.
11 .\" 2. Redistributions in binary form must reproduce the above copyright
12 .\"    notice, this list of conditions and the following disclaimer in the
13 .\"    documentation and/or other materials provided with the distribution.
14 .\"
15 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
16 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
17 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
18 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
19 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
20 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
21 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
22 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
23 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
24 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
25 .\" POSSIBILITY OF SUCH DAMAGE.
26 .\"
28 .\" ---------- MD instructions on setting up boot media
30 .if \n[acorn26] \{\
31 To boot
32 .Nx ,
33 you will need the bootloader
34 .Pq Ic boot26
35 and the kernel you wish to boot on a RISC OS file system somewhere.
36 .Ic boot26
37 can boot gzipped kernels, so there's no need to gunzip it.
38 .Pp
39 .\} \" \n[acorn26]
41 .if \n[arc] \{\
42 You will need to create a CD with an install kernel on it or have
43 a FAT partition and working other OS (Windows NT) which can write
44 install files into it.
45 .Pp
46 .\} \" \n[arc]
48 .if \n[cats] \{\
49 You will need to create a CD with an install kernel on it or have another
50 machine available to allow net booting.
51 .Pp
52 .\} \" \n[cats]
54 .if \n[hp700] \{\
55 To boot
56 .Nx ,
57 you will need a server running the appropriate netboot protocol with a
58 Logical Interchange Format (LIF) volume of the kernel you wish to boot, or
59 the
60 .Pa netinstall.lif
61 volume available in the
62 .Pa hp700/installation
63 directory of the
64 .Nx
65 distribution.
66 .Pp
67 Booting from CD is not currently available.
68 .Pp
69 .\} \" \n[hp700]
71 .if \n[i386] \{\
72 If you are not booting off a CD-ROM, you will need to have some floppy
73 disks to boot off;
74 either three 1.44 MB floppies or one 1.2 MB floppy.
75 .Pp
76 Use
77 .Pa boot1.fs
78 and
79 .Pa boot2.fs
80 for VGA installation.
81 .Pa boot-com1.fs
82 and 
83 .Pa boot-com2.fs
84 are available if you wish to use a serial console.
85 .Pp
86 If you are using a
87 .Ul
88 system to write the floppy images to
89 disks, you should use the
90 .Xr dd
91 command to copy the file system image(s)
92 (.fs file) directly to the raw floppy disk.
93 It is suggested that you read the
94 .Xr dd 1
95 manual page or ask your system administrator to determine the correct
96 set of arguments to use; it will be slightly different from system to
97 system, and a comprehensive list of the possibilities is beyond the
98 scope of this document.
99 .Pp
100 If you are using
101 .Tn MS-DOS
102 to write the floppy image(s) to floppy disk, you should use the
103 .Ic rawrite
104 utility, provided in the
105 .Pa i386/installation/misc
106 directory of the
108 distribution.
109 It will write a file system image (.fs file) to a floppy disk.
111 .Ic rawrite32
112 is also available that runs under
113 .Tn MS Windows .
115 .\} \" \n[i386]
117 .if \n[hp300]:\n[macppc] \{\
118 You should wait to decide where to put the
120 distribution sets until you have figured out how you are going to boot
121 your system.
122 Refer back to this section after you have done so.
125 .if \n[macppc] \{\
126 .(Note
127 Some
128 .Tn Mac OS
129 .Ic ftp
130 clients default to downloading files in
131 .Sq ASCII
132 mode.
133 This will render the
135 files useless.
136 Make sure to set your ftp program to download in
137 .Sq binary
138 mode.
139 .Note)
141 .\} \" \n[macppc]
143 .if \n[ews4800mips]:\n[news68k]:\n[newsmips] \{\
144 .(Note
145 .Nx*M
147 .if \n[ews4800mips] \{\
148 does not support framebuffers other than onboard ones on
149 EWS4800/350, EWS4800/360AD and EWS4800/360ADII so
150 you have to use serial console on installation procedure
151 if your machine doesn't have supported framebuffers listed above.
152 .\} \" \n[ews4800mips]
153 .if \n[news68k] \{\
154 does not support any framebuffers (yet) so
155 you have to use serial console on installation procedure.
156 .\} \" \n[news68k]
157 .if \n[newsmips] \{\
158 does not support any framebuffers other than NWB-253 on NWS-3470D and
159 XA on NWS-5000 (yet) so
160 you have to use serial console on installation procedure
161 if your machine doesn't have supported framebuffers listed above.
162 .\} \" \n[newsmips]
163 .Note)
165 You will need to have
166 .if \n[ews4800mips] two 1.44 MB floppy disks
167 .if \n[news68k] a 1.44 MB floppy disk
168 .if \n[newsmips] two 1.44 MB floppy disks
169 to boot off.
170 You must put the boot floppy image onto this disk, which contains
171 software to install
173 system.
175 If you are using a
177 system (such as
178 .if \n[ews4800mips] \{\
179 .Tn EWS-UX
180 .\} \" \n[ews4800mips]
181 .if \n[news68k]:\n[newsmips] \{\
182 .Tn NEWS-OS
183 .\} \" \n[news68k]:\n[newsmips]
184 or other
186 machines) to write the floppy images to disks, you should use the
187 .Xr dd 1
188 command to copy the file system image(s)
189 (.fs file(s)) directly to the raw floppy disk.
190 It is suggested that you read the
191 .Xr dd 1
192 manual page or ask your system administrator to determine the correct
193 set of arguments to use; it will be slightly different from system to
194 system, and a comprehensive list of the possibilities is beyond the
195 scope of this document.
197 If you have an i386 machine which runs
198 .Tn MS-DOS
199 and use it to write the floppy image(s) to floppy disk,
200 you can use the
201 .Ic rawrite
202 utility, provided in the
203 .Pa i386/installation/misc
204 directory of the
206 distribution.
207 It will write a file system image (.fs file) to a floppy disk.
209 .Ic rawrite32
210 is also available that runs under
211 .Tn MS Windows .
213 Though
214 .Nx*M
215 uses the floppy disk to boot for the initial
216 installation, the
217 .Nx*M
218 kernel does not support the
219 floppy device.
220 Some other machines or systems are still required to write floppy images
221 even after
222 .Nx*M
223 has been installed.
225 If your machine doesn't have any SCSI disks, or the SCSI interface
226 on your machine is not supported, it can still run
227 .Nx*M
228 diskless.
229 No file transfer is needed, and all you have to do is to prepare files on
230 the server.
231 More information about diskless setups can be found at
232 .Lk http://www.NetBSD.org/docs/network/netboot/
234 .if \n[ews4800mips] \{\
235 The PROM uses the ordinary tftp protocol, so
236 you can load bootloader via network.
237 The PROM also supports tape boot but
238 .Nx*M
239 does not support it currently.
241 After the boot floppy or diskless server is prepared, just set
242 boot device on the PROM menu which can be invoked by pressing ESC key
243 right after hardware checks.
244 .\} \" \n[ews4800mips]
245 .if \n[news68k] \{\
247 .Tn NEWS
248 PROM also supports tape boot and network boot, but
249 .Nx*M
250 does not support them currently.
252 After the boot floppy is prepared, just type
253 .Ic "bo fh"
254 on the PROM prompt to boot it.
256 .\} \" \n[news68k]
257 .if \n[newsmips] \{\
258 On NWS-3xxx machines, the PROM also supports network boot but it uses
259 an unusual protocol which is not supported by
260 .Nx*M .
261 On NWS-5000 machines, the PROM uses the ordinary tftp protocol, so
262 you can load bootloader via network by
263 .Ic "bo tftp()"
264 command on the PROM prompt.
267 .Tn NEWS
268 PROM also supports tape boot, but
269 .Nx*M
270 does not support that currently.
272 After the boot floppy is prepared, just type
273 .Ic "bo fd"
274 (NWS-5000) or
275 .Ic "bo fh"
276 (NWS-3xxx) on the PROM prompt to boot it.
277 .\} \" \n[newsmips]
279 .\} \" \n[ews4800mips]:\n[news68k]:\n[newsmips]
281 .if \n[pmax] \{\
282 First-time installation on a bare machine is not supported, because most
283 DECstations do not have any suitable load device.
284 Some versions of the DECstation PROM are buggy and will not boot via
285 .Tn TFTP
286 and bootp; other versions are buggy and do not boot via
287 .Tn MOP .
289 The only DECstation with a floppy-disk drive is the Personal DECstation,
290 and that device is not supported as a boot device.
292 The recommended installation procedure is to boot an install kernel
294 .Tn TFTP ,
295 or to use a
296 .Dq helper
297 system to write a miniroot diskimage onto a disk, move that
298 disk to the target installation system, and then boot the miniroot.
300 .\} \" \n[pmax]
302 .if \n[vax] \{\
303 Installing on a
304 .Sq bare
305 machine requires some bootable
306 device; either a tape, CD-ROM or floppy drive or a NFS server together
307 with a machine that can act as a MOP loader, such as another
308 machine running
309 .Nx .
310 .Nx*M
311 can use both BOOTP/DHCP and
312 BOOTPARAMS for netboot installations.
314 .\} \" \n[vax]
316 .if \n[x68k] \{\
317 You will have to prepare the `ramdisk-root' installation system.
318 There are two ways to invoke the
320 installation system;
322 .(bullet -compact -offset indent
323 Use the
324 .Pa loadbsd.x
325 utility to boot
327 from
328 .Tn Human68k
330 Make a boot floppy which contains the installation system
331 .bullet)
333 If you choose the first method,
334 you have to put the compressed installation kernel
335 .Pa netbsd-INSTALL.gz ,
337 .Pa loadbsd.x
338 utility and the
339 .Pa gzip.x
340 utility to a disk accessible from Human68k.
341 These files can be found in the
342 .Pa x68k/binary/kernel
343 directory or
344 .Pa x68k/installation/misc
345 directory of the
347 distribution.
349 .Pa netbsd-INSTALL
350 file needs to be uncompressed from
351 .Pa netbsd-INSTALL.gz
352 using the provided
353 .Ic gzip.x
354 program with the
355 .Fl d
356 switch. 
358 To invoke the installation system, just type
360 .Dl Ic "gzip.x -d netbsd-INSTALL.gz"
361 .Dl Ic "loadbsd.x netbsd-INSTALL"
363 from the
364 .Tn Human68k
365 command line.
367 If you choose the second method, you have to make the boot floppy
368 from the floppy image
369 .Pa sysinst.fs .
370 The image file can be found in
371 .Pa x68k/installation/floppy
372 directory of the
374 distribution.
376 If you are using a
378 system to write the floppy image to
379 disks, you should use the
380 .Pa dd
381 command to copy the file system images (.fs files) directly to the raw
382 floppy disks.
383 It is suggested that you read the
384 .Xr dd 1
385 manual page or
386 ask your system administrator to determine the correct set of
387 arguments to use; it will be slightly different from system to system,
388 and a comprehensive list of the possibilities is beyond the scope of
389 this document.
391 If you are using
392 .Tn Human68k
393 to write the floppy images to disks, you should use the
394 .Ic rawrite
395 utility, provided in the
396 .Pa x68k/installation/misc
397 directory of the
399 distribution.
400 PC versions can be found in
401 .Pa i386/installation/misc .
402 It will write the file system images (.fs files) to disks.
404 To use the boot floppy, insert the floppy to your floppy drive 0,
405 and reboot your computer with OPT.1 key pressed.
407 If you have less than 5MB of memory, you have to use the
408 `floppy-root' installation system instead of the above
409 `ramdisk-root' installation system.
410 `Floppy-root' installation
411 system is composed of two floppies, `kern' and `inst'.
412 They are made from the floppy images
413 .Pa kern.fs
415 .Pa inst.fs
416 respectively, both of which are found in
417 .Pa installation/floppy
418 directory of the
420 distribution.
422 .Pa inst.fs
423 file needs to be uncompressed from
424 .Pa inst.fs.gz
425 using the provided
426 .Ic gzip.x
427 program with the
428 .Fl d
429 switch. 
430 See above how to write the images to floppies.
432 To start the `floppy-root' installation system, insert the `kern' floppy
433 to your floppy drive 0, and reboot your computer with OPT.1 key pressed.
434 When you are prompted that `Insert file system floppy and press return.',
435 replace the `kern' floppy with `inst' floppy and press return key.
437 Once booted, the `floppy-root' installation system is identical with
438 the `ramdisk-root' installation system, except that the former constantly
439 accesses the floppy disk.
440 Floppy disks are relatively unreliable media and cause some warning messages
441 to report access errors, most of which are corrected and can be ignored.
442 With the latter installation system the floppy disk is not used once the
443 system has booted off and can be removed from the drive.
445 .(Note
446 The `floppy-root' installation system cannot be used to install
447 .Nx*M
448 on a machine with less than 5MB of memory.
449 .Note)
451 .\} \" \n[x68k]
453 .if !\n[hp700]:\n[x68k] \{\
454 Note that if you are installing or upgrading from writable media,
455 it can be write-protected if you wish.
456 These systems mount a root image from inside the kernel, and will not
457 need to write to the media.
458 If you booted from a floppy, the floppy disk may be removed from
459 the drive after the system has booted.
461 .\} \" \n[x68k]
463 .\" --------- MI instructions for getting distribution off installation medium
465 Installation is supported from several media types, including:
467 .(bullet -offset indent -compact
469 .if \n[amiga] \{\
470 .Tn AmigaDOS
472 .\} \" \n[amiga]
474 CD-ROM / DVD
477 .Tn MS-DOS No floppy
482 .if \n[x68k] \{\
484 Magneto-Optical (M-O) or other removable SCSI disk
485 .\} \" \n[x68k]
488 Remote NFS partition
491 Tape
494 Existing
496 .if \n[macppc] \{\
498 .Tn MacOS X
500 .\} \" \n[macppc]
501 partitions, if performing an upgrade
503 .bullet)
506 The steps necessary to prepare the distribution sets for installation
507 depend upon which installation medium you choose.
508 The steps for the various media are outlined below.
509 .if \n[sparc64] \{\
510 .(Note
511 If you are installing the 32-bit sparc distribution sets, you will need to 
512 rename
513 .Pa sparc/binary/sets/kern-GENERIC_SUN4U.tgz
515 .Pa kern-GENERIC.tgz
516 since the \*M installation tools would otherwise attempt to install the 
517 kernel for 32-bit sparc computers which does not boot on \*M systems.
518 .Note)
521 .(tag MS-DOS\ floppy
523 .if \n[amiga] \{\
524 .It Em AmigaDOS partition
525 To install
527 from an
528 .Tn AmigaDOS
529 partition, you need to get the
531 distribution sets you wish to install on your system on to an
532 .Tn AmigaDOS
533 partition.
535 Note where you place the files as you will need this later.
537 Once you have done this, you can proceed to the next
538 step in the installation process, preparing your hard disk.
539 .\} \" \n[amiga]
541 .It Em CD-ROM / DVD
542 .if \n[amiga] \{\
543 To install
545 from a CD-ROM drive, make sure it is a SCSI CD-ROM on a SCSI bus currently
546 supported by
548 (refer to the supported hardware list) or an ATAPI CD-ROM connected to the
549 A1200 or A4000 internal IDE connector.
550 If it is a SCSI CD-ROM on a non-supported SCSI bus like Blizzard-3 SCSI
551 or Apollo SCSI you must first copy the distribution sets to an
552 .Tn AmigaDOS
553 partition as described above.
555 If your SCSI CD-ROM is connected to a supported SCSI host adapter,
556 or it is an ATAPI cd-rom connected to the A1200/A4000 internal IDE
557 connector, simply put the CD into the drive before installation.
559 .\} \" \n[amiga]
560 Find out where the distribution set files are on the CD-ROM or DVD.
561 Likely locations are
562 .Pa binary/sets
564 .Pa \*M/binary/sets .
566 Proceed to the instructions on installation.
568 .It Em MS-DOS floppy
570 does not include split distribution sets for installation by floppy.
571 However, they can be created on a separate machine using the
572 .Xr split 1
573 command, running e.g.
574 .Ic split -b 235k base.tgz base.
575 to split the
576 .Pa base.tgz
577 file from
578 .Pa \*M/binary/sets
579 into files named
580 .Pa base.aa ,
581 .Pa base.ab ,
582 and so on.
583 Repeat this for all
584 .Pa set_name.tgz
585 files, splitting them into
586 .Pa set_name. Ns Ar xx
587 files. 
588 Count the number of
589 .Pa set_name. Ns Ar xx
590 files that make up the
591 distribution sets you want to install or upgrade.
592 .ie \n[i386] \{\
593 You will need one fifth that number of 1.2 MB floppies, or one sixth that
594 number of 1.44 MB floppies.
595 You should only use one size of floppy for the install or upgrade
596 procedure; you can't use some 1.2 MB floppies and some 1.44 MB floppies.
597 .\} \" \n[i386]
598 .el \{\
599 You will need one sixth that number of 1.44 MB floppies.
600 .\} \" ! \n[i386]
602 Format all of the floppies with
603 .Tn MS-DOS .
605 .Em not
606 make any of them bootable
607 .Tn MS-DOS
608 floppies, i.e. don't use
609 .Li format /s
610 to format them.
611 (If the floppies are bootable, then the
612 .Tn MS-DOS
613 system files that make them bootable will take up some space, and you
614 won't be able to fit the distribution set parts on the disks.)
615 If you're using floppies that are formatted for
616 .Tn MS-DOS
617 by their manufacturers, they probably aren't bootable, and you can use
618 them out of the box.
620 Place all of the
621 .Pa "set_name." Ns Ar xx
622 files on the
623 .Tn MS-DOS
624 disks.
626 Once you have the files on
627 .Tn MS-DOS
628 disks, you can proceed to the next step in the installation or upgrade process.
629 If you're installing
631 from scratch, go to the section on preparing your hard disk, below.
632 If you're upgrading an existing installation, go directly to the
633 section on upgrading.
635 .It Em FTP
636 The preparations for this installation/upgrade method are
637 easy; all you need to do is make sure that there's an FTP
638 site from which you can retrieve the
640 distribution when you're about to
641 install or upgrade.
642 If you don't have DHCP available on your network,
643 you will need to know the numeric IP address of that site, and,
644 if it's not on a network directly connected to the machine
645 on which you're installing or upgrading
646 .Nx ,
647 you need to know the numeric IP address of the router closest
648 to the
650 machine.
651 Finally, you need to know the numeric IP address of the
653 machine itself.
654 If you don't have access to a functioning nameserver during
655 installation, the IPv4 address of
656 .Sy ftp.NetBSD.org
658 .Li 204.152.190.13
659 and the IPv6 address is
660 .Li 2001:4f8:3:7:230:48ff:fe31:43f2
661 (as of April, 2009).
663 Once you have this information, you can proceed to the next
664 step in the installation or upgrade process.
665 If you're installing
667 from scratch, go to the section on preparing your hard disk, below.
668 If you're upgrading an existing installation, go directly to
669 the section on upgrading.
671 .if \n[x68k] \{\
672 .It Em M-O disk
673 To install
675 from a device such as a removable SCSI disk or a magneto-optical disk,
676 the media
677 .Em must
678 be of the
679 .Tn IBM
680 .Em Super-floppy
681 format.
683 .Tn Human68k
684 format is not recognized by this release of the
685 .Nx*M .
686 If you have a
687 .Tn MS-DOS
689 .Tn MS Windows
690 machine with an M-O drive connected, use it.
691 If you don't, and if you have a program to handle
692 .Tn IBM
693 format M-O for
694 .Tn Human68k ,
695 copy all the files in the subdirectory
696 .Pa x68k/binaries
698 .Em "change their names to upper case".
699 .\} \" \n[x68k]
701 .It Em NFS
702 Place the
704 distribution sets you wish to install into a
705 directory on an NFS server, and make that directory mountable
706 by the machine on which you are installing or upgrading
707 .Nx .
708 This will probably require modifying the
709 .Pa /etc/exports
710 file on the NFS server and resetting its mount daemon (mountd).
711 (Both of these actions will probably require superuser
712 privileges on the server.)
714 You need to know the numeric IP address of the NFS server,
715 and, if you don't have DHCP available on your network and
716 the server is not on a network directly connected to
717 the machine on which you're installing or upgrading
718 .Nx ,
719 you need to know the numeric IP address of the router closest
720 to the
722 machine.
723 Finally, you need to know the numeric IP address of the
725 machine itself.
727 Once the NFS server is set up properly and you have the
728 information mentioned above, you can proceed to the next step
729 in the installation or upgrade process.
730 If you're installing
732 from scratch, go to the section on preparing your hard disk, below.
733 If you're upgrading an existing installation, go directly to the
734 section on upgrading.
736 .It Em Tape
737 To install
739 from a tape, you need to make a tape that
740 contains the distribution set files, in
741 .Sq tar
742 format.
743 .if \n[pmax]:\n[vax] \{\
744 .(Note
745 the tape devices with which
746 .Nx*M
747 is believed to work is the
748 .Tn DEC
749 TK-50.
750 This is a very slow device.
751 Installation via disk or network is recommended if possible.
752 .Note)
753 .\} \" \n[pmax]:\n[vax]
755 If you're making the tape on a
757 system, the easiest way
758 to do so is probably something like:
760 .Dl # Ic "tar -cf" Ar "tape_device dist_directories"
762 where
763 .Ar tape_device
764 is the name of the tape device that
765 describes the tape drive you're using; possibly
766 .Pa /dev/rst0 ,
767 or something similar, but it will vary from system to system.
768 (If you can't figure it out, ask your system administrator.)
769 In the above example,
770 .Ar dist_directories
771 are the
772 distribution sets' directories, for the distribution sets you
773 wish to place on the tape.
774 For instance, to put the
775 .Sy kern-GENERIC, base, No and Sy etc
776 distributions on tape (in
777 order to do the absolute minimum installation to a new disk),
778 you would do the following:
780 .Dl # Ic "cd \&.../NetBSD-\*V"
781 .Dl # Ic "cd \*M/binary"
782 .Dl # Ic "tar -cf" Ar tape_device Ic "kern-GENERIC base etc"
784 .(Note
785 You still need to fill in
786 .Ar tape_device No in the example.
787 .Note)
789 Once you have the files on the tape, you can proceed to the
790 next step in the installation or upgrade process.
791 If you're installing
793 from scratch, go to the section on preparing your hard disk, below.
794 If you're upgrading an existing installation, go directly to the section
795 on upgrading.
797 .tag)