diff options
| author | Gabriel Schneider <[email protected]> | 2026-11-17 03:51:15 -0300 |
|---|---|---|
| committer | Gabriel Schneider <[email protected]> | 2026-11-17 12:15:01 -0300 |
| commit | 79a1e816ceb13ef81b712007716c8add2de75434 (patch) | |
| tree | 1714b1bf19da3a58be2623ffe29e3f8be1b21fe3 /docs/typ/reference.typ | |
| parent | a22b579ad2df8d1811f0e194fa1bbc06e2282cf8 (diff) | |
| parent | f1af015f01e4e8d42f6224c4d4063f3aea218f5a (diff) | |
| download | pardes-79a1e816ceb13ef81b712007716c8add2de75434.tar.gz pardes-79a1e816ceb13ef81b712007716c8add2de75434.zip | |
integration: the terminal a module of its own, with the plumber whole and the walker's cheaper compile
A merge of term-phase1a and pardes-next, no conflicts. core-test (the core with no terminal) 411 passed, 535 skipped of 946; shell-test (the same tests, the terminal compiled in) 989/989, on tui.
Co-Authored-By: Claude Fable 5.2 <[email protected]>
Claude-Session: https://claude.ai/code/session_016Y9MNBECMWcJD5pdS4SR6T
Diffstat (limited to 'docs/typ/reference.typ')
| -rw-r--r-- | docs/typ/reference.typ | 72 |
1 files changed, 57 insertions, 15 deletions
diff --git a/docs/typ/reference.typ b/docs/typ/reference.typ index 0d287381..987f9f9b 100644 --- a/docs/typ/reference.typ +++ b/docs/typ/reference.typ @@ -41,6 +41,7 @@ tagexec a word clicked in the workspace tag @co plumb/ the plumber's: plumb(6) rules, and messages sent by them @plumber rules the rules in force; a write adds rule sets, > replaces them @plumber send write a message: six header lines, then its data @plumber + <port> a port the rules name: read, the messages sent to it @plumber col/ the columns @columns-and-tags <n>/ column <n>; rmdir closes it when empty @columns-and-tags tag its tag @@ -1022,16 +1023,24 @@ at 200, ending in `…`. Control characters become spaces. = The plumber <plumber> Plan 9's plumber(4), its language plumb(6)'s, in the session: rules -match a message and say where it goes. A #word("Look") does not ask it -yet (the #word("Plumb") rules do, #doc("reference", section: "from-acme")). +match a message and say where it goes. A #word("Look") asks it first, as +acme's does: after the pane's own readings (a +History or +Recent row, a +diff line, a command word, `file:/re/`) and once a name already open in a +pane is focused (never sent), what is looked at is sent, `type` `text`, +`src` `pardes` (`term` from a terminal's raw mode, a kind's name from its +pane), `wdir` the pane's directory, the data the name as Look reads it. +One that no rule set takes, or that a started word declines, is Look's +own: a file or directory opened, else the word searched for. - #file("/plumb/rules") reads the rules in force: rule sets of `object<tab>verb<tab>arg` lines, each set ended by a blank line, a variable's `name=value` where it was set, an `include`'s rules in its - place. A session starts with `include basic`, pardes's own - (`src/plumbing`): a URL to the `web` port, an existing directory or file - (at the place written after it) to `edit`. A write adds rule sets, each - read as its blank line comes, the rest at the close; `>` replaces them + place. A session starts with the plumbing file's rules, #word("Plumb") + (`plumbing` in the configuration directory, beside `init`; saved, its + rules are in force), or without one `include basic`, pardes's own + (`src/plumbing`, below). A write adds rule sets, each + read as its blank line comes, the rest at the close (refused there, it + is an `err` in the log alone; Plan 9's loses it); `>` replaces them all. One open writes at a time (`file in use`). Kept in a dump. - A rule set that does not read is refused at the write it is whole in, `plumb/rules:<line>: <why>` in rules.c's words (`unknown verb isnt`, @@ -1055,14 +1064,47 @@ yet (the #word("Plumb") rules do, #doc("reference", section: "from-acme")). `$file` and `$dir` are where), `set`, `add` and `delete` (`delete` of an attribute not there fails, as plumber's code does), and the actions `plumb to <port>`, `plumb start <words>` and `plumb client <words>`. -- The ports pardes reads itself: `edit` (the data opened as a - #word("Look") opens it, at `addr=` when given), `web` (the host's - browser, a URL of at most 256 bytes) and each loaded kind by its name - (`image`, `pdf`). A message to another port runs its rule set's - `start` or `client`; to a port no rule names it goes nowhere. -- `plumb start` runs its words as #word("Exec") runs a line: a builtin in - place at the pane with the keyboard, anything else a command pane in - the message's `wdir`, each word one argument to the shell. +- Each port a rule has named this session has a file, + #file("/plumb/<port>") (0444), listed after `rules` and `send` in the + order the rules named them, never dropped. An open of it reads the + messages sent to that port from then on, one a read in the six lines' + form, a read that finds none held until one comes; every open gets its + own copy (`cat /plumb/edit` beside the editor sees every look it opens), + a message over its 64 KiB queue is not sent to it (an `err` in the log + says so). Messages sent before the open are not its. +- The ports pardes reads itself, whatever else reads them: `edit` (the + data opened as a #word("Look") opens it, at `addr=` when given; with + `action=showdata` the data itself shown, as acme's `plumb -i`, in the + pane `filename=` names, else a new clean one of that name, and with + `action=showdiff` then stacked in a +Diff in its place), `web` + (the host's browser, a URL of at most 256 bytes) and each loaded kind by + its name (`image`, `pdf`). A message to another port goes to its + readers; with none, its rule set's `start` runs (the message dropped), + or its `client`, the message held for the port's first reader (the + program it started, as a rule's `plumb client` means). To a port no + rule ever named it goes nowhere. +- `plumb start` of a builtin or a kind's word runs it in place, at the + looking pane (the pane with the keyboard for a #file("/plumb/send") + message); one that cannot do what it is asked declines, saying + nothing, and the send is refused (`no matching plumb rule`), so a + #word("Look") looks itself. Any other word is a program, started as + Plan 9's plumber starts one: detached, no pane, stdin, stdout and + stderr `/dev/null`, its words exec'd in `wdir` with no shell (a rule + that wants one says `sh -c '...'`); a failure to start it is said, and + logged as an `err`. Its directory and words fit in 256 bytes. + +The default rules, `src/plumbing`, keep #word("Look")'s ways: a URL to +the browser; a bare `.diff` or `.patch` stacked in a +Diff (#word("Diff") +with the file, which declines one with no hunk, opened as text then); an +existing directory or file to `edit`, Look's own open (a kind's file in +its kind); a commit hash looked at in the editor, in a git work tree, to +#word("Diff") with it, `git show` paged (outside one, Diff declines and +the word is searched for); a diff paged into a +Pager, which the pager +sends to `edit` (`src` `pager`, `type` `text/x-diff`, `action=showdata` +and the +Pager's `filename`), made `showdiff`: stacked in a +Diff in the ++Pager's place. Text paged that is no diff is not sent: + +#raw(read("../../src/plumbing"), block: true) = Addons <addons> @@ -1401,7 +1443,7 @@ with Client(sys.argv[1]) as c: # a socket path, or (ip, port) [Edit], [every acme command but `B <cmd`, `D <cmd` and the `'` address; no `\1`-`\9`, and an alternation takes the first branch that matches, not the longest; a failing `< | >` command changes nothing, where acme puts in what it wrote (#doc("fs", section: "edit"))], [`win`], [#word("Term") is a VT terminal pane; #file("pty/run") runs a line at its prompt and answers `exit N` and the output; with #word("Repl") bound, #word("Exec") on a source pane types the text into it], [a directory window], [as acme's: a text pane named `dir/` (#file("index") kind `text`, #file("ctl") isdir 1), its entries in columns sorted bytewise, dotfiles shown, a directory's marked `/`; blanks pad the columns where acme's tabs do; a #word("Look") at an entry is from that directory, `Get` or a look at it again reads it again, and an edit is kept until then rather than lost to a resize; never dirty, #word("Save") refuses it], - [the plumber], [no process: #word("Plumb") rules, one a line in plumb(6)'s order (`Plumb suffix .svg to image`), for the session and kept in a dump, are tried before the built-in ones and the first that matches takes the #word("Look"); the tests are `prefix`, `suffix` (an existing file's name, any case), `isdir` and `isfile`, the ports `url` (`xdg-open`, `open` on macOS), `dir`, `file` and any loaded kind by its name (`image`, `pdf`): a rule naming a kind not loaded is refused, and one whose kind has gone since is passed over; no `matches`, attributes, variables or `include`; bare, #word("Plumb") lists the rules, `Plumb -` empties them; the user's own go in `init`, a `Plumb` line each; the built-in rules: an `http://` or `https://` URL to `url`, a directory, a kind's extensions, then any file], + [the plumber], [no process: the plumber is the editor's own (#doc("reference", section: "plumber")): plumb(6)'s rules in #file("/plumb/rules") and the plumbing file #word("Plumb") opens, messages to #file("/plumb/send"); no submatches (`$1`-`$9`), no `click` from a #word("Look") (its own expansion stands)], [#key("Esc") selects what was typed], [#key("Esc") leaves insert mode, or goes back a pane (#doc("tags", section: "modes"))], ) |
