Mercurial > hg > Members > kono > nitros9-code

annotate docs/nitros9guide/chap7.chapter @ 1892:77d83b367eba

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
reduced labeltab size so os9boot would link
author robert
date Fri, 14 Oct 2005 01:56:25 +0000
parents b00cf13c9f61
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
146
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
1 <chapter>
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
2 <title>System Command Descriptions</title>
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
3 <para>
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
4 This section contains descriptions for each of the command
1500
b00cf13c9f61 Major changes for new NitrOS-9 manual
boisy
parents: 1148
diff changeset
5 programs that are supplied with NitrOS-9. These programs are usually
b00cf13c9f61 Major changes for new NitrOS-9 manual
boisy
parents: 1148
diff changeset
6 called using the shell, but can be called from most other NitrOS-9
146
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
7 family programs such as BASIC09, Interactive Debugger, Macro Text
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
8 Editor, etc. Unless otherwise noted, these programs are designed to
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
9 run as individual processes.
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
10 </para>
1094
958740284209 Use <emphasis> instead of CAPITALS
roug
parents: 1093
diff changeset
11 <warning>
146
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
12 <para>
1500
b00cf13c9f61 Major changes for new NitrOS-9 manual
boisy
parents: 1148
diff changeset
13 Although many NitrOS-9 commands may work on Level 1 or Level
b00cf13c9f61 Major changes for new NitrOS-9 manual
boisy
parents: 1148
diff changeset
14 2 systems, there are differences. Take care not to mix command
b00cf13c9f61 Major changes for new NitrOS-9 manual
boisy
parents: 1148
diff changeset
15 files from Level 1 systems on Level 2, or the reverse.
146
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
16 </para>
1094
958740284209 Use <emphasis> instead of CAPITALS
roug
parents: 1093
diff changeset
17 </warning>
146
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
18 <section>
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
19 <title>Formal Syntax Notation</title>
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
20 <para>
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
21 Each command description includes a syntax definition which
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
22 describes how the command sentence can be constructed. These are
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
23 symbolic descriptions that use the following notation:
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
24 </para>
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
25
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
26 <informaltable frame="none">
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
27 <tgroup cols="2">
647
450889faad6b XMLified.
roug
parents: 159
diff changeset
28 <colspec colwidth="1in"/>
450889faad6b XMLified.
roug
parents: 159
diff changeset
29 <colspec colwidth="4in"/>
146
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
30 <tbody>
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
31 <row>
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
32 <entry>[ ]</entry>
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
33 <entry>= Brackets indicate that the enclosed item(s) are optional.</entry>
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
34 </row>
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
35 <row>
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
36 <entry>&repeatst; &repeaten;</entry>
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
37 <entry>= Braces indicate that the enclosed item(s) can be
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
38 either omitted or repeated multiple times.</entry>
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
39 </row>
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
40 <row>
975
c565a4700689 The entitity replstart was replaced with <replaceable>
roug
parents: 971
diff changeset
41 <entry><replaceable>path</replaceable></entry>
146
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
42 <entry>= Represents any legal pathlist.</entry>
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
43 </row>
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
44 <row>
975
c565a4700689 The entitity replstart was replaced with <replaceable>
roug
parents: 971
diff changeset
45 <entry><replaceable>devname</replaceable></entry>
146
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
46 <entry>= Represents any legal device name.</entry>
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
47 </row>
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
48 <row>
975
c565a4700689 The entitity replstart was replaced with <replaceable>
roug
parents: 971
diff changeset
49 <entry><replaceable>nodname</replaceable></entry>
146
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
50 <entry>= Represents any legal memory module name.</entry>
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
51 </row>
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
52 <row>
975
c565a4700689 The entitity replstart was replaced with <replaceable>
roug
parents: 971
diff changeset
53 <entry><replaceable>procID</replaceable></entry>
146
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
54 <entry>= Represents a process number.</entry>
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
55 </row>
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
56 <row>
975
c565a4700689 The entitity replstart was replaced with <replaceable>
roug
parents: 971
diff changeset
57 <entry><replaceable>opts</replaceable></entry>
146
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
58 <entry>= One or more options defined in the command description.</entry>
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
59 </row>
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
60 <row>
975
c565a4700689 The entitity replstart was replaced with <replaceable>
roug
parents: 971
diff changeset
61 <entry><replaceable>arglist</replaceable></entry>
146
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
62 <entry>= a list of arguments (parameters).</entry>
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
63 </row>
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
64 <row>
975
c565a4700689 The entitity replstart was replaced with <replaceable>
roug
parents: 971
diff changeset
65 <entry><replaceable>text</replaceable></entry>
146
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
66 <entry>= a character string terminated by end-of-line.</entry>
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
67 </row>
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
68 </tbody>
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
69 </tgroup>
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
70 </informaltable>
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
71
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
72 <para>
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
73 NOTE: The syntax of the commands given does not include the shell's
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
74 built in options such as alternate memory size, I/O redirection,
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
75 etc. This is because the shell will filter its options out of the
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
76 command line before it is passed to the program being called.
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
77 </para>
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
78 </section>
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
79
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
80 <section>
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
81 <title>Commands</title>
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
82
1014
d9ed9d44b70c Some character entities had missing semicolons. It's &CPU;
roug
parents: 1011
diff changeset
83 &asmref;
146
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
84 &attrref;
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
85 &backupref;
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
86 &binexref;
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
87 &buildref;
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
88 &chdref;
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
89 &cmpref;
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
90 &cobblerref;
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
91 &copyref;
971
425b8a051c58 Reference pages for new commands
roug
parents: 920
diff changeset
92 &cputyperef;
146
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
93 &dateref;
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
94 &dcheckref;
727
72443b44537e Debug is part of the manual now.
roug
parents: 647
diff changeset
95 &debugref;
971
425b8a051c58 Reference pages for new commands
roug
parents: 920
diff changeset
96 &dedref;
146
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
97 &delref;
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
98 &deldirref;
971
425b8a051c58 Reference pages for new commands
roug
parents: 920
diff changeset
99 &devsref;
425b8a051c58 Reference pages for new commands
roug
parents: 920
diff changeset
100 &dmoderef;
146
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
101 &dirref;
971
425b8a051c58 Reference pages for new commands
roug
parents: 920
diff changeset
102 &disasmref;
146
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
103 &displayref;
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
104 &dsaveref;
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
105 &dumpref;
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
106 &echoref;
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
107 &exref;
1014
d9ed9d44b70c Some character entities had missing semicolons. It's &CPU;
roug
parents: 1011
diff changeset
108 &exbinref;
971
425b8a051c58 Reference pages for new commands
roug
parents: 920
diff changeset
109 &exmoderef;
146
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
110 &formatref;
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
111 &freeref;
153
f4af2c0b842c Integration into main document
roug
parents: 146
diff changeset
112 &helpref;
146
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
113 &identref;
153
f4af2c0b842c Integration into main document
roug
parents: 146
diff changeset
114 &inizref;
971
425b8a051c58 Reference pages for new commands
roug
parents: 920
diff changeset
115 &irqsref;
146
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
116 &killref;
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
117 &linkref;
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
118 &listref;
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
119 &loadref;
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
120 &loginref;
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
121 &makdirref;
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
122 &mdirref;
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
123 &mergeref;
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
124 &mfreeref;
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
125 &os9genref;
1093
4dae346c4969 Added crossreferences and lowercased synopsises
roug
parents: 1014
diff changeset
126 &printerrref;
1014
d9ed9d44b70c Some character entities had missing semicolons. It's &CPU;
roug
parents: 1011
diff changeset
127 &procref;
146
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
128 &procsref;
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
129 &pwdref;
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
130 &renameref;
920
cfed0d7751f3 Added basic09, cc and runb to the user's guide
roug
parents: 727
diff changeset
131 &runbref;
146
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
132 &saveref;
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
133 &setimeref;
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
134 &setprref;
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
135 &shellref;
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
136 &sleepref;
1014
d9ed9d44b70c Some character entities had missing semicolons. It's &CPU;
roug
parents: 1011
diff changeset
137 &smapref;
146
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
138 &teeref;
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
139 &tmoderef;
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
140 &tsmonref;
153
f4af2c0b842c Integration into main document
roug
parents: 146
diff changeset
141 &tuneportref;
146
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
142 &unlinkref;
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
143 &verifyref;
1014
d9ed9d44b70c Some character entities had missing semicolons. It's &CPU;
roug
parents: 1011
diff changeset
144 &wcreateref;
146
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
145 &xmoderef;
153
f4af2c0b842c Integration into main document
roug
parents: 146
diff changeset
146
146
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
147 </section>
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
148 </chapter>