1
0

acme 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683
  1. .TH ACME 1
  2. .SH NAME
  3. acme, win, awd \- interactive text windows
  4. .SH SYNOPSIS
  5. .B acme
  6. [
  7. .B -f
  8. .I varfont
  9. ]
  10. [
  11. .B -F
  12. .I fixfont
  13. ]
  14. [
  15. .B -c
  16. .I ncol
  17. ]
  18. [
  19. .B -b
  20. ]
  21. [
  22. .B -l
  23. .I file
  24. |
  25. .I file
  26. \&... ]
  27. .LP
  28. .B win
  29. [
  30. .I command
  31. ]
  32. .LP
  33. .B awd
  34. [
  35. .I label
  36. ]
  37. .SH DESCRIPTION
  38. .I Acme
  39. manages windows of text that may be edited interactively or by external programs.
  40. The interactive interface uses the keyboard and mouse; external programs
  41. use a set of files served by
  42. .IR acme ;
  43. these are discussed in
  44. .IR acme (4).
  45. .PP
  46. Any named
  47. .I files
  48. are read into
  49. .I acme
  50. windows before
  51. .I acme
  52. accepts input.
  53. With the
  54. .B -l
  55. option, the state of the entire system is loaded
  56. from
  57. .IR file ,
  58. which should have been created by a
  59. .B Dump
  60. command (q.v.),
  61. and subsequent
  62. .I file
  63. names are ignored.
  64. Plain files display as text; directories display as columnated lists of the
  65. names of their components, as in
  66. .B "ls -p directory|mc
  67. except that the names of subdirectories have a slash appended.
  68. .PP
  69. The
  70. .B -f
  71. .RB ( -F )
  72. option sets the main font, usually variable-pitch (alternate, usually fixed-pitch);
  73. the default is
  74. .B /lib/font/bit/lucidasans/euro.8.font
  75. .RB ( \&.../lucm/unicode.9.font ).
  76. Tab intervals are set to the width of 4 (or the value of
  77. .BR $tabstop )
  78. numeral zeros in the appropriate font.
  79. .PP
  80. .SS Windows
  81. .I Acme
  82. windows are in two parts: a one-line
  83. .I tag
  84. above a multi-line
  85. .IR body .
  86. The body typically contains an image of a file, as in
  87. .IR sam (1),
  88. or the output of a
  89. program, as in an
  90. .IR rio (1)
  91. window.
  92. The tag contains a number of
  93. blank-separated words, followed by a vertical bar character, followed by anything.
  94. The first word is the name of the window, typically the name of the associated
  95. file or directory, and the other words are commands available in that window.
  96. Any text may be added after the bar; examples are strings to search for or
  97. commands to execute in that window.
  98. Changes to the text left of the bar will be ignored,
  99. unless the result is to change the name of the
  100. window.
  101. .PP
  102. If a window holds a directory, the name (first word of the tag) will end with
  103. a slash.
  104. .SS Scrolling
  105. Each window has a scroll bar to the left of the body.
  106. The scroll bar behaves much as in
  107. .IR sam (1)
  108. or
  109. .IR rio (1)
  110. except that scrolling occurs when the button is pressed, rather than released,
  111. and continues
  112. as long as the mouse button is held down in the scroll bar.
  113. For example, to scroll slowly through a file,
  114. hold button 3 down near the top of the scroll bar. Moving the mouse
  115. down the scroll bar speeds up the rate of scrolling.
  116. .SS Layout
  117. .I Acme
  118. windows are arranged in columns. By default, it creates two columns when starting;
  119. this can be overridden with the
  120. .B -c
  121. option.
  122. Placement is automatic but may be adjusted
  123. using the
  124. .I layout box
  125. in the upper left corner of each window and column.
  126. Pressing and holding any mouse button in the box drags
  127. the associated window or column.
  128. For windows, just
  129. clicking in the layout box grows the window in place: button 1
  130. grows it a little, button 2 grows it as much as it can, still leaving all other
  131. tags in that column visible, and button 3 takes over the column completely,
  132. temporarily hiding other windows in the column.
  133. (They will return
  134. .I en masse
  135. if any of them needs attention.)
  136. The layout box in a window is normally white; when it is black in the center,
  137. it records that the file is `dirty':
  138. .I Acme
  139. believes it is modified from its original
  140. contents.
  141. .PP
  142. Tags exist at the top of each column and across the whole display.
  143. .I Acme
  144. pre-loads them with useful commands.
  145. Also, the tag across the top maintains a list of executing long-running commands.
  146. .SS Typing
  147. The behavior of typed text is similar to that in
  148. .IR rio (1)
  149. except that the characters are delivered to the tag or body under the mouse; there is no
  150. `click to type'.
  151. (The experimental option
  152. .B -b
  153. causes typing to go to the most recently clicked-at or made window.)
  154. The usual backspacing conventions apply.
  155. As in
  156. .IR sam (1)
  157. but not
  158. .IR rio ,
  159. the ESC key selects the text typed since the last mouse action,
  160. a feature particularly useful when executing commands.
  161. A side effect is that typing ESC with text already selected is identical
  162. to a
  163. .B Cut
  164. command
  165. .RI ( q.v. ).
  166. .PP
  167. Most text, including the names of windows, may be edited uniformly.
  168. The only exception is that the command names to the
  169. left of the bar in a tag are maintained automatically; changes to them are repaired
  170. by
  171. .IR acme .
  172. .SS "Directory context
  173. Each window's tag names a directory: explicitly if the window
  174. holds a directory; implicitly if it holds a regular file
  175. (e.g. the directory
  176. .B /adm
  177. if the window holds
  178. .BR /adm/users ).
  179. This directory provides a
  180. .I context
  181. for interpreting file names in that window.
  182. For example, the string
  183. .B users
  184. in a window labeled
  185. .B /adm/
  186. or
  187. .B /adm/keys
  188. will be interpreted as the file name
  189. .BR /adm/users .
  190. The directory is defined purely textually, so it can be a non-existent
  191. directory or a real directory associated with a non-existent file
  192. (e.g.
  193. .BR /adm/not-a-file ).
  194. File names beginning with a slash
  195. are assumed to be absolute file names.
  196. .SS Errors
  197. Windows whose names begin with
  198. .B -
  199. or
  200. .B +
  201. conventionally hold diagnostics and other data
  202. not directly associated with files.
  203. A window labeled
  204. .B +Errors
  205. receives all diagnostics produced by
  206. .I acme
  207. itself.
  208. Diagnostics from commands run by
  209. .I acme
  210. appear in a window named
  211. .IB directory /+Errors
  212. where
  213. .I directory
  214. is identified by the context of the command.
  215. These error windows are created when needed.
  216. .SS "Mouse button 1
  217. Mouse button 1 selects text just as in
  218. .IR sam (1)
  219. or
  220. .IR rio (1) ,
  221. including the usual double-clicking conventions.
  222. .SS "Mouse button 2
  223. By an
  224. action similar to selecting text with button 1,
  225. button 2 indicates text to execute as a command.
  226. If the indicated text has multiple white-space-separated words,
  227. the first is the command name and the second and subsequent
  228. are its arguments.
  229. If button 2 is `clicked'\(emindicates a null string\(em\c
  230. .I acme
  231. .I expands
  232. the indicated text to find a command to run:
  233. if the click is within button-1-selected text,
  234. .I acme
  235. takes that selection as the command;
  236. otherwise it takes the largest string of valid file name characters containing the click.
  237. Valid file name characters are alphanumerics and
  238. .B _
  239. .B .
  240. .B -
  241. .B +
  242. .BR / .
  243. This behavior is similar to double-clicking with button 1 but,
  244. because a null command is meaningless, only a single click is required.
  245. .PP
  246. Some commands, all by convention starting with a capital letter, are
  247. .I built-ins
  248. that are executed directly by
  249. .IR acme :
  250. .TP
  251. .B Cut
  252. Delete most recently selected text and place in snarf buffer.
  253. .TP
  254. .B Del
  255. Delete window. If window is dirty, instead print a warning; a second
  256. .B Del
  257. will succeed.
  258. .TP
  259. .B Delcol
  260. Delete column and all its windows, after checking that windows are not dirty.
  261. .TP
  262. .B Delete
  263. Delete window without checking for dirtiness.
  264. .TP
  265. .B Dump
  266. Write the state of
  267. .I acme
  268. to the file name, if specified, or
  269. .B $home/acme.dump
  270. by default.
  271. .TP
  272. .B Edit
  273. Treat the argument as a text editing command in the style of
  274. .IR sam (1).
  275. The full
  276. .B Sam
  277. language is implemented except for the commands
  278. .BR k ,
  279. .BR n ,
  280. .BR q ,
  281. and
  282. .BR ! .
  283. The
  284. .B =
  285. command is slightly different: it includes the file name and
  286. gives only the line address unless the command is explicitly
  287. .BR =# .
  288. The `current window' for the command is the body of the window in which the
  289. .B Edit
  290. command is executed.
  291. Usually the
  292. .B Edit
  293. command would be typed in a tag; longer commands may be prepared in a
  294. scratch window and executed, with
  295. .B Edit
  296. itself in the current window, using the 2-1 chord described below.
  297. .TP
  298. .B Exit
  299. Exit
  300. .I acme
  301. after checking that windows are not dirty.
  302. .TP
  303. .B Font
  304. With no arguments, change the font of the associated window from fixed-spaced to
  305. proportional-spaced or
  306. .I vice
  307. .IR versa .
  308. Given a file name argument, change the font of the window to that stored in the named file.
  309. If the file name argument is prefixed by
  310. .B var
  311. .RB ( fix ),
  312. also set the default proportional-spaced (fixed-spaced) font for future use to that font.
  313. Other existing windows are unaffected.
  314. .TP
  315. .B Get
  316. Load file into window, replacing previous contents (after checking for dirtiness as in
  317. .BR Del ).
  318. With no argument, use the existing file name of the window.
  319. Given an argument, use that file but do not change the window's file name.
  320. .TP
  321. .B ID
  322. Print window ID number
  323. .RI ( q.v. ).
  324. .TP
  325. .B Incl
  326. When opening `include' files
  327. (those enclosed in
  328. .BR <> )
  329. with button 3,
  330. .I acme
  331. searches in directories
  332. .B /$objtype/include
  333. and
  334. .BR /sys/include .
  335. .B Incl
  336. adds its arguments to a supplementary list of include directories, analogous to
  337. the
  338. .B -I
  339. option to the compilers.
  340. This list is per-window and is inherited when windows are created by actions in that window, so
  341. .I Incl
  342. is most usefully applied to a directory containing relevant source.
  343. With no arguments,
  344. .I Incl
  345. prints the supplementary list.
  346. This command is largely superseded by plumbing
  347. (see
  348. .IR plumb (6)).
  349. .TP
  350. .B Kill
  351. Send a
  352. .B kill
  353. note to
  354. .IR acme -initiated
  355. commands named as arguments.
  356. .TP
  357. .B Local
  358. When prefixed to a command
  359. run the
  360. command in the same file name space and environment variable group as
  361. .IR acme .
  362. The environment of the command
  363. is restricted but is sufficient to run
  364. .IR bind (1),
  365. .IR 9fs
  366. (see
  367. .IR srv (4)),
  368. .IR import (4),
  369. etc.,
  370. and to set environment variables such as
  371. .BR $objtype .
  372. .TP
  373. .B Load
  374. Restore the state of
  375. .I acme
  376. from a file (default
  377. .BR $home/acme.dump )
  378. created by the
  379. .B Dump
  380. command.
  381. .TP
  382. .B Look
  383. Search in body for occurrence of literal text indicated by the argument or,
  384. if none is given, by the selected text in the body.
  385. .TP
  386. .B New
  387. Make new window. With arguments, load the named files into windows.
  388. .TP
  389. .B Newcol
  390. Make new column.
  391. .TP
  392. .B Paste
  393. Replace most recently selected text with contents of snarf buffer.
  394. .TP
  395. .B Put
  396. Write window to the named file.
  397. With no argument, write to the file named in the tag of the window.
  398. .TP
  399. .B Putall
  400. Write all dirty windows whose names indicate existing regular files.
  401. .TP
  402. .B Redo
  403. Complement of
  404. .BR Undo .
  405. .TP
  406. .B Send
  407. Append selected text or snarf buffer to end of body; used mainly with
  408. .IR win .
  409. .TP
  410. .B Snarf
  411. Place selected text in snarf buffer.
  412. .TP
  413. .B Sort
  414. Arrange the windows in the column from top to bottom in lexicographical
  415. order based on their names.
  416. .TP
  417. .B Tab
  418. Set the width of tab stops for this window to the value of the argument, in units of widths of the zero
  419. character.
  420. With no arguments, it prints the current value.
  421. .TP
  422. .B Undo
  423. Undo last textual change or set of changes.
  424. .TP
  425. .B Zerox
  426. Create a copy of the window containing most recently selected text.
  427. .PP
  428. A common place to store text for commands is in the tag; in fact
  429. .I acme
  430. maintains a set of commands appropriate to the state of the window
  431. to the left of the bar in the tag.
  432. .PP
  433. If the text indicated with button 2 is not a recognized built-in, it is executed as
  434. a shell command. For example, indicating
  435. .B date
  436. with button 2 runs
  437. .IR date (1).
  438. The standard
  439. and error outputs of commands are sent to the error window associated with
  440. the directory from which the command was run, which will be created if
  441. necessary.
  442. For example, in a window
  443. .B /adm/users
  444. executing
  445. .B pwd
  446. will produce the output
  447. .B /adm
  448. in a (possibly newly-created) window labeled
  449. .BR /adm/+Errors ;
  450. in a window containing
  451. .B /sys/src/cmd/sam/sam.c
  452. executing
  453. .B mk
  454. will run
  455. .IR mk (1)
  456. in
  457. .BR /sys/src/cmd/sam ,
  458. producing output in a window labeled
  459. .BR /sys/src/cmd/sam/+Errors .
  460. The environment of such commands contains the variable
  461. .B $%
  462. with value set to the filename of the window in which the command is run.
  463. .SS "Mouse button 3
  464. Pointing at text with button 3 instructs
  465. .I acme
  466. to locate or acquire the file, string, etc. described by the indicated text and
  467. its context.
  468. This description follows the actions taken when
  469. button 3 is released after sweeping out some text.
  470. In the description,
  471. .I text
  472. refers to the text of the original sweep or, if it was null, the result of
  473. applying the same expansion rules that apply to button 2 actions.
  474. .PP
  475. If the text names an existing window,
  476. .I acme
  477. moves the mouse cursor to the selected text in the body of that window.
  478. If the text names an existing file with no associated window,
  479. .I acme
  480. loads the file into a new window and moves the mouse there.
  481. If the text is a file name contained in angle brackets,
  482. .I acme
  483. loads the indicated include file from the directory appropriate to the
  484. suffix of the file name of the window holding the text.
  485. (The
  486. .B Incl
  487. command adds directories to the standard list.)
  488. .PP
  489. If the text begins with a colon, it is taken to be an address, in
  490. the style of
  491. .IR sam (1),
  492. within the body of the window containing the text.
  493. The address is evaluated, the resulting text highlighted, and the mouse moved to it.
  494. Thus, in
  495. .IR acme ,
  496. one must type
  497. .B :/regexp
  498. or
  499. .B :127
  500. not just
  501. .B /regexp
  502. or
  503. .BR 127 .
  504. (There is an easier way to locate literal text; see below.)
  505. .PP
  506. If the text is a file name followed by a colon and an address,
  507. .I acme
  508. loads the file and evaluates the address. For example, clicking button 3 anywhere
  509. in the text
  510. .B file.c:27
  511. will open
  512. .BR file.c ,
  513. select line
  514. 27, and put the mouse at the beginning of the line. The rules about Error
  515. files, directories, and so on all combine to make this an efficient way to
  516. investigate errors from compilers, etc.
  517. .PP
  518. If the text is not an address or file, it is taken to
  519. be literal text, which is then searched for in the body of the window
  520. in which button 3 was clicked. If a match is found, it is selected and the mouse is
  521. moved there. Thus, to search for occurrences of a word in a file,
  522. just click button 3 on the word. Because of the rule of using the
  523. selection as the button 3 action, subsequent clicks will find subsequent
  524. occurrences without moving the mouse.
  525. .PP
  526. In all these actions, the mouse motion is not done if the text is a null string
  527. within a non-null selected string in the tag, so that (for example) complex regular expressions
  528. may be selected and applied repeatedly to the
  529. body by just clicking button 3 over them.
  530. .SS "Chords of mouse buttons
  531. Several operations are bound to multiple-button actions.
  532. After selecting text, with button 1 still down, pressing button 2
  533. executes
  534. .B Cut
  535. and button 3 executes
  536. .BR Paste .
  537. After clicking one button, the other undoes
  538. the first; thus (while holding down button 1) 2 followed by 3 is a
  539. .B Snarf
  540. that leaves the file undirtied;
  541. 3 followed by 2 is a no-op.
  542. These actions also apply to text selected by double-clicking because
  543. the double-click expansion is made when the second
  544. click starts, not when it ends.
  545. .PP
  546. Commands may be given extra arguments by a mouse chord with buttons 2 and 1.
  547. While holding down button 2 on text to be executed as a command, clicking button 1
  548. appends the text last pointed to by button 1 as a distinct final argument.
  549. For example, to search for literal
  550. .B text
  551. one may execute
  552. .B Look text
  553. with button 2 or instead point at
  554. .B text
  555. with button 1 in any window, release button 1,
  556. then execute
  557. .BR Look ,
  558. clicking button 1 while 2 is held down.
  559. .PP
  560. When an external command (e.g.
  561. .IR echo (1))
  562. is executed this way, the extra argument is passed as expected and an
  563. environment variable
  564. .B $acmeaddr
  565. is created that holds, in the form interpreted by button 3,
  566. the fully-qualified address of the extra argument.
  567. .SS "Support programs
  568. .I Win
  569. creates a new
  570. .I acme
  571. window and runs a
  572. .I command
  573. (default
  574. .BR /bin/rc )
  575. in it, turning the window into something analogous to an
  576. .IR rio (1)
  577. window.
  578. Executing text in a
  579. .I win
  580. window with button
  581. 2 is similar to using
  582. .BR Send .
  583. .PP
  584. .I Awd
  585. loads the tag line of its window with the directory in which it's running, suffixed
  586. .BI - label
  587. (default
  588. .BR rc );
  589. it is
  590. intended to be executed by a
  591. .B cd
  592. function for use in
  593. .I win
  594. windows. An example definition is
  595. .EX
  596. fn cd { builtin cd $1 && awd $sysname }
  597. .EE
  598. .SS "Applications and guide files
  599. In the directory
  600. .B /acme
  601. live several subdirectories, each corresponding to a program or
  602. set of related programs that employ
  603. .I acme's
  604. user interface.
  605. Each subdirectory includes source, binaries, and a
  606. .B readme
  607. file for further information.
  608. It also includes a
  609. .BR guide ,
  610. a text file holding sample commands to invoke the programs.
  611. The idea is to find an example in the guide that best matches
  612. the job at hand, edit it to suit, and execute it.
  613. .PP
  614. Whenever a command is executed by
  615. .IR acme ,
  616. the default search path includes the directory of the window containing
  617. the command and its subdirectory
  618. .BR $cputype .
  619. The program directories in
  620. .B /acme
  621. contain appropriately labeled subdirectories of binaries,
  622. so commands named
  623. in the guide files will be found automatically when run.
  624. Also,
  625. .I acme
  626. binds the directories
  627. .B /acme/bin
  628. and
  629. .B /acme/bin/$cputype
  630. to the end of
  631. .B /bin
  632. when it starts; this is where
  633. .IR acme -specific
  634. programs such as
  635. .I win
  636. and
  637. .I awd
  638. reside.
  639. .SH FILES
  640. .TF $home/acme.dump
  641. .TP
  642. .B $home/acme.dump
  643. default file for
  644. .B Dump
  645. and
  646. .BR Load ;
  647. also where state is written if
  648. .I acme
  649. dies or is killed unexpectedly, e.g. by deleting its window.
  650. .TP
  651. .B /acme/*/guide
  652. template files for applications
  653. .TP
  654. .B /acme/*/readme
  655. informal documentation for applications
  656. .TP
  657. .B /acme/*/src
  658. source for applications
  659. .TP
  660. .B /acme/*/mips
  661. MIPS-specific binaries for applications
  662. .SH SOURCE
  663. .B /sys/src/cmd/acme
  664. .br
  665. .B /acme/bin/source/win
  666. .br
  667. .B /sys/src/cmd/awd.c
  668. .SH SEE ALSO
  669. .IR acme (4)
  670. .br
  671. Rob Pike,
  672. .I
  673. Acme: A User Interface for Programmers.
  674. .SH BUGS
  675. With the
  676. .B -l
  677. option or
  678. .B Load
  679. command,
  680. the recreation of windows under control of external programs
  681. such as
  682. .I win
  683. is just to rerun the command; information may be lost.