Mercurial > hg > Members > kono > nitros9-code
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 |
rev | line source |
---|---|
152 | 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> | |
1093 | 9 <command>help</command> |
1094 | 10 <arg choice="plain"> |
11 &repeatst;<replaceable>command</replaceable>&repeaten; | |
152 | 12 </arg> |
13 </cmdsynopsis> | |
14 </refsynopsisdiv> | |
15 | |
1094 | 16 <refsect1><title>Description</title> |
152 | 17 <para> |
1094 | 18 Provide as argument the command for which you want syntax help. Include |
19 as many command names in one <command>help</command> line as you wish. The proper form and | |
20 syntax appears for each valid command you include. | |
21 </para> | |
22 </refsect1> | |
23 | |
24 <refsect1><title>Notes</title> | |
25 <para> | |
26 To use <command>help</command>, first copy <filename>Cmds.hp</filename> from the <filename class="directory">SYS</filename> directory of the CONFIG/BOOT | |
27 Diskette to the <filename class="directory">SYS</filename> directory of your system diskette. | |
28 Next, copy <command>help</command> | |
29 from the <filename class="directory">CMDS</filename> directory of | |
30 the CONFIG/BOOT Diskette to the <filename class="directory">CMDS</filename> directory | |
152 | 31 of your system diskette as follows: |
32 </para> | |
33 <para> | |
34 Procedure for one disk drive: | |
35 </para> | |
36 <para> | |
37 1. With OS-9 booted and the system diskette in your drive, type: | |
38 </para> | |
39 <screen> | |
40 LOAD COPY [ENTER] | |
41 </screen> | |
42 <para> | |
43 2. Replace the system diskete with the CONFIG/BOOT Diskette and type: | |
44 </para> | |
45 <screen> | |
46 COPY /D0/SYS/CMDS.HP /D0/SYS/CMDS.HP -S #30K [ENTER] | |
47 </screen> | |
48 <para> | |
49 3. Exchange the two diskettes as requested by the screen prompts until the | |
50 process is complete. | |
51 </para> | |
52 <para> | |
53 4. Again, place the CONFIG/BOOT DIskette int he drive, and type: | |
54 </para> | |
55 <screen> | |
56 COPY /D0/CMDS/help /D0/CMDS/help -S #30K [ENTER] | |
57 </screen> | |
58 <para> | |
59 5. Swap diskettes as requested until the process is complete. | |
60 </para> | |
61 <para> | |
62 Procedure for two disk drives | |
63 </para> | |
64 <para> | |
65 1. With OS-9 booted, place the CONFIG/BOOT Diskette in Drive 1. Be sure | |
66 the system diskette is in Drive 0. | |
67 </para> | |
68 <para> | |
69 2. Type: | |
70 </para> | |
71 <screen> | |
72 COPY /D1/SYS/CMDS.HP /D0/SYS/CMDS.HP [ENTER] | |
73 </screen> | |
74 <para> | |
75 3. When the first copy is complete, type: | |
76 </para> | |
77 <screen> | |
78 COPY /D1/CMDS/help /D0/CMDS/help [ENTER] | |
79 </screen> | |
80 <para> | |
81 Cmds.hp is a data file, not a text file, and you cannot successfully display | |
82 it on your screen or edit it with a standard text editor. It contains help | |
83 for standard OS-9 commands. | |
84 </para> | |
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 | 87 non-standard command name, a screen display tells you that help is not |
88 available for that command. | |
89 </para> | |
90 <para> | |
91 Examples: | |
92 </para> | |
93 <screen> | |
94 HELP BACKUP [ENTER] | |
154 | 95 BACKUP [e][s][-v][dev][dev] |
152 | 96 Copies all data from one device to another |
97 | |
98 HELP ME [ENTER] | |
99 ME Help not available | |
100 | |
101 HELP [ENTER] | |
102 HELP [command name][...] | |
154 | 103 </screen> |
152 | 104 </refsect1> |
105 </refentry> |