annotate docs/nitros9guide/os9gen.refentry @ 603:e9578f62b346

All refentries finished.
author roug
date Fri, 15 Nov 2002 21:49:51 +0000
parents d9631713b7cd
children c565a4700689
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>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
9 <command>OS9GEN</command>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
10 <arg choice="plain">
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
11 &replstart;device name&replend;
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>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
18 OS9Gen is used to create and link the &quot;OS9Boot&quot; file required on any
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
19 disk from which OS-9 is to be bootstrapped. OS9Gen is used to add
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.
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
21 If an exact copy of the existing OS9Boot file is desired, the
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
22 COBBLER command should be used instead.
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>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
25 The name of the device on which the &quot;OS9Boot&quot; file is to be
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
26 installed is passed to OS9Gen as a command line parameter. OS9Gen then
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
27 creates a working file called &quot;TempBoot&quot; on the device specified.
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
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
30 &quot;TempBoot&quot;. This is repeated until end-of-file or a blank line is
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
31 reached on OS9Gen's standard input. All boot files must contain the
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
32 OS-9 component modules listed in section 6.1.
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>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
35 After all input files have been copied to &quot;TempBoot&quot;, the old
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
36 &quot;OS9Boot&quot; file, if present, is deleted. &quot;TempBoot&quot; is then renamed
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
37 to &quot;OS9Boot&quot;, and its starting address and size is linked in the
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>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
42 WARNING: Any &quot;OS9Boot&quot; file must be stored in physically contiguous
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
43 sectors. Therefore, OS9Gen is normally used on a freshly formatted
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
44 disk. If the &quot;OS9Boot&quot; file is fragmented, OS9Gen will print a
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>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
48 The list of file names given to OS9Gen can be entered from a keyboard, or
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
49 OS9Gen's standard input may be redirected to a text file
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>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
56 For more information see: 6.0, 6.1, 6.6
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
57 </para>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
58 </refsect1>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
59 <refsect1><title>Examples</title>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
60 <para>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
61 To manually install a boot file on device &quot;d1&quot; which is an exact
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
62 copy of the &quot;OS9Boot&quot; file on device &quot;d0&quot;:
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
63 </para>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
64 <screen>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
65 OS9: os9gen /d1 (run OS9Gen)
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
66 /d0/os9boot (enter file to be installed)
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
67 [ESCAPE] (enter end-of-file)
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
68 </screen>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
69 <para>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
70 To manually install a boot file on device &quot;d1&quot; which is a copy of
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
71 the &quot;OS9Boot&quot; file on device &quot;do&quot; with the addition of
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
72 modules stored in the files &quot;/d0/tape.driver&quot; and &quot;/d2/video.driver&quot;:
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
73 </para>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
74 <screen>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
75 OS9: os9gen /d1 (run OS9Gen)
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
76 /d0/os9boot (enter main boot file name)
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
77 /d0/tape.driver (enter name of first file to be added)
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
78 /d2/video.driver (enter name of second file to be added)
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
79 [ESCAPE] (enter end-of-file)
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
80 </screen>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
81 <para>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
82 As above, but automatically by redirecting OS9Gen standard input:
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
83 </para>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
84 <screen>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
85 OS9: build /d0/bootlist (use &quot;build&quot; to create file &quot;bootlist&quot;)
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
86 ? /d0/os9boot (enter first file name)
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
87 ? /d0/tape.driver (enter second file name)
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
88 ? /d2/video.driver (enter third file name)
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
89 ? [RETURN] (terminate &quot;build&quot;)
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
90 OS9: os9gen /d1 &lt;/d0/bootlist (run OS9gen with redirected input)
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
91 </screen>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
92 </refsect1>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
93 </refentry>
d9631713b7cd Split up the commands into individual files.
roug
parents:
diff changeset
94