Initial revision
[people/dverkamp/gpxe.git] / contrib / mkQNXnbi / README
1 mkQNXnbi is a quick hack to generate tagged images from QNX boot images.
2
3 To boot a QNX client with Etherboot you have to consider the following:
4 1. You MUST have another QNX box running in the network to provide the
5    root filesystem and the license info to the client. QNX cannot use
6    e.g. NFS for its root filesystem, as it needs to load a valid license
7    from a file on the root fs before being able to start TCP/IP. This
8    would lead to a chicken-and-egg problem.
9 2. The Net task normally determines the size of its internal tables from
10    the actual number of licensed nodes. Since this information is not
11    available at boot time when booting from the network, you will have
12    to set the max. number of nodes as well as a valid netmap entry for
13    the node providing the root filesystem as an option to Net in the
14    build file.
15    See examples/ws.etherboot and fill in the <blanks>.
16 3. The client does not need a TCP/IP license in order to boot.
17 4. You can use the boot-server OS of your choice. If you choose to use
18    QNX as boot server, the server of course needs a TCP/IP run-time
19    license.  In this case you have the option of creating the boot image
20    on-the-fly and use the macro $(netmap) instead of a hard-coded MAC
21    address.
22    See examples/ws.etherboot.on-the-fly and fill in the <blanks>.
23    A template bootptab for the QNX bootp server is placed in the
24    examples directory.
25 5. mkQNXnbi expects the QNX image to be supplied on stdin and generates
26    the tagged image to stdout. This can be overridden on the command line
27    using the options -i <input-file> and -o <output-file>.
28
29 mkQNXnbi can be compiled using e.g. Linux/gcc or on QNX using Watcom C
30 (or gcc, if you have it - see http://w3c.teaser.fr/~jcmichot/)
31
32 Bug-reports to <al@alarsen.net>
33
34 2002-01-25
35 Anders Larsen
36 <al@alarsen.net>