Mercurial > hg > Members > kono > nitros9-code

annotate docs/nitros9guide/chap7.chapter @ 1331:0a3500c747de

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Fixed ANOTHER bug
author boisy
date Sun, 07 Sep 2003 00:53:51 +0000
parents bc28c3bc3769
children b00cf13c9f61
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
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
5 programs that are supplied with OS-9. These programs are usually
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
6 called using the shell, but can be called from most other OS-9
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>
1148
bc28c3bc3769 Put all stylesheets in one central location
roug
parents: 1094
diff changeset
13 Although many OS-9 commands may work on Level One or Level
1094
958740284209 Use <emphasis> instead of CAPITALS
roug
parents: 1093
diff changeset
14 Two systems, there are differences. Take care not to mix command
958740284209 Use <emphasis> instead of CAPITALS
roug
parents: 1093
diff changeset
15 files from Level One systems on Level Two, 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;
153
f4af2c0b842c Integration into main document
roug
parents: 146
diff changeset
91 &configref;
146
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
92 &copyref;
971
425b8a051c58 Reference pages for new commands
roug
parents: 920
diff changeset
93 &cputyperef;
146
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
94 &dateref;
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
95 &dcheckref;
727
72443b44537e Debug is part of the manual now.
roug
parents: 647
diff changeset
96 &debugref;
971
425b8a051c58 Reference pages for new commands
roug
parents: 920
diff changeset
97 &dedref;
146
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
98 &delref;
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
99 &deldirref;
971
425b8a051c58 Reference pages for new commands
roug
parents: 920
diff changeset
100 &devsref;
425b8a051c58 Reference pages for new commands
roug
parents: 920
diff changeset
101 &dmoderef;
146
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
102 &dirref;
971
425b8a051c58 Reference pages for new commands
roug
parents: 920
diff changeset
103 &disasmref;
146
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
104 &displayref;
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
105 &dsaveref;
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
106 &dumpref;
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
107 &echoref;
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
108 &exref;
1014
d9ed9d44b70c Some character entities had missing semicolons. It's &CPU;
roug
parents: 1011
diff changeset
109 &exbinref;
971
425b8a051c58 Reference pages for new commands
roug
parents: 920
diff changeset
110 &exmoderef;
146
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
111 &formatref;
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
112 &freeref;
153
f4af2c0b842c Integration into main document
roug
parents: 146
diff changeset
113 &helpref;
146
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
114 &identref;
153
f4af2c0b842c Integration into main document
roug
parents: 146
diff changeset
115 &inizref;
971
425b8a051c58 Reference pages for new commands
roug
parents: 920
diff changeset
116 &irqsref;
146
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
117 &killref;
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
118 &linkref;
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
119 &listref;
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
120 &loadref;
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
121 &loginref;
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
122 &makdirref;
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
123 &mdirref;
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
124 &mergeref;
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
125 &mfreeref;
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
126 &os9genref;
1093
4dae346c4969 Added crossreferences and lowercased synopsises
roug
parents: 1014
diff changeset
127 &printerrref;
1014
d9ed9d44b70c Some character entities had missing semicolons. It's &CPU;
roug
parents: 1011
diff changeset
128 &procref;
146
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
129 &procsref;
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
130 &pwdref;
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
131 &renameref;
920
cfed0d7751f3 Added basic09, cc and runb to the user's guide
roug
parents: 727
diff changeset
132 &runbref;
146
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
133 &saveref;
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
134 &setimeref;
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
135 &setprref;
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
136 &shellref;
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
137 &sleepref;
1014
d9ed9d44b70c Some character entities had missing semicolons. It's &CPU;
roug
parents: 1011
diff changeset
138 &smapref;
146
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
139 &teeref;
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
140 &tmoderef;
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
141 &tsmonref;
153
f4af2c0b842c Integration into main document
roug
parents: 146
diff changeset
142 &tuneportref;
146
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
143 &unlinkref;
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
144 &verifyref;
1014
d9ed9d44b70c Some character entities had missing semicolons. It's &CPU;
roug
parents: 1011
diff changeset
145 &wcreateref;
146
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
146 &xmoderef;
153
f4af2c0b842c Integration into main document
roug
parents: 146
diff changeset
147
146
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
148 </section>
88ae6ed51be6 More splitups.
roug
parents:
diff changeset
149 </chapter>