annotate docs/nitros9guide/os9gen.refentry @ 2811:611715587834 lwtools-port

Updated rules.mak and level1/coco1/bootfiles/makefile Updated the rules.mak file to remove the format entire image related to drivewire server disk images. Updated level1/coco1/bootfiles/makefile to create 3 new bootfile images. These images are stripped down to just the common files needed for vovdg games on os9 level 1. These bootfiles are for becker, dw, and arduino. Also corrected a duplicated dd descriptor when building some bootfiles that had both floppy_40d, floppy_80d, RBDW, RBBECKER, and RBARDUINO. Removed the dd descriptor from each of these sections and made it where the dd descriptor for the specific section was added in the main bootfile list.
author David Ladd <drencor-xeen@users.sf.net>
date Mon, 11 Feb 2013 20:16:24 -0600
parents 4dae346c4969
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
138
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
1 <refentry id="os9gen">
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
2 <refnamediv>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
3 <refname>OS9GEN</refname>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
4 <refpurpose>Build and Link a Bootstrap File</refpurpose>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
5 </refnamediv>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
6
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
7 <refsynopsisdiv>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
8 <cmdsynopsis>
1093
4dae346c4969 Added crossreferences and lowercased synopsises
roug
parents: 1053
diff changeset
9 <command>os9gen</command>
138
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
10 <arg choice="plain">
975
c565a4700689 The entitity replstart was replaced with <replaceable>
roug
parents: 138
diff changeset
11 <replaceable>device name</replaceable>
138
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
12 </arg>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
13 </cmdsynopsis>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
14 </refsynopsisdiv>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
15
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
16 <refsect1><title>Description</title>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
17 <para>
1053
b5ff125a1d60 Since this book was only typeset in fixed width, single-font, they used
roug
parents: 975
diff changeset
18 <command>OS9Gen</command> is used to create and link the <filename>OS9Boot</filename> file required on any
b5ff125a1d60 Since this book was only typeset in fixed width, single-font, they used
roug
parents: 975
diff changeset
19 disk from which OS-9 is to be bootstrapped. <command>OS9Gen</command> is used to add
138
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
20 modules to an existing boot or to create an entirely new boot file.
1053
b5ff125a1d60 Since this book was only typeset in fixed width, single-font, they used
roug
parents: 975
diff changeset
21 If an exact copy of the existing <filename>OS9Boot</filename> file is desired, the
b5ff125a1d60 Since this book was only typeset in fixed width, single-font, they used
roug
parents: 975
diff changeset
22 <command>cobbler</command> command should be used instead.
138
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
23 </para>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
24 <para>
1053
b5ff125a1d60 Since this book was only typeset in fixed width, single-font, they used
roug
parents: 975
diff changeset
25 The name of the device on which the <filename>OS9Boot</filename> file is to be
b5ff125a1d60 Since this book was only typeset in fixed width, single-font, they used
roug
parents: 975
diff changeset
26 installed is passed to <command>OS9Gen</command> as a command line parameter. <command>OS9Gen</command> then
b5ff125a1d60 Since this book was only typeset in fixed width, single-font, they used
roug
parents: 975
diff changeset
27 creates a working file called <filename>TempBoot</filename> on the device specified.
138
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
28 Next it reads file names (pathlists) from its standard input, one
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
29 pathlist per line. Every file named is opened and copied to
1053
b5ff125a1d60 Since this book was only typeset in fixed width, single-font, they used
roug
parents: 975
diff changeset
30 <filename>TempBoot</filename>. This is repeated until end-of-file or a blank line is
b5ff125a1d60 Since this book was only typeset in fixed width, single-font, they used
roug
parents: 975
diff changeset
31 reached on <command>OS9Gen</command>'s standard input. All boot files must contain the
1093
4dae346c4969 Added crossreferences and lowercased synopsises
roug
parents: 1053
diff changeset
32 OS-9 component modules listed in section <xref linkend="sec6.1"/>.
138
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
33 </para>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
34 <para>
1053
b5ff125a1d60 Since this book was only typeset in fixed width, single-font, they used
roug
parents: 975
diff changeset
35 After all input files have been copied to <filename>TempBoot</filename>, the old
b5ff125a1d60 Since this book was only typeset in fixed width, single-font, they used
roug
parents: 975
diff changeset
36 <filename>OS9Boot</filename> file, if present, is deleted. <filename>TempBoot</filename> is then renamed
b5ff125a1d60 Since this book was only typeset in fixed width, single-font, they used
roug
parents: 975
diff changeset
37 to <filename>OS9Boot</filename>, and its starting address and size is linked in the
138
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
38 disk's Identification Sector (LSN 0) for use by the OS-9 bootstrap
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
39 firmware.
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
40 </para>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
41 <para>
1053
b5ff125a1d60 Since this book was only typeset in fixed width, single-font, they used
roug
parents: 975
diff changeset
42 WARNING: Any <filename>OS9Boot</filename> file must be stored in physically contiguous
b5ff125a1d60 Since this book was only typeset in fixed width, single-font, they used
roug
parents: 975
diff changeset
43 sectors. Therefore, <command>OS9Gen</command> is normally used on a freshly formatted
b5ff125a1d60 Since this book was only typeset in fixed width, single-font, they used
roug
parents: 975
diff changeset
44 disk. If the <filename>OS9Boot</filename> file is fragmented, <command>OS9Gen</command> will print a
138
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
45 warning message indicated the disk cannot be used to bootstrap OS-9.
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
46 </para>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
47 <para>
1053
b5ff125a1d60 Since this book was only typeset in fixed width, single-font, they used
roug
parents: 975
diff changeset
48 The list of file names given to <command>OS9Gen</command> can be entered from a keyboard, or
b5ff125a1d60 Since this book was only typeset in fixed width, single-font, they used
roug
parents: 975
diff changeset
49 <command>OS9Gen</command>'s standard input may be redirected to a text file
138
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
50 containing a list of file names (pathlists) . If names are entered
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
51 manually, no prompts are given, and the end-of-file key (usually
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
52 ESCAPE) or a blank line is entered after the line containing the
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
53 last pathlist.
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
54 </para>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
55 <para>
1093
4dae346c4969 Added crossreferences and lowercased synopsises
roug
parents: 1053
diff changeset
56 For more information see: <xref linkend="sec6"/>,
4dae346c4969 Added crossreferences and lowercased synopsises
roug
parents: 1053
diff changeset
57 <xref linkend="sec6.1"/>, <xref linkend="sec6.6"/>
138
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
58 </para>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
59 </refsect1>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
60 <refsect1><title>Examples</title>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
61 <para>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
62 To manually install a boot file on device &quot;d1&quot; which is an exact
1053
b5ff125a1d60 Since this book was only typeset in fixed width, single-font, they used
roug
parents: 975
diff changeset
63 copy of the <filename>OS9Boot</filename> file on device &quot;d0&quot;:
138
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
64 </para>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
65 <screen>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
66 OS9: os9gen /d1 (run OS9Gen)
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
67 /d0/os9boot (enter file to be installed)
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
68 [ESCAPE] (enter end-of-file)
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
69 </screen>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
70 <para>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
71 To manually install a boot file on device &quot;d1&quot; which is a copy of
1053
b5ff125a1d60 Since this book was only typeset in fixed width, single-font, they used
roug
parents: 975
diff changeset
72 the <filename>OS9Boot</filename> file on device &quot;d0&quot; with the addition of
b5ff125a1d60 Since this book was only typeset in fixed width, single-font, they used
roug
parents: 975
diff changeset
73 modules stored in the files <filename>/d0/tape.driver</filename> and <filename>/d2/video.driver</filename>:
138
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
74 </para>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
75 <screen>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
76 OS9: os9gen /d1 (run OS9Gen)
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
77 /d0/os9boot (enter main boot file name)
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
78 /d0/tape.driver (enter name of first file to be added)
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
79 /d2/video.driver (enter name of second file to be added)
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
80 [ESCAPE] (enter end-of-file)
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
81 </screen>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
82 <para>
1053
b5ff125a1d60 Since this book was only typeset in fixed width, single-font, they used
roug
parents: 975
diff changeset
83 As above, but automatically by redirecting <command>OS9Gen</command> standard input:
138
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
84 </para>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
85 <screen>
1053
b5ff125a1d60 Since this book was only typeset in fixed width, single-font, they used
roug
parents: 975
diff changeset
86 OS9: build /d0/bootlist (use <command>build</command> to create file <filename>bootlist</filename>)
138
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
87 ? /d0/os9boot (enter first file name)
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
88 ? /d0/tape.driver (enter second file name)
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
89 ? /d2/video.driver (enter third file name)
1053
b5ff125a1d60 Since this book was only typeset in fixed width, single-font, they used
roug
parents: 975
diff changeset
90 ? [RETURN] (terminate <command>build</command>)
138
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
91 OS9: os9gen /d1 &lt;/d0/bootlist (run OS9gen with redirected input)
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
92 </screen>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
93 </refsect1>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
94 </refentry>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
95