summaryrefslogtreecommitdiff
path: root/docs/typ/reference.typ
diff options
context:
space:
mode:
authorGabriel Schneider <[email protected]>2026-10-02 01:44:43 -0300
committerGabriel Schneider <[email protected]>2026-10-02 01:48:59 -0300
commit0665ef624477e71f9c63c9c00753c781f0d31422 (patch)
tree0ab313b88004edff7890d25768fbfa37c153bae1 /docs/typ/reference.typ
parent364ea5d6e57c36158d95bcd85d117e9f5a944d62 (diff)
downloadpardes-0665ef624477e71f9c63c9c00753c781f0d31422.tar.gz
pardes-0665ef624477e71f9c63c9c00753c781f0d31422.zip
Docs for 0.24: Ctrl-i's fallbacks (SPC j i, SPC j o, the side buttons), a terminal's text edited as a copy, a tag's typed path surviving Esc, Get's order of refusals, the init file's errors when saved, --wait and --detach in words; the CHANGELOG's 0.24 section, the directory window moved there from 0.23
Co-Authored-By: Claude Opus 5.5 <[email protected]>
Diffstat (limited to 'docs/typ/reference.typ')
-rw-r--r--docs/typ/reference.typ9
1 files changed, 5 insertions, 4 deletions
diff --git a/docs/typ/reference.typ b/docs/typ/reference.typ
index 27e8fe88..148ef30e 100644
--- a/docs/typ/reference.typ
+++ b/docs/typ/reference.typ
@@ -922,7 +922,7 @@ a FILE not there yet opens an empty pane that #word("Save") creates, making
its directories. What the session refuses (a bad name; a name under a
directory you may not search or write, `permission denied`) is printed and
the exit is 1. `--` ends the options (`pardes -- -name`).
-`pardes --wait FILE` (`-w`) returns 0 when the pane showing FILE is
+`pardes --wait FILE` (`-w`; bare, it says it needs a FILE) returns 0 when the pane showing FILE is
deleted, 1 when the session goes away (against a dead `$PARDES_9P` it
says the session is gone); with
`PARDES_9P` set but no pane of its own it opens FILE in that session and
@@ -984,7 +984,7 @@ it was.
`--no-prefix` diff's paths are kept.
- *Sessions.* Bare `--detach` names the session after its pid; bare
`--attach` needs exactly one session; a second `--detach=NAME` while NAME
- runs says so and exits 1. Frontends share the smallest common size. With
+ runs (a plain session is named by its pid) says so in words and exits 1. Frontends share the smallest common size. With
none attached, `size C R` sets the screen, messages clear by the clock,
and a pty reports its size in pixels at the last frontend's cell size
(8×16 before any), as CSI 14, 16 and 18 t do.
@@ -994,7 +994,8 @@ it was.
notice and `err - init file line N: why`, and the rest still run; a
setting only the other frontend has (#word("Font") in a terminal) is skipped;
text that is no builtin is not run; saving the init file in a pane
- applies its settings again. A dump keeps panes, columns, tags,
+ applies its settings again and says a bad line as startup does
+ (`err - init file line N: why`), its commands not run again. A dump keeps panes, columns, tags,
selections, the theme and changed settings, but not a picture or a PDF
that is on disk (#word("Restore") reads it from there); a terminal
comes back with its last MiB of output and a new shell in its old
@@ -1078,7 +1079,7 @@ with Client(sys.argv[1]) as c: # a socket path, or (ip, port)
[`addr` reset on first open], [#file("addr") is the pane's; no open resets it (write `0`)],
[OTRUNC on `data` ignored], [`: > data` deletes the addressed text; OTRUNC on #file("body") (`9p write`) replaces it all],
[event flags 1, 2, 4, 8], [1, 4 and 8; never 2, so no expansion record follows],
- [`Get`], [#word("Get") reads the file again, refusing unsaved edits once (a scratch under 100 bytes unasked, as #word("Del") closes it); `Get file` loads that file into the pane, which takes its name, and one that fails changes nothing; #word("Undo") after it, or after #word("Edit")'s `e`, puts the old name back with the old text and its saved state; in a directory pane #word("Get") reads the directory again and `Get file` is refused (#word("Look") opens the file) (also `get` on #file("ctl"))],
+ [`Get`], [#word("Get") reads the file again, refusing unsaved edits once (a scratch under 100 bytes unasked, as #word("Del") closes it; a file not there, or a directory, is said first); `Get file` loads that file into the pane, which takes its name, and one that fails changes nothing; #word("Undo") after it, or after #word("Edit")'s `e`, puts the old name back with the old text and its saved state; in a directory pane #word("Get") reads the directory again and `Get file` is refused (#word("Look") opens the file) (also `get` on #file("ctl"))],
[`Put`, `Delete`, `Load`], [#word("Save"); a #word("Del") that does not ask; #word("Restore")],
[`Putall`], [#word("Putall"): every pane with unsaved edits to a file is saved, a #word("Zerox") pair once, a refused one said; with a refusal, its write is answered once the other saves have landed],
[`Zerox`], [#word("Zerox"): a second pane on the buffer, one text, undo and unsaved state, its own scroll and cursor; an event reader on one hears no edit made through the other; the twins are kept across #word("Dump") and #word("Restore")],