[tg3] Add support for tg3-5721
[people/mdeck/gpxe.git] / contrib / mkffwnb / README
1 This is a quick and dirty script to convert a floppyfw floppy
2 (http://www.zelow.no/floppyfw/) to a tagged image for booting with
3 Etherboot (http://etherboot.sourceforge.net/). The advantages of network
4 booting include: it's much faster loading from the network than from a
5 floppy disk, you can boot from any size floppy, and you are not limited
6 to the maximum of 1.44 MB of the physical floppy. If you have enough RAM
7 and use a virtual floppy to build the initial boot image, you can put as
8 much on it as will fit the ramdisk.
9
10 See further down under -nonet if you want to boot from HD or CDROM.
11
12 This program requires mtools, tar, bzip2, loopback mount in the kernel,
13 and root privileges to execute. Hope you have them.
14
15 This script works for any of the releases for which a subdirectory of
16 that name is provided, but it should not be too hard to make it work for
17 other releases, all that is done here is to substitute some scripts for
18 the distributed ones.
19
20 First of all you should make the floppy work the way you want before
21 converting it to a tagged image. This involves editing the various
22 config files on the floppy. Instructions on this are distributed from
23 the floppyfw web page mentioned above.
24
25 Edit the $tftpdir assignment for the directory where you put your tagged
26 images.  Edit the $libdir assignment and the use lib directive near the
27 top if you decide to put this package somewhere other than
28 /usr/local/lib/mkffwnb/. Adjust the instructions below as necessary.
29
30 Copy everything to $libdir.
31
32         mkdir -p /usr/local/lib/mkffwnb/
33         cp -a . /usr/local/lib/mkffwnb/
34
35 Make a link from /usr/local/lib/mkffwnb/mkffwnb.pl to
36 /usr/local/bin/mkffwnb so that it's in your path.
37
38         ln -s /usr/local/lib/mkffwnb/mkffwnb.pl /usr/local/bin/mkffwnb
39
40 Then run it as:
41
42         mkffwnb
43
44 You can also provide a floppy drive as an argument, e.g.
45
46         mkffwnb x:
47
48 where x: could be mapped to a disk file. This allows you to build an
49 image without a real floppy drive. Remember that for virtual drives root
50 must have the mapping for the drive in question in ~root/.mtoolsrc.
51
52 You can use the option --localtime=/etc/localtime to specify that the
53 file /etc/localtime is to be copied to /etc/localtime on the initrd.
54 Instead of /etc/localtime, you can use any of the timezone files under
55 /usr/share/zoneinfo/, it's just that /etc/localtime will usually be the
56 correct one for your timezone.
57
58 If you use the option -nonet, it leaves the intermediate files in
59 $tempdir, /tmp/mkffwnb by default. This is useful if you want the
60 vmlinuz and initrd.gz files for use with LILO or isolinux to boot from
61 HD or CDROM. Actually you can also use these with a floppy, it loads
62 faster if you fold all the scripts and modules into the initrd ahead
63 of time.
64
65 mkffwnb has to be run as root because it uses loopback mounts and also
66 because the files inside the initrd are owned by root.
67
68 Ken Yap
69 2003-04-20