annotate docs/nitros9guide/xmode.refentry @ 2624:b8c7b7fbf3c9

Major changes: o os9defs, rbfdefs, scfdefs now os9.d, rbf.d, and scf.d o vtiodefs now broken into cocovtio.d (for coco and dragon) and atarivtio.d o systype now broken into coco.d, dragon.d and atari.d o all references to the above in other files have changed
author Boisy Pitre <boisy.pitre@nuance.com>
date Fri, 24 Feb 2012 08:51:08 -0600
parents 4dae346c4969
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
141
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
1 <refentry id="xmode">
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
2 <refnamediv>
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
3 <refname>XMODE</refname>
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
4 <refpurpose>Examine or Change Device Initialization Mode</refpurpose>
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
5 </refnamediv>
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
6
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
7 <refsynopsisdiv>
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
8 <cmdsynopsis>
1093
4dae346c4969 Added crossreferences and lowercased synopsises
roug
parents: 1092
diff changeset
9 <command>xmode</command>
975
c565a4700689 The entitity replstart was replaced with <replaceable>
roug
parents: 648
diff changeset
10 <arg choice="plain"><replaceable>devname</replaceable></arg>
c565a4700689 The entitity replstart was replaced with <replaceable>
roug
parents: 648
diff changeset
11 <arg choice="opt"><replaceable>arglist</replaceable></arg>
141
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
12 </cmdsynopsis>
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
13 </refsynopsisdiv>
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
14
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
15 <refsect1><title>Description</title>
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
16 <para>
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
17 This command is used to display or change the initialization
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
18 parameters of any SCF-type device such as the video display,
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
19 printer, RS232 port, etc. A common use is to change baud rates,
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
20 control key definitions, etc.
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
21 </para>
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
22 <para>
1053
b5ff125a1d60 Since this book was only typeset in fixed width, single-font, they used
roug
parents: 975
diff changeset
23 <command>Xmode</command> is very similar to the <command>tmode</command> command.
b5ff125a1d60 Since this book was only typeset in fixed width, single-font, they used
roug
parents: 975
diff changeset
24 <command>Tmode</command> only operates on
b5ff125a1d60 Since this book was only typeset in fixed width, single-font, they used
roug
parents: 975
diff changeset
25 open paths so its effect is temporary. <command>Xmode</command> actually updates the
141
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
26 device descriptor so the change persists as long as the computer is
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
27 running, even if paths to the device are repetitively opened and
1093
4dae346c4969 Added crossreferences and lowercased synopsises
roug
parents: 1092
diff changeset
28 closed. If <command>xmode</command> is used to change parameter(s) and the <command>cobbler</command>
141
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
29 program is used to make a new system disk, the changed parameter
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
30 will be permanently reflected on the new system disk.
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
31 </para>
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
32 <para>
1053
b5ff125a1d60 Since this book was only typeset in fixed width, single-font, they used
roug
parents: 975
diff changeset
33 <command>Xmode</command> requires a device name to be given. If no arguments are
141
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
34 given, the present values for each parameter are displayed,
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
35 otherwise, the parameter(s) given in the argument list are
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
36 processed. Any number of parameters can be given, and are separated
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
37 by spaces or commas.
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
38 </para>
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
39
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
40 </refsect1>
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
41 <refsect1><title>XMODE Parameter Names</title>
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
42
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
43 <informaltable frame="none">
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
44 <tgroup cols="2">
648
f9c66ad345d1 XMLified.
roug
parents: 141
diff changeset
45 <colspec colwidth="1in"/>
f9c66ad345d1 XMLified.
roug
parents: 141
diff changeset
46 <colspec colwidth="4in"/>
141
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
47 <tbody>
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
48 <row>
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
49 <entry>upc</entry>
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
50 <entry>Upper case only. Lower case characters are automatically
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
51 converted to upper case.</entry>
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
52 </row>
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
53 <row>
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
54 <entry>-upc</entry>
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
55 <entry>Upper case and lower case characters permitted (default).</entry>
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
56 </row>
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
57 <row>
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
58 <entry>bsb</entry>
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
59 <entry>Erase on backspace: backspace characters echoed as a
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
60 backspace-space-backspace sequence (default).</entry>
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
61 </row>
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
62 <row>
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
63 <entry>-bsb</entry>
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
64 <entry>no erase on backspace: echoes single backspace only</entry>
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
65 </row>
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
66 <row>
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
67 <entry>bsl</entry>
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
68 <entry>Backspace over line: lines are &quot;deleted&quot; by sending
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
69 backspace-space-backspace sequences to erase the same
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
70 line (for video terminals) (default).</entry>
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
71 </row>
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
72 <row>
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
73 <entry>-bsl</entry>
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
74 <entry>No backspace over line: lines are &quot;deleted&quot; by printing
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
75 a new line sequence (for hard-copy terminals).
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
76 echo Input characters &quot;echoed&quot; back to terminal (default)</entry>
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
77 </row>
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
78 <row>
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
79 <entry>-echo</entry>
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
80 <entry>No echo</entry>
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
81 </row>
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
82 <row>
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
83 <entry>lf</entry>
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
84 <entry>Auto line feed on: line feeds automatically echoed to
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
85 terminal on input and output carriage returns (default).</entry>
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
86 </row>
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
87 <row>
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
88 <entry>-lf</entry>
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
89 <entry>Auto line feed off.</entry>
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
90 </row>
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
91 <row>
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
92 <entry>pause</entry>
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
93 <entry>Screen pause on: output suspended upon full screen. See
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
94 &quot;pag&quot; parameter for definition of screen size. Output
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
95 can be resumed by typing any key.</entry>
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
96 </row>
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
97 <row>
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
98 <entry>-pause</entry>
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
99 <entry>Screen pause mode off.</entry>
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
100 </row>
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
101 <row>
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
102 <entry>null=n</entry>
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
103 <entry>Set null count: number of null ($00) characters
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
104 transmitted after carriage returns for return delay.
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
105 The number is decimal, default = 0.</entry>
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
106 </row>
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
107 <row>
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
108 <entry>pag=n</entry>
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
109 <entry>Set video display page length to n (decimal) lines.
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
110 Used for &quot;pause&quot; mode, see above.</entry>
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
111 </row>
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
112 <row>
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
113 <entry>bsp=h</entry>
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
114 <entry>Set input backspace character. Numeric value of
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
115 character in hexadecimal. Default = 08.</entry>
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
116 </row>
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
117 <row>
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
118 <entry>bse=h</entry>
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
119 <entry>Set output backspace character. Numeric value of
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
120 character in hexadecimal. Default = 08.</entry>
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
121 </row>
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
122 <row>
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
123 <entry>del=h</entry>
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
124 <entry>Set input delete line character. Numeric value of
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
125 character in hexadecimal. Default = 18.</entry>
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
126 </row>
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
127 <row>
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
128 <entry>bell=h</entry>
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
129 <entry>Set bell (alert) output character. Numeric value of
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
130 character in hexadecimal. Default = 07</entry>
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
131 </row>
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
132 <row>
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
133 <entry>eor=h</entry>
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
134 <entry>Set end-of-record (carriage return) input character.
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
135 Numeric value of character in hexadecimal. Default = 0D</entry>
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
136 </row>
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
137 <row>
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
138 <entry>eof=h</entry>
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
139 <entry>Set end-of-file input character. Numeric value of
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
140 character in hexadecimal. Default 1B.</entry>
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
141 </row>
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
142 <row>
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
143 <entry>type=h</entry>
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
144 <entry>ACIA initialization value: sets parity, word size, etc.
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
145 Value in hexadecimal. Default 15</entry>
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
146 </row>
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
147 <row>
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
148 <entry>reprint=h</entry>
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
149 <entry>Reprint line character. Numeric value of character
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
150 in hexadecimal.</entry>
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
151 </row>
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
152 <row>
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
153 <entry>dup=h</entry>
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
154 <entry>Duplicate last input line character. Numeric value of
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
155 character in hexadecimal.</entry>
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
156 </row>
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
157 <row>
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
158 <entry>psc=h</entry>
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
159 <entry>Pause character. Numeric value of character in
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
160 hexadecimal.</entry>
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
161 </row>
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
162 <row>
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
163 <entry>abort=h</entry>
1092
f5d45fbe3a76 <keycap> elements
roug
parents: 1053
diff changeset
164 <entry>Abort character (normally <keycombo action="simul"><keycap>Control</keycap>
f5d45fbe3a76 <keycap> elements
roug
parents: 1053
diff changeset
165 <keycap>C</keycap></keycombo>). Numeric value
141
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
166 of character in hexadecimal.</entry>
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
167 </row>
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
168 <row>
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
169 <entry>quit=h</entry>
1092
f5d45fbe3a76 <keycap> elements
roug
parents: 1053
diff changeset
170 <entry>Quit character (normally <keycombo action="simul"><keycap>Control</keycap>
f5d45fbe3a76 <keycap> elements
roug
parents: 1053
diff changeset
171 <keycap>E</keycap></keycombo>). Numeric value
141
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
172 of character in hexadecimal.</entry>
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
173 </row>
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
174 <row>
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
175 <entry>baud=d</entry>
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
176 <entry>Set baud rate for software-controllable interface. Numeric
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
177 code for baud rate: 0=110 1=300 2=600 3=1200 4=2400 5=4800
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
178 6=9600 7=19200</entry>
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
179 </row>
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
180 </tbody>
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
181 </tgroup>
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
182 </informaltable>
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
183 </refsect1>
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
184 <refsect1><title>Examples</title>
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
185 <screen>
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
186 xmode /TERM -upc lf null=4 bse=1F pause
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
187
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
188 xmode /T1 pag=24 pause bsl -echo bsp=8 bsl=C
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
189
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
190 xmode /P baud=3 -if
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
191 </screen>
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
192 </refsect1>
21649cf64510 Split up the commands into individual files.
roug
parents:
diff changeset
193 </refentry>