comparison docs/nitros9guide/help.refentry @ 152:6c48191bd06a

Refentries for CoCo OS-9 commands
author boisy
date Sun, 07 Jul 2002 18:44:28 +0000
parents
children b306cda3f7ec
comparison
equal deleted inserted replaced
151:845e890728df 152:6c48191bd06a
1 <refentry id="help">
2 <refnamediv>
3 <refname>HELP</refname>
4 <refpurpose>Displays the usage and syntax of OS-9 commands.</refpurpose>
5 </refnamediv>
6
7 <refsynopsisdiv>
8 <cmdsynopsis>
9 <command>TUNEPORT</command>
10 <arg choice="opt">
11 <option>command - the command for which you want syntax help. Include
12 as many command names in one HELP line as you wish. The proper form and
13 syntax appears for each valid command you include.
14 </option>
15 </arg>
16 </cmdsynopsis>
17 </refsynopsisdiv>
18
19 <refsect1><title>Notes</title>
20
21 <para>
22 To use HELP, first copy Cmds.hp from the SYS directory of the CONFIG/BOOT
23 Diskette to the SYS directory of your system diskette. Next, copy HELP
24 from the CMDS directory of the CONFIG/BOOT Diskette to the CMDS directory
25 of your system diskette as follows:
26 </para>
27 <para>
28 Procedure for one disk drive:
29 </para>
30 <para>
31 1. With OS-9 booted and the system diskette in your drive, type:
32 </para>
33 <screen>
34 LOAD COPY [ENTER]
35 </screen>
36 <para>
37 2. Replace the system diskete with the CONFIG/BOOT Diskette and type:
38 </para>
39 <screen>
40 COPY /D0/SYS/CMDS.HP /D0/SYS/CMDS.HP -S #30K [ENTER]
41 </screen>
42 <para>
43 3. Exchange the two diskettes as requested by the screen prompts until the
44 process is complete.
45 </para>
46 <para>
47 4. Again, place the CONFIG/BOOT DIskette int he drive, and type:
48 </para>
49 <screen>
50 COPY /D0/CMDS/help /D0/CMDS/help -S #30K [ENTER]
51 </screen>
52 <para>
53 5. Swap diskettes as requested until the process is complete.
54 </para>
55 <para>
56 Procedure for two disk drives
57 </para>
58 <para>
59 1. With OS-9 booted, place the CONFIG/BOOT Diskette in Drive 1. Be sure
60 the system diskette is in Drive 0.
61 </para>
62 <para>
63 2. Type:
64 </para>
65 <screen>
66 COPY /D1/SYS/CMDS.HP /D0/SYS/CMDS.HP [ENTER]
67 </screen>
68 <para>
69 3. When the first copy is complete, type:
70 </para>
71 <screen>
72 COPY /D1/CMDS/help /D0/CMDS/help [ENTER]
73 </screen>
74 <para>
75 Cmds.hp is a data file, not a text file, and you cannot successfully display
76 it on your screen or edit it with a standard text editor. It contains help
77 for standard OS-9 commands.
78 </para>
79 <para>
80 HELP displays the form and syntax of the specified command. If you use a
81 non-standard command name, a screen display tells you that help is not
82 available for that command.
83 </para>
84 <para>
85 Examples:
86 </para>
87 <screen>
88 HELP BACKUP [ENTER]
89 BACUKP [e][s][-v][dev][dev]
90 Copies all data from one device to another
91
92 HELP ME [ENTER]
93 ME Help not available
94
95 HELP [ENTER]
96 HELP [command name][...]
97 </refsect1>
98 </refentry>
99