annotate docs/nitros9guide/help.refentry @ 1340:63bfe1e5c5f4

Rodney added several additional codes that can be generated from the keyboard. ($7F, $1D-$1F)
author boisy
date Sat, 13 Sep 2003 17:59:00 +0000
parents 958740284209
children b00cf13c9f61
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
152
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
1 <refentry id="help">
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
2 <refnamediv>
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
3 <refname>HELP</refname>
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
4 <refpurpose>Displays the usage and syntax of OS-9 commands.</refpurpose>
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
5 </refnamediv>
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
6
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
7 <refsynopsisdiv>
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
8 <cmdsynopsis>
1093
4dae346c4969 Added crossreferences and lowercased synopsises
roug
parents: 1053
diff changeset
9 <command>help</command>
1094
958740284209 Use <emphasis> instead of CAPITALS
roug
parents: 1093
diff changeset
10 <arg choice="plain">
958740284209 Use <emphasis> instead of CAPITALS
roug
parents: 1093
diff changeset
11 &repeatst;<replaceable>command</replaceable>&repeaten;
152
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
12 </arg>
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
13 </cmdsynopsis>
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
14 </refsynopsisdiv>
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
15
1094
958740284209 Use <emphasis> instead of CAPITALS
roug
parents: 1093
diff changeset
16 <refsect1><title>Description</title>
152
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
17 <para>
1094
958740284209 Use <emphasis> instead of CAPITALS
roug
parents: 1093
diff changeset
18 Provide as argument the command for which you want syntax help. Include
958740284209 Use <emphasis> instead of CAPITALS
roug
parents: 1093
diff changeset
19 as many command names in one <command>help</command> line as you wish. The proper form and
958740284209 Use <emphasis> instead of CAPITALS
roug
parents: 1093
diff changeset
20 syntax appears for each valid command you include.
958740284209 Use <emphasis> instead of CAPITALS
roug
parents: 1093
diff changeset
21 </para>
958740284209 Use <emphasis> instead of CAPITALS
roug
parents: 1093
diff changeset
22 </refsect1>
958740284209 Use <emphasis> instead of CAPITALS
roug
parents: 1093
diff changeset
23
958740284209 Use <emphasis> instead of CAPITALS
roug
parents: 1093
diff changeset
24 <refsect1><title>Notes</title>
958740284209 Use <emphasis> instead of CAPITALS
roug
parents: 1093
diff changeset
25 <para>
958740284209 Use <emphasis> instead of CAPITALS
roug
parents: 1093
diff changeset
26 To use <command>help</command>, first copy <filename>Cmds.hp</filename> from the <filename class="directory">SYS</filename> directory of the CONFIG/BOOT
958740284209 Use <emphasis> instead of CAPITALS
roug
parents: 1093
diff changeset
27 Diskette to the <filename class="directory">SYS</filename> directory of your system diskette.
958740284209 Use <emphasis> instead of CAPITALS
roug
parents: 1093
diff changeset
28 Next, copy <command>help</command>
958740284209 Use <emphasis> instead of CAPITALS
roug
parents: 1093
diff changeset
29 from the <filename class="directory">CMDS</filename> directory of
958740284209 Use <emphasis> instead of CAPITALS
roug
parents: 1093
diff changeset
30 the CONFIG/BOOT Diskette to the <filename class="directory">CMDS</filename> directory
152
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
31 of your system diskette as follows:
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
32 </para>
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
33 <para>
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
34 Procedure for one disk drive:
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
35 </para>
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
36 <para>
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
37 1. With OS-9 booted and the system diskette in your drive, type:
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
38 </para>
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
39 <screen>
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
40 LOAD COPY [ENTER]
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
41 </screen>
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
42 <para>
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
43 2. Replace the system diskete with the CONFIG/BOOT Diskette and type:
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
44 </para>
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
45 <screen>
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
46 COPY /D0/SYS/CMDS.HP /D0/SYS/CMDS.HP -S #30K [ENTER]
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
47 </screen>
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
48 <para>
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
49 3. Exchange the two diskettes as requested by the screen prompts until the
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
50 process is complete.
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
51 </para>
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
52 <para>
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
53 4. Again, place the CONFIG/BOOT DIskette int he drive, and type:
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
54 </para>
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
55 <screen>
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
56 COPY /D0/CMDS/help /D0/CMDS/help -S #30K [ENTER]
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
57 </screen>
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
58 <para>
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
59 5. Swap diskettes as requested until the process is complete.
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
60 </para>
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
61 <para>
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
62 Procedure for two disk drives
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
63 </para>
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
64 <para>
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
65 1. With OS-9 booted, place the CONFIG/BOOT Diskette in Drive 1. Be sure
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
66 the system diskette is in Drive 0.
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
67 </para>
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
68 <para>
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
69 2. Type:
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
70 </para>
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
71 <screen>
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
72 COPY /D1/SYS/CMDS.HP /D0/SYS/CMDS.HP [ENTER]
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
73 </screen>
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
74 <para>
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
75 3. When the first copy is complete, type:
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
76 </para>
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
77 <screen>
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
78 COPY /D1/CMDS/help /D0/CMDS/help [ENTER]
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
79 </screen>
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
80 <para>
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
81 Cmds.hp is a data file, not a text file, and you cannot successfully display
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
82 it on your screen or edit it with a standard text editor. It contains help
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
83 for standard OS-9 commands.
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
84 </para>
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
85 <para>
1053
b5ff125a1d60 Since this book was only typeset in fixed width, single-font, they used
roug
parents: 154
diff changeset
86 <command>Help</command> displays the form and syntax of the specified command. If you use a
152
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
87 non-standard command name, a screen display tells you that help is not
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
88 available for that command.
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
89 </para>
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
90 <para>
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
91 Examples:
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
92 </para>
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
93 <screen>
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
94 HELP BACKUP [ENTER]
154
b306cda3f7ec Integration into main document
roug
parents: 152
diff changeset
95 BACKUP [e][s][-v][dev][dev]
152
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
96 Copies all data from one device to another
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
97
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
98 HELP ME [ENTER]
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
99 ME Help not available
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
100
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
101 HELP [ENTER]
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
102 HELP [command name][...]
154
b306cda3f7ec Integration into main document
roug
parents: 152
diff changeset
103 </screen>
152
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
104 </refsect1>
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
105 </refentry>