diff options
Diffstat (limited to 'examples/README.md')
| -rw-r--r-- | examples/README.md | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/examples/README.md b/examples/README.md index 6112a696..aaaf5920 100644 --- a/examples/README.md +++ b/examples/README.md @@ -56,6 +56,8 @@ lines. new/ dir looking up ANY name here creates a pane <id>/ dir one per pane; id is the pane serial, never reused addr body ctl data errors event rdsel tag wrsel xdata + pty/ dir TERMINAL PANES ONLY; absent on a pane with a document + ctl status data ``` | file | mode | semantics | @@ -73,12 +75,26 @@ lines. | `rdsel` | r | the pane's current selection. | | `wrsel` | w | replaces the pane's current selection. | | `event` | rw | the pane's action stream, both directions. See below. | +| `pty/` | dir | present only when the pane is a terminal, so `test -d $PARDES_FS/<id>/pty` is how a script asks. Absent — not empty — on a file pane, and every file under it answers ENOENT there. | +| `pty/ctl` | w | newline separated verbs, several per write, applied all or nothing: `winsize <cols> <rows>`, `sig INT\|TERM\|HUP\|QUIT\|KILL`, `exec`. Anything else is EINVAL and applies nothing. | +| `pty/status` | r | three `%11d` fields: columns, rows, and 1 while a program (vim, a pager, a build) holds the tty rather than the shell prompt. Seekable. | +| `pty/data` | rw | the raw stream. A write is input to the program, offset ignored, short at a character boundary. A read hands back as much of the pending output as the count allows and keeps the rest — raw bytes have no records, so unlike `event` a small read is served rather than refused — and blocks while there is nothing. Output is only recorded while the file is OPEN. | `ctl` verbs: `addr=dot`, `clean`, `dirty`, `cleartag`, `del`, `delete`, `dot=addr`, `get`, `limit=addr`, `mark`, `nomark`, `name <name>`, `noscroll`, `scroll`, `put`, `show`. An unknown verb fails the whole write with EINVAL and applies nothing, so a batch is safe to send blind. +`pty/ctl` verbs in detail. `winsize` is `TIOCSWINSZ` and nothing more: it tells +the program a size and does not move the pane, whose grid is its rectangle on +screen, so the next time you drag that pane the layout's size wins again. +`sig` goes to the tty's foreground process group — what ^C would reach — and +not to the shell, which ignores SIGINT while it waits for a job. `exec` +respawns the pane's configured shell in the pane's own directory and takes NO +argument: `exec /bin/sh` is EINVAL rather than an argument silently dropped. +`raw` and `cooked` do not exist, because the termios belongs to the program on +the far side of the pty and it never tells us. + Addresses, all in bytes: `#n` an offset, `n` a line, `0` the start, `$` the end, `.` the selection, `a,b` a range (`,` alone is the whole body), `+` and `-` with a count or a regex, `/re/` forwards, `?re?` backwards. Anything else |