Expand PMF_FN_* macros.
[netbsd-mini2440.git] / distrib / notes / alpha / install
blob0304003e1b64dfe94d3e1cf91ff448417cb1e177
1 .\"     $NetBSD: install,v 1.36 2009/04/25 10:34:42 snj Exp $
2 .\"
3 .\" Copyright (c) 1999-2002 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 .\"
27 .Pp
28 To install or upgrade
29 .Nx ,
30 you need to first boot an installation
31 program and then interact with the menu-based program
32 .Ic sysinst .
33 The installation program actually consists of the
34 .Nx
35 kernel plus an in-memory file system of utility programs.
36 .Pp
37 The traditional procedure is to write the installation system to a floppy
38 disk set and then boot from the floppies.
39 However, there are six ways to boot the
40 .Nx*M
41 installation system.
42 Each approach loads the exact same installation bits.
43 The six paths are:
44 .Pp
46 .(bullet -offset indent
47 Floppy disk boot
48 .It
49 CD boot
50 .It
51 Hard Drive Boot
52 .It
53 Magnetic Tape Boot
54 .It
55 Existing Root FS Boot
56 .It
57 Network boot
58 .bullet)
60 .Pp
61 In all cases, you need to transfer a
62 bootable image of the installation system
63 from the
64 .Nx
65 CD or from an ftp site to the chosen media type.
66 Although booting from floppy is the usual path, the
67 hard drive boot is useful if you have another operating system (and a spare
68 drive) already installed, or if you don't mind swapping hard drives from
69 box to box.
70 CD and tape boots are nice and fast if you have a CD writer
71 or a tape format in common with another previously installed
72 .Ul
73 system.
74 Finally, most versions of SRM can locate the
75 .Nx
76 boot program
77 .Ic netboot
78 via bootp and download it via tftp.
79 .Ic netboot
80 then mounts the root file system
81 .Pq Pa /
82 via NFS and loads the kernel.
83 .Pp
84 Note that if you are installing or upgrading from a writable media,
85 the media can be write-protected if you wish.
86 These systems mount a root image from inside the kernel, and will not
87 need to write to the media.
88 If you booted from a floppy, the floppy disk may be removed from
89 the drive after the system has booted.
90 .Pp
92 .(bullet
93 Floppy disk boot
94 .Pp
95 The 3.5", 1.44 MB boot floppy set is found under the
96 .Nx*M
97 \*V distribution directory in
98 .Pa \*M/installation/floppy/
99 as three files called
100 .Pa disk1of3 ,
101 .Pa disk2of3 ,
103 .Pa disk3of3 .
104 You need to put these disk images on three floppy disks.
106 If you have a
108 system handy, you can do this with commands
109 like the following:
111 .Dl # Ic "dd if=disk1of3 of=/dev/rfd0a bs=18k"
112 .Dl # Ic "dd if=disk2of3 of=/dev/rfd0a bs=18k"
113 .Dl # Ic "dd if=disk3of3 of=/dev/rfd0a bs=18k"
115 If the
117 system you are using is not a
119 system, you will probably need to replace
120 .Li /dev/rfd0a
121 with the name of the floppy device on your particular system.
123 If you have an
124 .Tn MS-DOS
126 .Tn Windows
127 system available, you can use
129 .Ic rawrite.exe
130 utility to transfer the image to a floppy
131 disk.
132 This utility is provided with the
133 .Nx Ns /i386
134 install tools, under
135 .Pa i386/installation/misc ;
136 a documentation file,
137 .Ic rawrite.doc
138 is available there as well.
140 Once the floppy has been made, you simply need to put it in the
141 drive and type
143 .Dl \*[Gt]\*[Gt]\*[Gt] Ic "B DVA0"
146 CD boot
148 Hard Drive boot
150 Magnetic Tape Boot
152 All three of these media types use the same initial image:
153 .Pa \&.../installation/diskimage/cdhdtape
154 The image can be written to a hard drive partition with a command
155 like:
157 .Dl # Ic "dd if=cdhdtape of=/dev/rsd0c bs=16k"
159 To boot from a magnetic tape device such as
160 .Tn DAT
162 .Tn DLT ,
163 it is important
164 to create the tape image with 512-byte records.
165 Use a command like:
167 .Dl # Ic "dd if=cdhdtape of=/dev/rst0 bs=512 conv=osync"
169 If the host system is not
170 .Nx ,
171 the names of the destination devices are likely to be different.
172 Be sure to use a
173 .Dq raw partition
174 device that doesn't skip over labels!
176 The use of CD-R devices varies greatly depending on the host OS
177 and host software; it isn't possible to give typical instructions here.
180 Existing Root FS Boot
182 The installation subdirectory
183 .Pa instkernel/
184 contains
185 .Pa netbsd.gz ;
186 this is the same install kernel but without a bootable file system
187 image wrapped around it.
188 You can perform an complete reinstall by beginning it as an upgrade,
189 and booting this kernel in the normal way off the root file system
190 .Pq Pa /
191 of a previous installation.
193 The gzipped image can be booted directly; it is not necessary to
194 uncompress it first.
197 Network Boot
199 Booting
200 .Nx*M
201 \*V over a network requires a BOOTP or
202 DHCP server, a TFTP server and an NFS server.
203 (These are usually all run on the same machine.)
204 There are three basic stages to the boot:
208 .(bullet
209 \*M console software sends a BOOTP request to get its
210 own address, the address of the TFTP server and the file to
211 download.
212 It downloads this file, which is the second stage bootstrap,
213 via TFTP and then executes it.
215 The secondary boot program resends the BOOTP request, this
216 time also locating the NFS server and root path.
217 It mounts the root path via NFS and reads in and transfers to the kernel:
218 .Pa /netbsd .
220 The kernel probes and configures the devices, and then sends
221 out another BOOTP request so it can find out its address, the NFS
222 server, and path.
223 It then mounts its root
224 .Pq Pa /
225 via NFS and continues.
226 .bullet)
229 You will need to set up servers for BOOTP, TFTP and NFS.
231 If you want to run a full system
232 from the network, untar the
234 distribution into a directory on your server and NFS export that directory
235 to the client.
236 Make sure you put a kernel there as well, and create the device nodes in
237 .Pa /dev
238 with
239 .Ic sh ./MAKEDEV all .
240 Detailed instructions on netbooting can be found by visiting
241 .Lk http://www.NetBSD.org/docs/network/netboot/
243 You'll want to map root to
244 .Li root
245 (rather than the default
246 .Li nobody )
247 when you export your root file system
248 .Pq Pa / .
249 A typical
250 .Pa /etc/exports
251 line on a
253 system would be:
255 .Dl /usr/export/\*M -maproot=0 myclient.mydom.com
257 One option is to load just the install kernel over the network but then
258 proceed to a normal disk-based install and disk-based operation.
259 (Perhaps the \*M doesn't have a floppy drive, or you just don't
260 want to use a
261 .Tn Windows
262 system to make the floppy; we understand.)
264 For this case, you still need to export an NFS root, but
265 the only thing it needs to have in it is the
266 .Li instkernel
267 image from the distribution.
269 The gzipped image can be booted directly; it is not necessary to
270 uncompress it first.
272 The console will be using TFTP to load the
274 boot program,
275 so for the TFTP setup, you need to copy the second stage bootstrap,
276 .Ic netboot ,
277 into an appropriately named file such as
278 .Li boot.netbsd.\*M
279 in the directory used by your TFTP server.
280 If you extracted a full snapshot, you can get the netboot program from
281 .Pa /usr/mdec/netboot ;
282 if not, you can get this from the
283 .Pa installation/netboot
284 directory where you found the \*M distribution.
286 For the BOOTP server you need to specify the:
288 .(bullet -compact -offset indent
289 hardware type (Ethernet)
291 hardware address (Ethernet MAC address)
293 IP address of the client
295 subnet mask of the client
297 address of of the TFTP/NFS server
299 name of the second stage bootstrap loaded via TFTP
301 path to the root for the client (mounted via NFS)
302 .bullet)
305 Here's an example for a
307 system running
308 .Ic bootpd :
309 .(disp
310 myhost.mydom.com:\
311         :ht=ethernet:ha=0000c0391ae4:\e
312         :ip=192.168.1.2:sm=255.255.255.0:\e
313         :sa=192.168.1.1:bf=boot.netbsd.\*M:rp=/usr/export/\*M:
314 .disp)
316 And here's an example for a
318 system running the ISC
319 .Ic dhcpd :
320 .(disp
321 host axp {
322         hardware ethernet 0:0:c0:39:1a:e4;
323         fixed-address 192.168.1.2;
324         option host-name "myhost.mydom.com";
325         filename "boot.netbsd.\*M";
326         option root-path "/usr/export/\*M";
327         option domain-name-servers 192.168.1.1;
328         option broadcast-address 255.255.255.0;
329         option domain-name "my.domain";
331 .disp)
333 The only Ethernet device the console on most \*M systems
334 knows how to boot from is the onboard Ethernet interface or a
335 .Tn DEC
336 Tulip (21040, 21041, 21140) PCI Ethernet card.
337 Some older SMC 100 Mbps cards that use this chip have been known to
338 work as well.
339 Many older systems will not be able to use the newer 2.0 stepping
340 of the 21140, however.
341 If your system appears not to be receiving packets, this may be the problem.
342 (You may or may not be able to update your firmware to fix this; see
343 .Lk http://www.NetBSD.org/ports/alpha/
344 for more information on this.)
345 In general, 10 Mb cards from manufacturers other than
346 .Tn DEC
347 will work, and 100 Mb cards not from
348 .Tn DEC
349 will not.
351 Once you're set up, you should be able to boot with:
353 .Dl \*[Gt]\*[Gt]\*[Gt] Ic "boot -proto bootp ewa0"
355 You should permanently set your protocol to
356 .Tn BOOTP
357 with:
359 .Dl \*[Gt]\*[Gt]\*[Gt] Ic "set ewa0_protocols bootp"
361 The 3000 series of Turbochannel systems and certain other models use
362 .Em old SRM ,
363 do not have a
364 .Fl proto
365 option and use different device names.
366 They also tend to not netboot very well so you probably don't
367 need to worry about this section.
368 However, if you want to give it a try, note the following differences:
369 .(bullet -offset indent
370 There is no
371 .Fl proto
372 argument, or
373 .Ic ewa0_protocols
374 variable.
375 Old SRM uses bootp if the device name is given as
376 .Sy ez0 .
378 The use of the
379 .Xr setnetbootinfo 8
380 program will probably also be necessary, as it is unlikely that an SRM
381 from that era will properly communicate the ethernet HW address to the
382 boot program.
384 Example:
386 .Dl \*[Gt]\*[Gt]\*[Gt] Ic "boot ez0"
387 .bullet)
388 .bullet)
392 .so ../common/sysinst