1 058b0118 2005-01-03 devnull .TH ACME 4
3 058b0118 2005-01-03 devnull acme \- control files for text windows
4 058b0118 2005-01-03 devnull .SH SYNOPSIS
8 058b0118 2005-01-03 devnull .I varfont
11 058b0118 2005-01-03 devnull .I fixfont
16 058b0118 2005-01-03 devnull .SH DESCRIPTION
17 058b0118 2005-01-03 devnull The text window system
18 058b0118 2005-01-03 devnull .IR acme (1)
19 058b0118 2005-01-03 devnull serves a variety of files for reading, writing, and controlling
21 058b0118 2005-01-03 devnull Some of them are virtual versions of system files for dealing
22 058b0118 2005-01-03 devnull with the virtual console; others control operations
26 058b0118 2005-01-03 devnull When a command is run under
27 058b0118 2005-01-03 devnull .IR acme ,
28 058b0118 2005-01-03 devnull a directory holding these files is mounted on
29 058b0118 2005-01-03 devnull .B /mnt/acme
30 058b0118 2005-01-03 devnull (also bound to
31 058b0118 2005-01-03 devnull .BR /mnt/wsys )
33 058b0118 2005-01-03 devnull .BR /dev ;
34 058b0118 2005-01-03 devnull the files mentioned here
35 058b0118 2005-01-03 devnull appear in both those directories.
37 058b0118 2005-01-03 devnull Some of these files supply virtual versions of services available from the underlying
38 058b0118 2005-01-03 devnull environment, in particular the character terminal files in Plan 9's
39 058b0118 2005-01-03 devnull \fIcons\fR(3).
40 058b0118 2005-01-03 devnull (Unlike in Plan 9's \fIrio\fR(1),
41 058b0118 2005-01-03 devnull each command under
43 058b0118 2005-01-03 devnull sees the same set of files; there is not a distinct
44 058b0118 2005-01-03 devnull .B /dev/cons
45 058b0118 2005-01-03 devnull for each window.)
46 058b0118 2005-01-03 devnull Other files are unique to
47 058b0118 2005-01-03 devnull .IR acme .
50 058b0118 2005-01-03 devnull is a subdirectory used by
53 058b0118 2005-01-03 devnull .IR acme (1))
54 058b0118 2005-01-03 devnull as a mount point for the
56 058b0118 2005-01-03 devnull files associated with the window in which
58 058b0118 2005-01-03 devnull is running.
59 058b0118 2005-01-03 devnull It has no specific function under
64 058b0118 2005-01-03 devnull is the standard and diagnostic output file for all commands
65 058b0118 2005-01-03 devnull run under
66 058b0118 2005-01-03 devnull .IR acme .
67 058b0118 2005-01-03 devnull (Input for commands is redirected to
68 058b0118 2005-01-03 devnull .BR /dev/null .)
69 058b0118 2005-01-03 devnull Text written to
71 058b0118 2005-01-03 devnull appears in a window labeled
72 058b0118 2005-01-03 devnull .IB dir /+Errors\f1,
75 058b0118 2005-01-03 devnull is the directory in which the command
77 058b0118 2005-01-03 devnull The window is created if necessary, but not until text is actually written.
79 058b0118 2005-01-03 devnull .B consctl
80 058b0118 2005-01-03 devnull Is an empty unwritable file present only for compatibility; there is no way
81 058b0118 2005-01-03 devnull to turn off `echo', for example, under
82 058b0118 2005-01-03 devnull .IR acme .
85 058b0118 2005-01-03 devnull holds a sequence of lines of text, one per window. Each line has 5 decimal numbers,
86 058b0118 2005-01-03 devnull each formatted in 11 characters plus a blank\(emthe window ID;
87 058b0118 2005-01-03 devnull number of characters (runes) in the tag;
88 058b0118 2005-01-03 devnull number of characters in the body;
89 058b0118 2005-01-03 devnull a 1 if the window is a directory, 0 otherwise;
90 058b0118 2005-01-03 devnull and a 1 if the window is modified, 0
91 058b0118 2005-01-03 devnull otherwise\(emfollowed by the tag up to a newline if present.
92 058b0118 2005-01-03 devnull Thus at character position 5×12 starts the name of the window.
93 058b0118 2005-01-03 devnull If a file has multiple zeroxed windows open,
94 058b0118 2005-01-03 devnull only the most recently used will appear in the
99 058b0118 2005-01-03 devnull is an empty file, writable without effect, present only for compatibility with
100 058b0118 2005-01-03 devnull .BR rio .
103 058b0118 2005-01-03 devnull A directory analogous to the numbered directories
104 058b0118 2005-01-03 devnull .RI ( q.v. ).
105 058b0118 2005-01-03 devnull Accessing any
108 058b0118 2005-01-03 devnull creates a new window. Thus to cause text to appear in a new window,
109 058b0118 2005-01-03 devnull write it to
110 058b0118 2005-01-03 devnull .BR /dev/new/body .
111 058b0118 2005-01-03 devnull For more control, open
112 058b0118 2005-01-03 devnull .BR /dev/new/ctl
113 058b0118 2005-01-03 devnull and use the interface described below.
118 058b0118 2005-01-03 devnull window has associated a directory numbered by its ID.
119 058b0118 2005-01-03 devnull Window IDs are chosen sequentially and may be discovered by the
121 058b0118 2005-01-03 devnull command, by
122 058b0118 2005-01-03 devnull reading the
124 058b0118 2005-01-03 devnull file, or
125 058b0118 2005-01-03 devnull indirectly through the
126 058b0118 2005-01-03 devnull .B index
127 058b0118 2005-01-03 devnull file. The files in the numbered directories are as follows.
130 058b0118 2005-01-03 devnull may be written with any textual address (line number, regular expression, etc.),
131 058b0118 2005-01-03 devnull in the format understood by button 3 but without the initial colon, including compound addresses,
132 058b0118 2005-01-03 devnull to set the address for text accessed through the
135 058b0118 2005-01-03 devnull When read, it returns the value of the address that would next be read
136 058b0118 2005-01-03 devnull or written through the
138 058b0118 2005-01-03 devnull file, in the format
139 058b0118 2005-01-03 devnull .BI # m ,# n
144 058b0118 2005-01-03 devnull are character (not byte) offsets. If
148 058b0118 2005-01-03 devnull are identical, the format is just
149 058b0118 2005-01-03 devnull .BI # m\f1.
150 058b0118 2005-01-03 devnull Thus a regular expression may be evaluated by writing it to
152 058b0118 2005-01-03 devnull and reading it back.
155 058b0118 2005-01-03 devnull address has no effect on the user's selection of text.
158 058b0118 2005-01-03 devnull holds contents of the window body. It may be read at any byte offset.
159 058b0118 2005-01-03 devnull Text written to
161 058b0118 2005-01-03 devnull is always appended; the file offset is ignored.
164 058b0118 2005-01-03 devnull may be read to recover the five numbers as held in the
165 058b0118 2005-01-03 devnull .B index
166 058b0118 2005-01-03 devnull file, described above, plus two more fields: the width of the
167 058b0118 2005-01-03 devnull window in pixels and the name of the font used in the window.
168 058b0118 2005-01-03 devnull Text messages may be written to
170 058b0118 2005-01-03 devnull to affect the window.
171 058b0118 2005-01-03 devnull Each message is terminated by a newline and multiple
172 058b0118 2005-01-03 devnull messages may be sent in a single write.
174 058b0118 2005-01-03 devnull .TF limit=addr
176 058b0118 2005-01-03 devnull .B addr=dot
179 058b0118 2005-01-03 devnull address to that of the user's selected text in the window.
181 058b0118 2005-01-03 devnull .B clean
182 058b0118 2005-01-03 devnull Mark the window clean as though it has just been written.
184 058b0118 2005-01-03 devnull .B dirty
185 058b0118 2005-01-03 devnull Mark the window dirty, the opposite of clean.
187 058b0118 2005-01-03 devnull .B cleartag
188 058b0118 2005-01-03 devnull Remove all text in the tag after the vertical bar.
191 058b0118 2005-01-03 devnull Equivalent to the
193 058b0118 2005-01-03 devnull interactive command.
195 058b0118 2005-01-03 devnull .B delete
196 058b0118 2005-01-03 devnull Equivalent to the
197 058b0118 2005-01-03 devnull .B Delete
198 058b0118 2005-01-03 devnull interactive command.
200 058b0118 2005-01-03 devnull .B dot=addr
201 058b0118 2005-01-03 devnull Set the user's selected text in the window to the text addressed by the
203 058b0118 2005-01-03 devnull address.
205 058b0118 2005-01-03 devnull .BI dump " command
206 058b0118 2005-01-03 devnull Set the command string to recreate the window from a dump file.
208 058b0118 2005-01-03 devnull .BI dumpdir " directory
209 058b0118 2005-01-03 devnull Set the directory in which to run the command to recreate the window from a dump file.
212 058b0118 2005-01-03 devnull Equivalent to the
214 058b0118 2005-01-03 devnull interactive command with no arguments; accepts no arguments.
216 058b0118 2005-01-03 devnull .B limit=addr
217 058b0118 2005-01-03 devnull When the
219 058b0118 2005-01-03 devnull file is first opened, regular expression context searches in
221 058b0118 2005-01-03 devnull addresses examine the whole file; this message restricts subsequent
222 058b0118 2005-01-03 devnull searches to the current
224 058b0118 2005-01-03 devnull address.
228 058b0118 2005-01-03 devnull .BR nomark ,
229 058b0118 2005-01-03 devnull returning the window to the usual state wherein each modification to the
230 058b0118 2005-01-03 devnull body must be undone individually.
232 058b0118 2005-01-03 devnull .BI name " name
233 058b0118 2005-01-03 devnull Set the name of the window to
234 058b0118 2005-01-03 devnull .IR name .
236 058b0118 2005-01-03 devnull .B nomark
237 058b0118 2005-01-03 devnull Turn off automatic `marking' of changes, so a set of related changes
238 058b0118 2005-01-03 devnull may be undone in a single
240 058b0118 2005-01-03 devnull interactive command.
242 058b0118 2005-01-03 devnull .B noscroll
243 058b0118 2005-01-03 devnull Turn off automatic `scrolling' of the window to show text written to the body.
246 058b0118 2005-01-03 devnull Equivalent to the
248 058b0118 2005-01-03 devnull interactive command with no arguments; accepts no arguments.
250 058b0118 2005-01-03 devnull .B scroll
251 058b0118 2005-01-03 devnull Cancel a
252 058b0118 2005-01-03 devnull .B noscroll
253 058b0118 2005-01-03 devnull message, returning the window to the default state wherein each write
256 058b0118 2005-01-03 devnull file causes the window to `scroll' to display the new text.
259 058b0118 2005-01-03 devnull Guarantee at least some of the selected text is visible on the display.
264 058b0118 2005-01-03 devnull is used in conjunction with
266 058b0118 2005-01-03 devnull for random access to the contents of the body.
267 058b0118 2005-01-03 devnull The file offset is ignored when writing the
269 058b0118 2005-01-03 devnull file; instead the location of the data to be read or written is determined by the state of the
272 058b0118 2005-01-03 devnull Text, which must contain only whole characters (no `partial runes'),
273 058b0118 2005-01-03 devnull written to
275 058b0118 2005-01-03 devnull replaces the characters addressed by the
277 058b0118 2005-01-03 devnull file and sets the address to the null string at the end of the written text.
278 058b0118 2005-01-03 devnull A read from
280 058b0118 2005-01-03 devnull returns as many whole characters as the read count will permit starting
281 058b0118 2005-01-03 devnull at the beginning of the
283 058b0118 2005-01-03 devnull address (the end of the address has no effect)
284 058b0118 2005-01-03 devnull and sets the address to the null string at the end of the returned
285 058b0118 2005-01-03 devnull characters.
287 058b0118 2005-01-03 devnull .B event
288 058b0118 2005-01-03 devnull When a window's
289 058b0118 2005-01-03 devnull .B event
290 058b0118 2005-01-03 devnull file is open, changes to the window occur as always but the
291 058b0118 2005-01-03 devnull actions are also reported as
292 058b0118 2005-01-03 devnull messages to the reader of the file. Also, user actions with buttons 2 and 3
293 058b0118 2005-01-03 devnull (other than chorded
296 058b0118 2005-01-03 devnull .BR Paste ,
297 058b0118 2005-01-03 devnull which behave normally) have no immediate effect on the window;
298 058b0118 2005-01-03 devnull it is expected that the program reading the
299 058b0118 2005-01-03 devnull .B event
300 058b0118 2005-01-03 devnull file will interpret them.
301 058b0118 2005-01-03 devnull The messages have a fixed format:
302 058b0118 2005-01-03 devnull a character indicating the origin or cause of the action,
303 058b0118 2005-01-03 devnull a character indicating the type of the action,
304 058b0118 2005-01-03 devnull four free-format blank-terminated decimal numbers,
305 058b0118 2005-01-03 devnull optional text, and a newline.
306 058b0118 2005-01-03 devnull The first and second numbers are the character addresses of the action,
307 058b0118 2005-01-03 devnull the third is a flag,
308 058b0118 2005-01-03 devnull and the final is a count of the characters in the optional text, which
309 058b0118 2005-01-03 devnull may itself contain newlines.
310 058b0118 2005-01-03 devnull The origin characters are
312 058b0118 2005-01-03 devnull for writes to the
318 058b0118 2005-01-03 devnull for actions through the window's other files,
320 058b0118 2005-01-03 devnull for the keyboard, and
322 058b0118 2005-01-03 devnull for the mouse.
323 058b0118 2005-01-03 devnull The type characters are
325 058b0118 2005-01-03 devnull for text deleted from the body,
327 058b0118 2005-01-03 devnull for text deleted from the tag,
329 058b0118 2005-01-03 devnull for text inserted to the body,
331 058b0118 2005-01-03 devnull for text inserted to the tag,
333 058b0118 2005-01-03 devnull for a button 3 action in the body,
335 058b0118 2005-01-03 devnull for a button 3 action in the tag,
337 058b0118 2005-01-03 devnull for a button 2 action in the body, and
339 058b0118 2005-01-03 devnull for a button 2 action in the tag.
341 058b0118 2005-01-03 devnull If the relevant text has less than 256 characters, it is included in the message;
342 058b0118 2005-01-03 devnull otherwise it is elided, the fourth number is 0, and the program must read
343 058b0118 2005-01-03 devnull it from the
345 058b0118 2005-01-03 devnull file if needed. No text is sent on a
349 058b0118 2005-01-03 devnull message.
357 058b0118 2005-01-03 devnull the flag is always zero.
362 058b0118 2005-01-03 devnull the flag is a bitwise OR (reported decimally) of the following:
363 058b0118 2005-01-03 devnull 1 if the text indicated is recognized as an
365 058b0118 2005-01-03 devnull built-in command;
366 058b0118 2005-01-03 devnull 2 if the text indicated is a null string that has a non-null expansion;
367 058b0118 2005-01-03 devnull if so, another complete message will follow describing the expansion
368 058b0118 2005-01-03 devnull exactly as if it had been indicated explicitly (its flag will always be 0);
369 058b0118 2005-01-03 devnull 8 if the command has an extra (chorded) argument; if so,
370 058b0118 2005-01-03 devnull two more complete messages will follow reporting the argument (with
371 058b0118 2005-01-03 devnull all numbers 0 except the character count) and where it originated, in the form of
372 058b0118 2005-01-03 devnull a fully-qualified button 3 style address.
378 058b0118 2005-01-03 devnull the flag is the bitwise OR of the following:
381 058b0118 2005-01-03 devnull can interpret the action without loading a new file;
382 058b0118 2005-01-03 devnull 2 if a second (post-expansion) message follows, analogous to that with
384 058b0118 2005-01-03 devnull messages;
385 058b0118 2005-01-03 devnull 4 if the text is a file or window name (perhaps with address) rather than
386 058b0118 2005-01-03 devnull plain literal text.
388 058b0118 2005-01-03 devnull For messages with the 1 bit on in the flag,
389 058b0118 2005-01-03 devnull writing the message back to the
390 058b0118 2005-01-03 devnull .B event
391 058b0118 2005-01-03 devnull file, but with the flag, count, and text omitted,
392 058b0118 2005-01-03 devnull will cause the action to be applied to the file exactly as it would
393 058b0118 2005-01-03 devnull have been if the
394 058b0118 2005-01-03 devnull .B event
395 058b0118 2005-01-03 devnull file had not been open.
398 058b0118 2005-01-03 devnull holds contents of the window tag. It may be read at any byte offset.
399 058b0118 2005-01-03 devnull Text written to
401 058b0118 2005-01-03 devnull is always appended; the file offset is ignored.
402 058b0118 2005-01-03 devnull .SH SOURCE
403 058b0118 2005-01-03 devnull .B /usr/local/plan9/src/cmd/acme
404 058b0118 2005-01-03 devnull .SH SEE ALSO
405 058b0118 2005-01-03 devnull .IR rio (1),
406 058b0118 2005-01-03 devnull .IR acme (1)
