3 acme \- control files for text windows
17 The text window system
19 serves a variety of files for reading, writing, and controlling
21 Some of them are virtual versions of system files for dealing
22 with the virtual console; others control operations
26 When a command is run under
28 a directory holding these files is mounted on
34 the files mentioned here
35 appear in both those directories.
37 Some of these files supply virtual versions of services available from the underlying
38 environment, in particular the character terminal files in Plan 9's
40 (Unlike in Plan 9's \fIrio\fR(1),
43 sees the same set of files; there is not a distinct
46 Other files are unique to
50 is a subdirectory used by
54 as a mount point for the
56 files associated with the window in which
59 It has no specific function under
64 is the standard and diagnostic output file for all commands
67 (Input for commands is redirected to
71 appears in a window labeled
75 is the directory in which the command
77 The window is created if necessary, but not until text is actually written.
80 Is an empty unwritable file present only for compatibility; there is no way
81 to turn off `echo', for example, under
85 holds a sequence of lines of text, one per window. Each line has 5 decimal numbers,
86 each formatted in 11 characters plus a blank\(emthe window ID;
87 number of characters (runes) in the tag;
88 number of characters in the body;
89 a 1 if the window is a directory, 0 otherwise;
90 and a 1 if the window is modified, 0
91 otherwise\(emfollowed by the tag up to a newline if present.
92 Thus at character position 5×12 starts the name of the window.
93 If a file has multiple zeroxed windows open,
94 only the most recently used will appear in the
99 is an empty file, writable without effect, present only for compatibility with
103 A directory analogous to the numbered directories
108 creates a new window. Thus to cause text to appear in a new window,
111 For more control, open
113 and use the interface described below.
118 window has associated a directory numbered by its ID.
119 Window IDs are chosen sequentially and may be discovered by the
125 indirectly through the
127 file. The files in the numbered directories are as follows.
130 may be written with any textual address (line number, regular expression, etc.),
131 in the format understood by button 3 but without the initial colon, including compound addresses,
132 to set the address for text accessed through the
135 When read, it returns the value of the address that would next be read
136 or written through the
144 are character (not byte) offsets. If
148 are identical, the format is just
150 Thus a regular expression may be evaluated by writing it to
155 address has no effect on the user's selection of text.
158 holds contents of the window body. It may be read at any byte offset.
161 is always appended; the file offset is ignored.
164 may be read to recover the five numbers as held in the
166 file, described above, plus two more fields: the width of the
167 window in pixels and the name of the font used in the window.
168 Text messages may be written to
170 to affect the window.
171 Each message is terminated by a newline and multiple
172 messages may be sent in a single write.
179 address to that of the user's selected text in the window.
182 Mark the window clean as though it has just been written.
185 Mark the window dirty, the opposite of clean.
188 Remove all text in the tag after the vertical bar.
201 Set the user's selected text in the window to the text addressed by the
206 Set the command string to recreate the window from a dump file.
208 .BI dumpdir " directory
209 Set the directory in which to run the command to recreate the window from a dump file.
214 interactive command with no arguments; accepts no arguments.
219 file is first opened, regular expression context searches in
221 addresses examine the whole file; this message restricts subsequent
222 searches to the current
229 returning the window to the usual state wherein each modification to the
230 body must be undone individually.
233 Set the name of the window to
237 Turn off automatic `marking' of changes, so a set of related changes
238 may be undone in a single
243 Turn off automatic `scrolling' of the window to show text written to the body.
248 interactive command with no arguments; accepts no arguments.
253 message, returning the window to the default state wherein each write
256 file causes the window to `scroll' to display the new text.
259 Guarantee at least some of the selected text is visible on the display.
264 is used in conjunction with
266 for random access to the contents of the body.
267 The file offset is ignored when writing the
269 file; instead the location of the data to be read or written is determined by the state of the
272 Text, which must contain only whole characters (no `partial runes'),
275 replaces the characters addressed by the
277 file and sets the address to the null string at the end of the written text.
280 returns as many whole characters as the read count will permit starting
281 at the beginning of the
283 address (the end of the address has no effect)
284 and sets the address to the null string at the end of the returned
290 file is open, changes to the window occur as always but the
291 actions are also reported as
292 messages to the reader of the file. Also, user actions with buttons 2 and 3
297 which behave normally) have no immediate effect on the window;
298 it is expected that the program reading the
300 file will interpret them.
301 The messages have a fixed format:
302 a character indicating the origin or cause of the action,
303 a character indicating the type of the action,
304 four free-format blank-terminated decimal numbers,
305 optional text, and a newline.
306 The first and second numbers are the character addresses of the action,
308 and the final is a count of the characters in the optional text, which
309 may itself contain newlines.
310 The origin characters are
318 for actions through the window's other files,
320 for the keyboard, and
323 The type characters are
325 for text deleted from the body,
327 for text deleted from the tag,
329 for text inserted to the body,
331 for text inserted to the tag,
333 for a button 3 action in the body,
335 for a button 3 action in the tag,
337 for a button 2 action in the body, and
339 for a button 2 action in the tag.
341 If the relevant text has less than 256 characters, it is included in the message;
342 otherwise it is elided, the fourth number is 0, and the program must read
345 file if needed. No text is sent on a
357 the flag is always zero.
362 the flag is a bitwise OR (reported decimally) of the following:
363 1 if the text indicated is recognized as an
366 2 if the text indicated is a null string that has a non-null expansion;
367 if so, another complete message will follow describing the expansion
368 exactly as if it had been indicated explicitly (its flag will always be 0);
369 8 if the command has an extra (chorded) argument; if so,
370 two more complete messages will follow reporting the argument (with
371 all numbers 0 except the character count) and where it originated, in the form of
372 a fully-qualified button 3 style address.
378 the flag is the bitwise OR of the following:
381 can interpret the action without loading a new file;
382 2 if a second (post-expansion) message follows, analogous to that with
385 4 if the text is a file or window name (perhaps with address) rather than
388 For messages with the 1 bit on in the flag,
389 writing the message back to the
391 file, but with the flag, count, and text omitted,
392 will cause the action to be applied to the file exactly as it would
395 file had not been open.
398 holds contents of the window tag. It may be read at any byte offset.
401 is always appended; the file offset is ignored.
403 .B /usr/local/plan9/src/cmd/acme
