Mercurial > hg > Members > kono > nitros9-code

annotate docs/nitros9guide/help.refentry @ 1988:b96143206d83

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Added more definitions as I have worked them out :)
author afra
date Mon, 30 Jan 2006 23:13:04 +0000
parents b00cf13c9f61
children
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>
1500
b00cf13c9f61 Major changes for new NitrOS-9 manual
boisy
parents: 1094
diff changeset
4 <refpurpose>Displays the usage and syntax of NitrOS-9 commands.</refpurpose>
152
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 <para>
1500
b00cf13c9f61 Major changes for new NitrOS-9 manual
boisy
parents: 1094
diff changeset
23 If you do not include a command name, help will show you the list of
b00cf13c9f61 Major changes for new NitrOS-9 manual
boisy
parents: 1094
diff changeset
24 available topics for you to choose from.
152
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
25 </para>
1500
b00cf13c9f61 Major changes for new NitrOS-9 manual
boisy
parents: 1094
diff changeset
26 </refsect1>
b00cf13c9f61 Major changes for new NitrOS-9 manual
boisy
parents: 1094
diff changeset
27 <refsect1>
b00cf13c9f61 Major changes for new NitrOS-9 manual
boisy
parents: 1094
diff changeset
28 <title>
b00cf13c9f61 Major changes for new NitrOS-9 manual
boisy
parents: 1094
diff changeset
29 Examples:
b00cf13c9f61 Major changes for new NitrOS-9 manual
boisy
parents: 1094
diff changeset
30 </title>
152
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
31 <screen>
1500
b00cf13c9f61 Major changes for new NitrOS-9 manual
boisy
parents: 1094
diff changeset
32 help ex [ENTER]
b00cf13c9f61 Major changes for new NitrOS-9 manual
boisy
parents: 1094
diff changeset
33 Syntax: Ex &lt;modname&gt;
b00cf13c9f61 Major changes for new NitrOS-9 manual
boisy
parents: 1094
diff changeset
34 Usage : Chain to the given module
152
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
35
1500
b00cf13c9f61 Major changes for new NitrOS-9 manual
boisy
parents: 1094
diff changeset
36 help me [ENTER]
b00cf13c9f61 Major changes for new NitrOS-9 manual
boisy
parents: 1094
diff changeset
37 me: no help available
152
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
38
1500
b00cf13c9f61 Major changes for new NitrOS-9 manual
boisy
parents: 1094
diff changeset
39 help [ENTER]
b00cf13c9f61 Major changes for new NitrOS-9 manual
boisy
parents: 1094
diff changeset
40 Help available on:
b00cf13c9f61 Major changes for new NitrOS-9 manual
boisy
parents: 1094
diff changeset
41 ASM ATTR [...]
154
b306cda3f7ec Integration into main document
roug
parents: 152
diff changeset
42 </screen>
152
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
43 </refsect1>
6c48191bd06a Refentries for CoCo OS-9 commands
boisy
parents:
diff changeset
44 </refentry>