Mercurial > hg > Members > kono > nitros9-code

annotate docs/nitros9guide/help.refentry @ 1093:4dae346c4969

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Added crossreferences and lowercased synopsises
author roug
date Mon, 07 Apr 2003 21:01:46 +0000
parents b5ff125a1d60
children 958740284209
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>
152
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
10 <arg choice="opt">
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
11 <option>command - the command for which you want syntax help. Include
1053
b5ff125a1d60 Since this book was only typeset in fixed width, single-font, they used
roug
parents: 154
diff changeset
12 as many command names in one <command>help</command> line as you wish. The proper form and
152
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
13 syntax appears for each valid command you include.
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
14 </option>
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
15 </arg>
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
16 </cmdsynopsis>
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
17 </refsynopsisdiv>
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
18
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
19 <refsect1><title>Notes</title>
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
20
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
21 <para>
1053
b5ff125a1d60 Since this book was only typeset in fixed width, single-font, they used
roug
parents: 154
diff changeset
22 To use <command>help</command>, first copy Cmds.hp from the SYS directory of the CONFIG/BOOT
b5ff125a1d60 Since this book was only typeset in fixed width, single-font, they used
roug
parents: 154
diff changeset
23 Diskette to the SYS directory of your system diskette. Next, copy <command>help</command>
152
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
24 from the CMDS directory of the CONFIG/BOOT Diskette to the CMDS directory
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
25 of your system diskette as follows:
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
26 </para>
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
27 <para>
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
28 Procedure for one disk drive:
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
29 </para>
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
30 <para>
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
31 1. With OS-9 booted and the system diskette in your drive, type:
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 <screen>
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
34 LOAD COPY [ENTER]
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
35 </screen>
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 2. Replace the system diskete with the CONFIG/BOOT Diskette and 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 COPY /D0/SYS/CMDS.HP /D0/SYS/CMDS.HP -S #30K [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 3. Exchange the two diskettes as requested by the screen prompts until the
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
44 process is complete.
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
45 </para>
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
46 <para>
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
47 4. Again, place the CONFIG/BOOT DIskette int he drive, and type:
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 <screen>
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
50 COPY /D0/CMDS/help /D0/CMDS/help -S #30K [ENTER]
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
51 </screen>
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 5. Swap diskettes as requested until the process is complete.
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 <para>
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
56 Procedure for two disk drives
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
57 </para>
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 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
60 the system diskette is in Drive 0.
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 <para>
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
63 2. Type:
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 <screen>
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
66 COPY /D1/SYS/CMDS.HP /D0/SYS/CMDS.HP [ENTER]
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
67 </screen>
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 3. When the first copy is complete, 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/CMDS/help /D0/CMDS/help [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 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
76 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
77 for standard OS-9 commands.
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
78 </para>
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
79 <para>
1053
b5ff125a1d60 Since this book was only typeset in fixed width, single-font, they used
roug
parents: 154
diff changeset
80 <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
81 non-standard command name, a screen display tells you that help is not
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
82 available for that command.
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
83 </para>
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 Examples:
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
86 </para>
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
87 <screen>
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
88 HELP BACKUP [ENTER]
154
b306cda3f7ec Integration into main document
roug
parents: 152
diff changeset
89 BACKUP [e][s][-v][dev][dev]
152
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
90 Copies all data from one device to another
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
91
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
92 HELP ME [ENTER]
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
93 ME Help not available
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
94
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
95 HELP [ENTER]
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
96 HELP [command name][...]
154
b306cda3f7ec Integration into main document
roug
parents: 152
diff changeset
97 </screen>
152
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
98 </refsect1>
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
99 </refentry>