1 cfa37a7b 2004-04-10 devnull .TH ACME 1
3 cfa37a7b 2004-04-10 devnull acme, win, awd \- interactive text windows
4 cfa37a7b 2004-04-10 devnull .SH SYNOPSIS
11 cfa37a7b 2004-04-10 devnull .I varfont
15 cfa37a7b 2004-04-10 devnull .I fixfont
34 cfa37a7b 2004-04-10 devnull .I command
41 cfa37a7b 2004-04-10 devnull .SH DESCRIPTION
43 cfa37a7b 2004-04-10 devnull manages windows of text that may be edited interactively or by external programs.
44 cfa37a7b 2004-04-10 devnull The interactive interface uses the keyboard and mouse; external programs
45 cfa37a7b 2004-04-10 devnull use a set of files served by
46 cfa37a7b 2004-04-10 devnull .IR acme ;
47 cfa37a7b 2004-04-10 devnull these are discussed in
48 cfa37a7b 2004-04-10 devnull .IR acme (4).
50 cfa37a7b 2004-04-10 devnull Any named
52 cfa37a7b 2004-04-10 devnull are read into
54 cfa37a7b 2004-04-10 devnull windows before
56 cfa37a7b 2004-04-10 devnull accepts input.
59 cfa37a7b 2004-04-10 devnull option, the state of the entire system is loaded
61 cfa37a7b 2004-04-10 devnull .IR file ,
62 cfa37a7b 2004-04-10 devnull which should have been created by a
64 cfa37a7b 2004-04-10 devnull command (q.v.),
65 cfa37a7b 2004-04-10 devnull and subsequent
67 cfa37a7b 2004-04-10 devnull names are ignored.
68 cfa37a7b 2004-04-10 devnull Plain files display as text; directories display as columnated lists of the
69 cfa37a7b 2004-04-10 devnull names of their components, as in
70 cfa37a7b 2004-04-10 devnull .B "ls -p directory|mc
71 cfa37a7b 2004-04-10 devnull except that the names of subdirectories have a slash appended.
75 cfa37a7b 2004-04-10 devnull .RB ( -F )
76 cfa37a7b 2004-04-10 devnull option sets the main font, usually variable-pitch (alternate, usually fixed-pitch);
77 cfa37a7b 2004-04-10 devnull the default is
78 b6372b09 2006-03-20 devnull .B \*9/font/lucsans/euro.8.font
79 cfa37a7b 2004-04-10 devnull .RB ( \&.../lucm/unicode.9.font ).
80 cfa37a7b 2004-04-10 devnull Tab intervals are set to the width of 4 (or the value of
81 cfa37a7b 2004-04-10 devnull .BR $tabstop )
82 cfa37a7b 2004-04-10 devnull numeral zeros in the appropriate font.
86 6bcc5ae9 2008-04-17 rsc option instructs
88 6bcc5ae9 2008-04-17 rsc to use FUSE (see
89 6bcc5ae9 2008-04-17 rsc .IR 9pfuse (4))
90 6bcc5ae9 2008-04-17 rsc to mount itself at
92 6bcc5ae9 2008-04-17 rsc (Experimental.)
94 cfa37a7b 2004-04-10 devnull .SS Windows
96 cfa37a7b 2004-04-10 devnull windows are in two parts: a one-line
98 cfa37a7b 2004-04-10 devnull above a multi-line
99 cfa37a7b 2004-04-10 devnull .IR body .
100 cfa37a7b 2004-04-10 devnull The body typically contains an image of a file, as in
101 cfa37a7b 2004-04-10 devnull .IR sam (1),
102 cfa37a7b 2004-04-10 devnull or the output of a
103 cfa37a7b 2004-04-10 devnull program, as in an
104 cfa37a7b 2004-04-10 devnull .IR rio (1)
106 cfa37a7b 2004-04-10 devnull The tag contains a number of
107 cfa37a7b 2004-04-10 devnull blank-separated words, followed by a vertical bar character, followed by anything.
108 cfa37a7b 2004-04-10 devnull The first word is the name of the window, typically the name of the associated
109 cfa37a7b 2004-04-10 devnull file or directory, and the other words are commands available in that window.
110 cfa37a7b 2004-04-10 devnull Any text may be added after the bar; examples are strings to search for or
111 cfa37a7b 2004-04-10 devnull commands to execute in that window.
112 cfa37a7b 2004-04-10 devnull Changes to the text left of the bar will be ignored,
113 cfa37a7b 2004-04-10 devnull unless the result is to change the name of the
116 cfa37a7b 2004-04-10 devnull If a window holds a directory, the name (first word of the tag) will end with
117 cfa37a7b 2004-04-10 devnull a slash.
118 cfa37a7b 2004-04-10 devnull .SS Scrolling
119 cfa37a7b 2004-04-10 devnull Each window has a scroll bar to the left of the body.
120 cfa37a7b 2004-04-10 devnull The scroll bar behaves much as in
121 cfa37a7b 2004-04-10 devnull .IR sam (1)
123 cfa37a7b 2004-04-10 devnull .IR rio (1)
124 cfa37a7b 2004-04-10 devnull except that scrolling occurs when the button is pressed, rather than released,
125 cfa37a7b 2004-04-10 devnull and continues
126 cfa37a7b 2004-04-10 devnull as long as the mouse button is held down in the scroll bar.
127 cfa37a7b 2004-04-10 devnull For example, to scroll slowly through a file,
128 cfa37a7b 2004-04-10 devnull hold button 3 down near the top of the scroll bar. Moving the mouse
129 cfa37a7b 2004-04-10 devnull down the scroll bar speeds up the rate of scrolling.
130 a965f2ed 2005-01-10 devnull (The experimental option
132 a965f2ed 2005-01-10 devnull reverses the scrolling behavior of buttons 1 and 3, to behave
133 a965f2ed 2005-01-10 devnull more like
134 a965f2ed 2005-01-10 devnull .IR xterm (1).)
135 cfa37a7b 2004-04-10 devnull .SS Layout
137 cfa37a7b 2004-04-10 devnull windows are arranged in columns. By default, it creates two columns when starting;
138 cfa37a7b 2004-04-10 devnull this can be overridden with the
141 cfa37a7b 2004-04-10 devnull Placement is automatic but may be adjusted
142 cfa37a7b 2004-04-10 devnull using the
143 cfa37a7b 2004-04-10 devnull .I layout box
144 cfa37a7b 2004-04-10 devnull in the upper left corner of each window and column.
145 cfa37a7b 2004-04-10 devnull Pressing and holding any mouse button in the box drags
146 cfa37a7b 2004-04-10 devnull the associated window or column.
147 cfa37a7b 2004-04-10 devnull For windows, just
148 cfa37a7b 2004-04-10 devnull clicking in the layout box grows the window in place: button 1
149 cfa37a7b 2004-04-10 devnull grows it a little, button 2 grows it as much as it can, still leaving all other
150 cfa37a7b 2004-04-10 devnull tags in that column visible, and button 3 takes over the column completely,
151 cfa37a7b 2004-04-10 devnull temporarily hiding other windows in the column.
152 cfa37a7b 2004-04-10 devnull (They will return
153 cfa37a7b 2004-04-10 devnull .I en masse
154 cfa37a7b 2004-04-10 devnull if any of them needs attention.)
155 cfa37a7b 2004-04-10 devnull The layout box in a window is normally white; when it is black in the center,
156 cfa37a7b 2004-04-10 devnull it records that the file is `dirty':
158 cfa37a7b 2004-04-10 devnull believes it is modified from its original
159 cfa37a7b 2004-04-10 devnull contents.
161 cfa37a7b 2004-04-10 devnull Tags exist at the top of each column and across the whole display.
163 cfa37a7b 2004-04-10 devnull pre-loads them with useful commands.
164 cfa37a7b 2004-04-10 devnull Also, the tag across the top maintains a list of executing long-running commands.
165 cfa37a7b 2004-04-10 devnull .SS Typing
166 cfa37a7b 2004-04-10 devnull The behavior of typed text is similar to that in
167 cfa37a7b 2004-04-10 devnull .IR rio (1)
168 cfa37a7b 2004-04-10 devnull except that the characters are delivered to the tag or body under the mouse; there is no
169 cfa37a7b 2004-04-10 devnull `click to type'.
170 cfa37a7b 2004-04-10 devnull (The experimental option
172 cfa37a7b 2004-04-10 devnull causes typing to go to the most recently clicked-at or made window.)
173 cfa37a7b 2004-04-10 devnull The usual backspacing conventions apply.
175 cfa37a7b 2004-04-10 devnull .IR sam (1)
177 cfa37a7b 2004-04-10 devnull .IR rio ,
178 cfa37a7b 2004-04-10 devnull the ESC key selects the text typed since the last mouse action,
179 cfa37a7b 2004-04-10 devnull a feature particularly useful when executing commands.
180 cfa37a7b 2004-04-10 devnull A side effect is that typing ESC with text already selected is identical
184 cfa37a7b 2004-04-10 devnull .RI ( q.v. ).
186 cfa37a7b 2004-04-10 devnull Most text, including the names of windows, may be edited uniformly.
187 cfa37a7b 2004-04-10 devnull The only exception is that the command names to the
188 cfa37a7b 2004-04-10 devnull left of the bar in a tag are maintained automatically; changes to them are repaired
190 cfa37a7b 2004-04-10 devnull .IR acme .
192 b9771a80 2005-01-30 devnull When a window is in autoindent mode
193 b9771a80 2005-01-30 devnull (see the
194 b9771a80 2005-01-30 devnull .B Indent
195 b9771a80 2005-01-30 devnull command below) and a newline character is typed,
196 b9771a80 2005-01-30 devnull acme copies leading white space on the current line to the new line.
197 b9771a80 2005-01-30 devnull The option
199 b9771a80 2005-01-30 devnull causes each window to start in
200 b9771a80 2005-01-30 devnull autoindent mode.
201 cfa37a7b 2004-04-10 devnull .SS "Directory context
202 cfa37a7b 2004-04-10 devnull Each window's tag names a directory: explicitly if the window
203 cfa37a7b 2004-04-10 devnull holds a directory; implicitly if it holds a regular file
204 cfa37a7b 2004-04-10 devnull (e.g. the directory
206 cfa37a7b 2004-04-10 devnull if the window holds
207 cfa37a7b 2004-04-10 devnull .BR /adm/users ).
208 cfa37a7b 2004-04-10 devnull This directory provides a
209 cfa37a7b 2004-04-10 devnull .I context
210 cfa37a7b 2004-04-10 devnull for interpreting file names in that window.
211 cfa37a7b 2004-04-10 devnull For example, the string
212 cfa37a7b 2004-04-10 devnull .B users
213 cfa37a7b 2004-04-10 devnull in a window labeled
214 cfa37a7b 2004-04-10 devnull .B /adm/
216 cfa37a7b 2004-04-10 devnull .B /adm/keys
217 cfa37a7b 2004-04-10 devnull will be interpreted as the file name
218 cfa37a7b 2004-04-10 devnull .BR /adm/users .
219 cfa37a7b 2004-04-10 devnull The directory is defined purely textually, so it can be a non-existent
220 cfa37a7b 2004-04-10 devnull directory or a real directory associated with a non-existent file
222 cfa37a7b 2004-04-10 devnull .BR /adm/not-a-file ).
223 cfa37a7b 2004-04-10 devnull File names beginning with a slash
224 cfa37a7b 2004-04-10 devnull are assumed to be absolute file names.
225 cfa37a7b 2004-04-10 devnull .SS Errors
226 cfa37a7b 2004-04-10 devnull Windows whose names begin with
230 cfa37a7b 2004-04-10 devnull conventionally hold diagnostics and other data
231 cfa37a7b 2004-04-10 devnull not directly associated with files.
232 cfa37a7b 2004-04-10 devnull A window labeled
233 cfa37a7b 2004-04-10 devnull .B +Errors
234 cfa37a7b 2004-04-10 devnull receives all diagnostics produced by
237 cfa37a7b 2004-04-10 devnull Diagnostics from commands run by
239 cfa37a7b 2004-04-10 devnull appear in a window named
240 cfa37a7b 2004-04-10 devnull .IB directory /+Errors
242 cfa37a7b 2004-04-10 devnull .I directory
243 cfa37a7b 2004-04-10 devnull is identified by the context of the command.
244 cfa37a7b 2004-04-10 devnull These error windows are created when needed.
245 cfa37a7b 2004-04-10 devnull .SS "Mouse button 1
246 cfa37a7b 2004-04-10 devnull Mouse button 1 selects text just as in
247 cfa37a7b 2004-04-10 devnull .IR sam (1)
249 cfa37a7b 2004-04-10 devnull .IR rio (1) ,
250 cfa37a7b 2004-04-10 devnull including the usual double-clicking conventions.
251 cfa37a7b 2004-04-10 devnull .SS "Mouse button 2
253 cfa37a7b 2004-04-10 devnull action similar to selecting text with button 1,
254 cfa37a7b 2004-04-10 devnull button 2 indicates text to execute as a command.
255 cfa37a7b 2004-04-10 devnull If the indicated text has multiple white-space-separated words,
256 cfa37a7b 2004-04-10 devnull the first is the command name and the second and subsequent
257 cfa37a7b 2004-04-10 devnull are its arguments.
258 cfa37a7b 2004-04-10 devnull If button 2 is `clicked'\(emindicates a null string\(em\c
260 cfa37a7b 2004-04-10 devnull .I expands
261 cfa37a7b 2004-04-10 devnull the indicated text to find a command to run:
262 cfa37a7b 2004-04-10 devnull if the click is within button-1-selected text,
264 cfa37a7b 2004-04-10 devnull takes that selection as the command;
265 cfa37a7b 2004-04-10 devnull otherwise it takes the largest string of valid file name characters containing the click.
266 cfa37a7b 2004-04-10 devnull Valid file name characters are alphanumerics and
272 cfa37a7b 2004-04-10 devnull This behavior is similar to double-clicking with button 1 but,
273 cfa37a7b 2004-04-10 devnull because a null command is meaningless, only a single click is required.
275 cfa37a7b 2004-04-10 devnull Some commands, all by convention starting with a capital letter, are
276 cfa37a7b 2004-04-10 devnull .I built-ins
277 cfa37a7b 2004-04-10 devnull that are executed directly by
278 cfa37a7b 2004-04-10 devnull .IR acme :
281 cfa37a7b 2004-04-10 devnull Delete most recently selected text and place in snarf buffer.
284 cfa37a7b 2004-04-10 devnull Delete window. If window is dirty, instead print a warning; a second
286 cfa37a7b 2004-04-10 devnull will succeed.
288 cfa37a7b 2004-04-10 devnull .B Delcol
289 cfa37a7b 2004-04-10 devnull Delete column and all its windows, after checking that windows are not dirty.
291 cfa37a7b 2004-04-10 devnull .B Delete
292 cfa37a7b 2004-04-10 devnull Delete window without checking for dirtiness.
295 cfa37a7b 2004-04-10 devnull Write the state of
297 cfa37a7b 2004-04-10 devnull to the file name, if specified, or
298 cfa37a7b 2004-04-10 devnull .B $home/acme.dump
299 cfa37a7b 2004-04-10 devnull by default.
302 cfa37a7b 2004-04-10 devnull Treat the argument as a text editing command in the style of
303 cfa37a7b 2004-04-10 devnull .IR sam (1).
304 cfa37a7b 2004-04-10 devnull The full
306 cfa37a7b 2004-04-10 devnull language is implemented except for the commands
314 cfa37a7b 2004-04-10 devnull command is slightly different: it includes the file name and
315 cfa37a7b 2004-04-10 devnull gives only the line address unless the command is explicitly
316 cfa37a7b 2004-04-10 devnull .BR =# .
317 cfa37a7b 2004-04-10 devnull The `current window' for the command is the body of the window in which the
319 cfa37a7b 2004-04-10 devnull command is executed.
320 cfa37a7b 2004-04-10 devnull Usually the
322 cfa37a7b 2004-04-10 devnull command would be typed in a tag; longer commands may be prepared in a
323 cfa37a7b 2004-04-10 devnull scratch window and executed, with
325 cfa37a7b 2004-04-10 devnull itself in the current window, using the 2-1 chord described below.
330 cfa37a7b 2004-04-10 devnull after checking that windows are not dirty.
333 cfa37a7b 2004-04-10 devnull With no arguments, change the font of the associated window from fixed-spaced to
334 cfa37a7b 2004-04-10 devnull proportional-spaced or
336 cfa37a7b 2004-04-10 devnull .IR versa .
337 cfa37a7b 2004-04-10 devnull Given a file name argument, change the font of the window to that stored in the named file.
338 cfa37a7b 2004-04-10 devnull If the file name argument is prefixed by
340 cfa37a7b 2004-04-10 devnull .RB ( fix ),
341 cfa37a7b 2004-04-10 devnull also set the default proportional-spaced (fixed-spaced) font for future use to that font.
342 cfa37a7b 2004-04-10 devnull Other existing windows are unaffected.
345 cfa37a7b 2004-04-10 devnull Load file into window, replacing previous contents (after checking for dirtiness as in
346 cfa37a7b 2004-04-10 devnull .BR Del ).
347 cfa37a7b 2004-04-10 devnull With no argument, use the existing file name of the window.
348 cfa37a7b 2004-04-10 devnull Given an argument, use that file but do not change the window's file name.
351 cfa37a7b 2004-04-10 devnull Print window ID number
352 cfa37a7b 2004-04-10 devnull .RI ( q.v. ).
355 cfa37a7b 2004-04-10 devnull When opening `include' files
356 cfa37a7b 2004-04-10 devnull (those enclosed in
357 cfa37a7b 2004-04-10 devnull .BR <> )
358 cfa37a7b 2004-04-10 devnull with button 3,
360 cfa37a7b 2004-04-10 devnull searches in directories
361 cfa37a7b 2004-04-10 devnull .B /$objtype/include
363 cfa37a7b 2004-04-10 devnull .BR /sys/include .
365 cfa37a7b 2004-04-10 devnull adds its arguments to a supplementary list of include directories, analogous to
368 cfa37a7b 2004-04-10 devnull option to the compilers.
369 cfa37a7b 2004-04-10 devnull This list is per-window and is inherited when windows are created by actions in that window, so
371 cfa37a7b 2004-04-10 devnull is most usefully applied to a directory containing relevant source.
372 cfa37a7b 2004-04-10 devnull With no arguments,
374 cfa37a7b 2004-04-10 devnull prints the supplementary list.
375 cfa37a7b 2004-04-10 devnull This command is largely superseded by plumbing
377 058b0118 2005-01-03 devnull .IR plumb (7)).
379 b9771a80 2005-01-30 devnull .B Indent
380 b9771a80 2005-01-30 devnull Set the autoindent mode according to the argument:
384 b9771a80 2005-01-30 devnull set the mode for the current window;
388 9952c0eb 2007-06-15 devnull set the mode for all existing and future windows.
394 cfa37a7b 2004-04-10 devnull .IR acme -initiated
395 cfa37a7b 2004-04-10 devnull commands named as arguments.
398 b9771a80 2005-01-30 devnull Restore the state of
400 b9771a80 2005-01-30 devnull from a file (default
401 b9771a80 2005-01-30 devnull .BR $home/acme.dump )
402 b9771a80 2005-01-30 devnull created by the
404 b9771a80 2005-01-30 devnull command.
406 cfa37a7b 2004-04-10 devnull .B Local
407 058b0118 2005-01-03 devnull In the Plan 9
408 058b0118 2005-01-03 devnull .IR acme ,
409 058b0118 2005-01-03 devnull this prefix causes a command to be run in
410 058b0118 2005-01-03 devnull .IR acme 's own
411 058b0118 2005-01-03 devnull file name space and environment variable group.
412 058b0118 2005-01-03 devnull On Unix this is impossible.
413 058b0118 2005-01-03 devnull .B Local
414 058b0118 2005-01-03 devnull is recognized as a prefix, but has no effect on the command being executed.
416 058b0118 2005-01-03 devnull .\" .B Local
417 058b0118 2005-01-03 devnull .\" When prefixed to a command
418 058b0118 2005-01-03 devnull .\" run the
419 058b0118 2005-01-03 devnull .\" command in the same file name space and environment variable group as
420 058b0118 2005-01-03 devnull .\" .IR acme .
421 058b0118 2005-01-03 devnull .\" The environment of the command
422 058b0118 2005-01-03 devnull .\" is restricted but is sufficient to run
423 058b0118 2005-01-03 devnull .\" .IR bind (1),
424 058b0118 2005-01-03 devnull .\" .IR 9fs
425 058b0118 2005-01-03 devnull .\" (see
426 058b0118 2005-01-03 devnull .\" .IR srv (4)),
427 058b0118 2005-01-03 devnull .\" .IR import (4),
428 058b0118 2005-01-03 devnull .\" etc.,
429 058b0118 2005-01-03 devnull .\" and to set environment variables such as
430 058b0118 2005-01-03 devnull .\" .BR $objtype .
433 cfa37a7b 2004-04-10 devnull Search in body for occurrence of literal text indicated by the argument or,
434 cfa37a7b 2004-04-10 devnull if none is given, by the selected text in the body.
437 cfa37a7b 2004-04-10 devnull Make new window. With arguments, load the named files into windows.
439 cfa37a7b 2004-04-10 devnull .B Newcol
440 cfa37a7b 2004-04-10 devnull Make new column.
442 cfa37a7b 2004-04-10 devnull .B Paste
443 cfa37a7b 2004-04-10 devnull Replace most recently selected text with contents of snarf buffer.
446 cfa37a7b 2004-04-10 devnull Write window to the named file.
447 cfa37a7b 2004-04-10 devnull With no argument, write to the file named in the tag of the window.
449 cfa37a7b 2004-04-10 devnull .B Putall
450 cfa37a7b 2004-04-10 devnull Write all dirty windows whose names indicate existing regular files.
453 cfa37a7b 2004-04-10 devnull Complement of
454 cfa37a7b 2004-04-10 devnull .BR Undo .
457 cfa37a7b 2004-04-10 devnull Append selected text or snarf buffer to end of body; used mainly with
458 cfa37a7b 2004-04-10 devnull .IR win .
460 cfa37a7b 2004-04-10 devnull .B Snarf
461 cfa37a7b 2004-04-10 devnull Place selected text in snarf buffer.
464 cfa37a7b 2004-04-10 devnull Arrange the windows in the column from top to bottom in lexicographical
465 cfa37a7b 2004-04-10 devnull order based on their names.
468 cfa37a7b 2004-04-10 devnull Set the width of tab stops for this window to the value of the argument, in units of widths of the zero
469 cfa37a7b 2004-04-10 devnull character.
470 cfa37a7b 2004-04-10 devnull With no arguments, it prints the current value.
473 cfa37a7b 2004-04-10 devnull Undo last textual change or set of changes.
475 cfa37a7b 2004-04-10 devnull .B Zerox
476 cfa37a7b 2004-04-10 devnull Create a copy of the window containing most recently selected text.
479 91fb6aaa 2007-01-27 devnull If a regular shell command is preceded by a
484 91fb6aaa 2007-01-27 devnull character, the selected text in the body of the window is affected by the
485 91fb6aaa 2007-01-27 devnull I/O from the command.
488 91fb6aaa 2007-01-27 devnull character causes the selection to be replaced by the standard output
489 91fb6aaa 2007-01-27 devnull of the command;
491 91fb6aaa 2007-01-27 devnull causes the selection to be sent as standard input to the command; and
493 91fb6aaa 2007-01-27 devnull does both at once, `piping' the selection through the command and
494 91fb6aaa 2007-01-27 devnull replacing it with the output.
496 cfa37a7b 2004-04-10 devnull A common place to store text for commands is in the tag; in fact
498 cfa37a7b 2004-04-10 devnull maintains a set of commands appropriate to the state of the window
499 cfa37a7b 2004-04-10 devnull to the left of the bar in the tag.
501 cfa37a7b 2004-04-10 devnull If the text indicated with button 2 is not a recognized built-in, it is executed as
502 cfa37a7b 2004-04-10 devnull a shell command. For example, indicating
504 cfa37a7b 2004-04-10 devnull with button 2 runs
505 cfa37a7b 2004-04-10 devnull .IR date (1).
506 cfa37a7b 2004-04-10 devnull The standard
507 cfa37a7b 2004-04-10 devnull and error outputs of commands are sent to the error window associated with
508 cfa37a7b 2004-04-10 devnull the directory from which the command was run, which will be created if
509 cfa37a7b 2004-04-10 devnull necessary.
510 cfa37a7b 2004-04-10 devnull For example, in a window
511 c8b6342d 2005-01-13 devnull .B /etc/passwd
512 cfa37a7b 2004-04-10 devnull executing
514 cfa37a7b 2004-04-10 devnull will produce the output
516 cfa37a7b 2004-04-10 devnull in a (possibly newly-created) window labeled
517 c8b6342d 2005-01-13 devnull .BR /etc/+Errors ;
518 cfa37a7b 2004-04-10 devnull in a window containing
519 c8b6342d 2005-01-13 devnull .B /home/rob/sam/sam.c
520 cfa37a7b 2004-04-10 devnull executing
522 cfa37a7b 2004-04-10 devnull will run
523 cfa37a7b 2004-04-10 devnull .IR mk (1)
525 c8b6342d 2005-01-13 devnull .BR /home/rob/sam ,
526 cfa37a7b 2004-04-10 devnull producing output in a window labeled
527 c8b6342d 2005-01-13 devnull .BR /home/rob/sam/+Errors .
528 cfa37a7b 2004-04-10 devnull The environment of such commands contains the variable
532 c8b6342d 2005-01-13 devnull with value set to the filename of the window in which the command is run,
534 c8b6342d 2005-01-13 devnull .B $winid
535 c8b6342d 2005-01-13 devnull set to the window's id number
537 c8b6342d 2005-01-13 devnull .IR acme (4)).
539 81c2c5e7 2012-10-21 rsc The environment variable
540 81c2c5e7 2012-10-21 rsc .B $acmeshell
541 81c2c5e7 2012-10-21 rsc determines which shell is used to execute such commands; the
543 81c2c5e7 2012-10-21 rsc shell is used by default.
544 cfa37a7b 2004-04-10 devnull .SS "Mouse button 3
545 cfa37a7b 2004-04-10 devnull Pointing at text with button 3 instructs
547 cfa37a7b 2004-04-10 devnull to locate or acquire the file, string, etc. described by the indicated text and
548 cfa37a7b 2004-04-10 devnull its context.
549 cfa37a7b 2004-04-10 devnull This description follows the actions taken when
550 cfa37a7b 2004-04-10 devnull button 3 is released after sweeping out some text.
551 cfa37a7b 2004-04-10 devnull In the description,
553 cfa37a7b 2004-04-10 devnull refers to the text of the original sweep or, if it was null, the result of
554 cfa37a7b 2004-04-10 devnull applying the same expansion rules that apply to button 2 actions.
556 cfa37a7b 2004-04-10 devnull If the text names an existing window,
558 cfa37a7b 2004-04-10 devnull moves the mouse cursor to the selected text in the body of that window.
559 cfa37a7b 2004-04-10 devnull If the text names an existing file with no associated window,
561 cfa37a7b 2004-04-10 devnull loads the file into a new window and moves the mouse there.
562 cfa37a7b 2004-04-10 devnull If the text is a file name contained in angle brackets,
564 cfa37a7b 2004-04-10 devnull loads the indicated include file from the directory appropriate to the
565 cfa37a7b 2004-04-10 devnull suffix of the file name of the window holding the text.
568 cfa37a7b 2004-04-10 devnull command adds directories to the standard list.)
570 cfa37a7b 2004-04-10 devnull If the text begins with a colon, it is taken to be an address, in
571 cfa37a7b 2004-04-10 devnull the style of
572 cfa37a7b 2004-04-10 devnull .IR sam (1),
573 cfa37a7b 2004-04-10 devnull within the body of the window containing the text.
574 cfa37a7b 2004-04-10 devnull The address is evaluated, the resulting text highlighted, and the mouse moved to it.
575 cfa37a7b 2004-04-10 devnull Thus, in
576 cfa37a7b 2004-04-10 devnull .IR acme ,
577 cfa37a7b 2004-04-10 devnull one must type
578 cfa37a7b 2004-04-10 devnull .B :/regexp
581 cfa37a7b 2004-04-10 devnull not just
582 cfa37a7b 2004-04-10 devnull .B /regexp
584 cfa37a7b 2004-04-10 devnull .BR 127 .
585 cfa37a7b 2004-04-10 devnull (There is an easier way to locate literal text; see below.)
587 cfa37a7b 2004-04-10 devnull If the text is a file name followed by a colon and an address,
589 cfa37a7b 2004-04-10 devnull loads the file and evaluates the address. For example, clicking button 3 anywhere
590 cfa37a7b 2004-04-10 devnull in the text
591 cfa37a7b 2004-04-10 devnull .B file.c:27
592 cfa37a7b 2004-04-10 devnull will open
593 cfa37a7b 2004-04-10 devnull .BR file.c ,
594 cfa37a7b 2004-04-10 devnull select line
595 cfa37a7b 2004-04-10 devnull 27, and put the mouse at the beginning of the line. The rules about Error
596 cfa37a7b 2004-04-10 devnull files, directories, and so on all combine to make this an efficient way to
597 cfa37a7b 2004-04-10 devnull investigate errors from compilers, etc.
599 cfa37a7b 2004-04-10 devnull If the text is not an address or file, it is taken to
600 cfa37a7b 2004-04-10 devnull be literal text, which is then searched for in the body of the window
601 cfa37a7b 2004-04-10 devnull in which button 3 was clicked. If a match is found, it is selected and the mouse is
602 cfa37a7b 2004-04-10 devnull moved there. Thus, to search for occurrences of a word in a file,
603 cfa37a7b 2004-04-10 devnull just click button 3 on the word. Because of the rule of using the
604 cfa37a7b 2004-04-10 devnull selection as the button 3 action, subsequent clicks will find subsequent
605 cfa37a7b 2004-04-10 devnull occurrences without moving the mouse.
607 cfa37a7b 2004-04-10 devnull In all these actions, the mouse motion is not done if the text is a null string
608 cfa37a7b 2004-04-10 devnull within a non-null selected string in the tag, so that (for example) complex regular expressions
609 cfa37a7b 2004-04-10 devnull may be selected and applied repeatedly to the
610 cfa37a7b 2004-04-10 devnull body by just clicking button 3 over them.
611 cfa37a7b 2004-04-10 devnull .SS "Chords of mouse buttons
612 cfa37a7b 2004-04-10 devnull Several operations are bound to multiple-button actions.
613 cfa37a7b 2004-04-10 devnull After selecting text, with button 1 still down, pressing button 2
614 cfa37a7b 2004-04-10 devnull executes
616 cfa37a7b 2004-04-10 devnull and button 3 executes
617 cfa37a7b 2004-04-10 devnull .BR Paste .
618 cfa37a7b 2004-04-10 devnull After clicking one button, the other undoes
619 cfa37a7b 2004-04-10 devnull the first; thus (while holding down button 1) 2 followed by 3 is a
620 cfa37a7b 2004-04-10 devnull .B Snarf
621 cfa37a7b 2004-04-10 devnull that leaves the file undirtied;
622 cfa37a7b 2004-04-10 devnull 3 followed by 2 is a no-op.
623 cfa37a7b 2004-04-10 devnull These actions also apply to text selected by double-clicking because
624 cfa37a7b 2004-04-10 devnull the double-click expansion is made when the second
625 cfa37a7b 2004-04-10 devnull click starts, not when it ends.
627 cfa37a7b 2004-04-10 devnull Commands may be given extra arguments by a mouse chord with buttons 2 and 1.
628 cfa37a7b 2004-04-10 devnull While holding down button 2 on text to be executed as a command, clicking button 1
629 cfa37a7b 2004-04-10 devnull appends the text last pointed to by button 1 as a distinct final argument.
630 cfa37a7b 2004-04-10 devnull For example, to search for literal
632 cfa37a7b 2004-04-10 devnull one may execute
633 cfa37a7b 2004-04-10 devnull .B Look text
634 cfa37a7b 2004-04-10 devnull with button 2 or instead point at
636 cfa37a7b 2004-04-10 devnull with button 1 in any window, release button 1,
637 cfa37a7b 2004-04-10 devnull then execute
638 cfa37a7b 2004-04-10 devnull .BR Look ,
639 cfa37a7b 2004-04-10 devnull clicking button 1 while 2 is held down.
641 cfa37a7b 2004-04-10 devnull When an external command (e.g.
642 cfa37a7b 2004-04-10 devnull .IR echo (1))
643 cfa37a7b 2004-04-10 devnull is executed this way, the extra argument is passed as expected and an
644 cfa37a7b 2004-04-10 devnull environment variable
645 cfa37a7b 2004-04-10 devnull .B $acmeaddr
646 cfa37a7b 2004-04-10 devnull is created that holds, in the form interpreted by button 3,
647 cfa37a7b 2004-04-10 devnull the fully-qualified address of the extra argument.
648 cfa37a7b 2004-04-10 devnull .SS "Support programs
650 cfa37a7b 2004-04-10 devnull creates a new
652 cfa37a7b 2004-04-10 devnull window and runs a
653 cfa37a7b 2004-04-10 devnull .I command
654 cfa37a7b 2004-04-10 devnull (default
655 c8b6342d 2005-01-13 devnull .BR $SHELL )
656 cfa37a7b 2004-04-10 devnull in it, turning the window into something analogous to an
657 ba31ab30 2011-04-27 rsc .IR 9term (1)
659 cfa37a7b 2004-04-10 devnull Executing text in a
661 cfa37a7b 2004-04-10 devnull window with button
662 cfa37a7b 2004-04-10 devnull 2 is similar to using
663 cfa37a7b 2004-04-10 devnull .BR Send .
665 ba31ab30 2011-04-27 rsc windows follow the same scrolling heuristic as in
666 ba31ab30 2011-04-27 rsc .IR 9term (1):
667 ba31ab30 2011-04-27 rsc the window scrolls on output only if the window is displaying the end of the buffer.
670 cfa37a7b 2004-04-10 devnull loads the tag line of its window with the directory in which it's running, suffixed
671 cfa37a7b 2004-04-10 devnull .BI - label
672 cfa37a7b 2004-04-10 devnull (default
673 cfa37a7b 2004-04-10 devnull .BR rc );
675 cfa37a7b 2004-04-10 devnull intended to be executed by a
677 cfa37a7b 2004-04-10 devnull function for use in
679 cfa37a7b 2004-04-10 devnull windows. An example definition is
681 cfa37a7b 2004-04-10 devnull fn cd { builtin cd $1 && awd $sysname }
683 cfa37a7b 2004-04-10 devnull .SS "Applications and guide files
684 cfa37a7b 2004-04-10 devnull In the directory
685 cfa37a7b 2004-04-10 devnull .B /acme
686 cfa37a7b 2004-04-10 devnull live several subdirectories, each corresponding to a program or
687 cfa37a7b 2004-04-10 devnull set of related programs that employ
688 cfa37a7b 2004-04-10 devnull .I acme's
689 cfa37a7b 2004-04-10 devnull user interface.
690 cfa37a7b 2004-04-10 devnull Each subdirectory includes source, binaries, and a
691 cfa37a7b 2004-04-10 devnull .B readme
692 cfa37a7b 2004-04-10 devnull file for further information.
693 cfa37a7b 2004-04-10 devnull It also includes a
694 cfa37a7b 2004-04-10 devnull .BR guide ,
695 cfa37a7b 2004-04-10 devnull a text file holding sample commands to invoke the programs.
696 cfa37a7b 2004-04-10 devnull The idea is to find an example in the guide that best matches
697 cfa37a7b 2004-04-10 devnull the job at hand, edit it to suit, and execute it.
699 cfa37a7b 2004-04-10 devnull Whenever a command is executed by
700 cfa37a7b 2004-04-10 devnull .IR acme ,
701 cfa37a7b 2004-04-10 devnull the default search path includes the directory of the window containing
702 cfa37a7b 2004-04-10 devnull the command and its subdirectory
703 cfa37a7b 2004-04-10 devnull .BR $cputype .
704 cfa37a7b 2004-04-10 devnull The program directories in
705 cfa37a7b 2004-04-10 devnull .B /acme
706 cfa37a7b 2004-04-10 devnull contain appropriately labeled subdirectories of binaries,
707 cfa37a7b 2004-04-10 devnull so commands named
708 cfa37a7b 2004-04-10 devnull in the guide files will be found automatically when run.
711 cfa37a7b 2004-04-10 devnull binds the directories
712 cfa37a7b 2004-04-10 devnull .B /acme/bin
714 cfa37a7b 2004-04-10 devnull .B /acme/bin/$cputype
715 cfa37a7b 2004-04-10 devnull to the end of
717 cfa37a7b 2004-04-10 devnull when it starts; this is where
718 cfa37a7b 2004-04-10 devnull .IR acme -specific
719 cfa37a7b 2004-04-10 devnull programs such as
724 cfa37a7b 2004-04-10 devnull .SH FILES
725 cfa37a7b 2004-04-10 devnull .TF $home/acme.dump
727 cfa37a7b 2004-04-10 devnull .B $home/acme.dump
728 cfa37a7b 2004-04-10 devnull default file for
731 cfa37a7b 2004-04-10 devnull .BR Load ;
732 cfa37a7b 2004-04-10 devnull also where state is written if
734 cfa37a7b 2004-04-10 devnull dies or is killed unexpectedly, e.g. by deleting its window.
736 cfa37a7b 2004-04-10 devnull .B /acme/*/guide
737 cfa37a7b 2004-04-10 devnull template files for applications
739 cfa37a7b 2004-04-10 devnull .B /acme/*/readme
740 cfa37a7b 2004-04-10 devnull informal documentation for applications
742 cfa37a7b 2004-04-10 devnull .B /acme/*/src
743 cfa37a7b 2004-04-10 devnull source for applications
745 cfa37a7b 2004-04-10 devnull .B /acme/*/mips
746 cfa37a7b 2004-04-10 devnull MIPS-specific binaries for applications
747 cfa37a7b 2004-04-10 devnull .SH SOURCE
748 c3674de4 2005-01-11 devnull .B \*9/src/cmd/acme
750 c3674de4 2005-01-11 devnull .B \*9/src/cmd/9term/win.c
752 c3674de4 2005-01-11 devnull .B \*9/bin/awd
753 cfa37a7b 2004-04-10 devnull .SH SEE ALSO
754 cfa37a7b 2004-04-10 devnull .IR acme (4)
756 cfa37a7b 2004-04-10 devnull Rob Pike,
758 cfa37a7b 2004-04-10 devnull Acme: A User Interface for Programmers.
759 cfa37a7b 2004-04-10 devnull .SH BUGS
760 cfa37a7b 2004-04-10 devnull With the
762 cfa37a7b 2004-04-10 devnull option or
764 cfa37a7b 2004-04-10 devnull command,
765 cfa37a7b 2004-04-10 devnull the recreation of windows under control of external programs
768 cfa37a7b 2004-04-10 devnull is just to rerun the command; information may be lost.
