|
146
|
1 <chapter>
|
|
|
2 <title>System Command Descriptions</title>
|
|
|
3 <para>
|
|
|
4 This section contains descriptions for each of the command
|
|
|
5 programs that are supplied with OS-9. These programs are usually
|
|
|
6 called using the shell, but can be called from most other OS-9
|
|
|
7 family programs such as BASIC09, Interactive Debugger, Macro Text
|
|
|
8 Editor, etc. Unless otherwise noted, these programs are designed to
|
|
|
9 run as individual processes.
|
|
|
10 </para>
|
|
|
11 <para>
|
|
|
12 <emphasis>WARNING</emphasis>
|
|
|
13 - ALTHOUGH MANY OS-9 COMMANDS MAY WORK ON LEVEL ONE OR LEVEL
|
|
|
14 TWO SYSTEMS, THERE ARE DIFFERENCES. TAKE CARE NOT TO MIX COMMAND
|
|
|
15 FILES FROM LEVEL ONE SYSTEMS ON LEVEL TWO, OR THE REVERSE.
|
|
|
16 </para>
|
|
|
17 <section>
|
|
|
18 <title>Formal Syntax Notation</title>
|
|
|
19 <para>
|
|
|
20 Each command description includes a syntax definition which
|
|
|
21 describes how the command sentence can be constructed. These are
|
|
|
22 symbolic descriptions that use the following notation:
|
|
|
23 </para>
|
|
|
24
|
|
|
25 <informaltable frame="none">
|
|
|
26 <tgroup cols="2">
|
|
|
27 <colspec colwidth="1in">
|
|
|
28 <colspec colwidth="4in">
|
|
|
29 <tbody>
|
|
|
30 <row>
|
|
|
31 <entry>[ ]</entry>
|
|
|
32 <entry>= Brackets indicate that the enclosed item(s) are optional.</entry>
|
|
|
33 </row>
|
|
|
34 <row>
|
|
|
35 <entry>&repeatst; &repeaten;</entry>
|
|
|
36 <entry>= Braces indicate that the enclosed item(s) can be
|
|
|
37 either omitted or repeated multiple times.</entry>
|
|
|
38 </row>
|
|
|
39 <row>
|
|
|
40 <entry>&replstart;path&replend;</entry>
|
|
|
41 <entry>= Represents any legal pathlist.</entry>
|
|
|
42 </row>
|
|
|
43 <row>
|
|
|
44 <entry>&replstart;devname&replend;</entry>
|
|
|
45 <entry>= Represents any legal device name.</entry>
|
|
|
46 </row>
|
|
|
47 <row>
|
|
|
48 <entry>&replstart;nodname&replend;</entry>
|
|
|
49 <entry>= Represents any legal memory module name.</entry>
|
|
|
50 </row>
|
|
|
51 <row>
|
|
|
52 <entry>&replstart;procID&replend;</entry>
|
|
|
53 <entry>= Represents a process number.</entry>
|
|
|
54 </row>
|
|
|
55 <row>
|
|
|
56 <entry>&replstart;opts&replend;</entry>
|
|
|
57 <entry>= One or more options defined in the command description.</entry>
|
|
|
58 </row>
|
|
|
59 <row>
|
|
|
60 <entry>&replstart;arglist&replend;</entry>
|
|
|
61 <entry>= a list of arguments (parameters).</entry>
|
|
|
62 </row>
|
|
|
63 <row>
|
|
|
64 <entry>&replstart;text&replend;</entry>
|
|
|
65 <entry>= a character string terminated by end-of-line.</entry>
|
|
|
66 </row>
|
|
|
67 </tbody>
|
|
|
68 </tgroup>
|
|
|
69 </informaltable>
|
|
|
70
|
|
|
71 <para>
|
|
|
72 NOTE: The syntax of the commands given does not include the shell's
|
|
|
73 built in options such as alternate memory size, I/O redirection,
|
|
|
74 etc. This is because the shell will filter its options out of the
|
|
|
75 command line before it is passed to the program being called.
|
|
|
76 </para>
|
|
|
77 </section>
|
|
|
78
|
|
|
79 <section>
|
|
|
80 <title>Commands</title>
|
|
|
81
|
|
|
82 &attrref;
|
|
|
83 &backupref;
|
|
|
84 &binexref;
|
|
|
85 &buildref;
|
|
|
86 &chdref;
|
|
|
87 &cmpref;
|
|
|
88 &cobblerref;
|
|
153
|
89 &configref;
|
|
146
|
90 ©ref;
|
|
|
91 &dateref;
|
|
|
92 &dcheckref;
|
|
|
93 &delref;
|
|
|
94 &deldirref;
|
|
|
95 &dirref;
|
|
|
96 &displayref;
|
|
|
97 &dsaveref;
|
|
|
98 &dumpref;
|
|
|
99 &echoref;
|
|
|
100 &exref;
|
|
|
101 &formatref;
|
|
|
102 &freeref;
|
|
159
|
103 &go51ref;
|
|
153
|
104 &helpref;
|
|
146
|
105 &identref;
|
|
153
|
106 &inizref;
|
|
146
|
107 &killref;
|
|
|
108 &linkref;
|
|
|
109 &listref;
|
|
|
110 &loadref;
|
|
|
111 &loginref;
|
|
|
112 &makdirref;
|
|
|
113 &mdirref;
|
|
|
114 &mergeref;
|
|
|
115 &mfreeref;
|
|
|
116 &os9genref;
|
|
|
117 &printerrref;
|
|
|
118 &procsref;
|
|
|
119 &pwdref;
|
|
|
120 &renameref;
|
|
|
121 &saveref;
|
|
|
122 &setimeref;
|
|
|
123 &setprref;
|
|
|
124 &shellref;
|
|
|
125 &sleepref;
|
|
|
126 &teeref;
|
|
|
127 &tmoderef;
|
|
|
128 &tsmonref;
|
|
153
|
129 &tuneportref;
|
|
146
|
130 &unlinkref;
|
|
|
131 &verifyref;
|
|
|
132 &xmoderef;
|
|
153
|
133
|
|
146
|
134 </section>
|
|
|
135 </chapter>
|
