summaryrefslogtreecommitdiff
path: root/docs/typ
diff options
context:
space:
mode:
Diffstat (limited to 'docs/typ')
-rw-r--r--docs/typ/builtins-gui.json1
-rw-r--r--docs/typ/builtins-tty.json1
-rw-r--r--docs/typ/cheatsheet.typ2
-rw-r--r--docs/typ/guide.typ2
-rw-r--r--docs/typ/reference.typ7
5 files changed, 8 insertions, 5 deletions
diff --git a/docs/typ/builtins-gui.json b/docs/typ/builtins-gui.json
index ec214069..e4a8f611 100644
--- a/docs/typ/builtins-gui.json
+++ b/docs/typ/builtins-gui.json
@@ -26,6 +26,7 @@
{"name": "Delcol", "leader": "SPC c d", "also": [], "arg": false, "scope": "pane", "setting": false, "choices": null, "doc": "Close this column and its panes, refusing once over unsaved text."},
{"name": "Detach", "leader": "SPC s D", "also": [], "arg": false, "scope": "root", "setting": false, "choices": null, "doc": "Detach this pardes from its terminal, leaving the session running."},
{"name": "Diagnostics", "leader": "SPC l d", "also": [], "arg": false, "scope": "pane", "setting": false, "choices": null, "doc": "List the file's diagnostics from the language server."},
+ {"name": "DirLook", "leader": null, "also": [], "arg": true, "scope": "root", "setting": true, "choices": "pane, terminal", "doc": "A directory looked at: pane, a pane listing it as acme's directory window, or terminal, ls in a terminal there."},
{"name": "Down", "leader": "SPC w j", "also": ["C-w j", "C-w down"], "arg": false, "scope": "pane", "setting": false, "choices": null, "doc": "Move the keyboard to the pane below, off a tag onto the pane under it."},
{"name": "Dump", "leader": "SPC s d", "also": ["topbar"], "arg": false, "scope": "root", "setting": false, "choices": null, "doc": "Write the session's panes and layout to a dump file, for Restore."},
{"name": "DumpConfig", "leader": null, "also": [], "arg": false, "scope": "root", "setting": false, "choices": null, "doc": "Open the settings in effect, each a word to click, and the startup file's path."},
diff --git a/docs/typ/builtins-tty.json b/docs/typ/builtins-tty.json
index 6dd09882..959f88ce 100644
--- a/docs/typ/builtins-tty.json
+++ b/docs/typ/builtins-tty.json
@@ -23,6 +23,7 @@
{"name": "Delcol", "leader": "SPC c d", "also": [], "arg": false, "scope": "pane", "setting": false, "choices": null, "doc": "Close this column and its panes, refusing once over unsaved text."},
{"name": "Detach", "leader": "SPC s D", "also": [], "arg": false, "scope": "root", "setting": false, "choices": null, "doc": "Detach this pardes from its terminal, leaving the session running."},
{"name": "Diagnostics", "leader": "SPC l d", "also": [], "arg": false, "scope": "pane", "setting": false, "choices": null, "doc": "List the file's diagnostics from the language server."},
+ {"name": "DirLook", "leader": null, "also": [], "arg": true, "scope": "root", "setting": true, "choices": "pane, terminal", "doc": "A directory looked at: pane, a pane listing it as acme's directory window, or terminal, ls in a terminal there."},
{"name": "Down", "leader": "SPC w j", "also": ["C-w j", "C-w down"], "arg": false, "scope": "pane", "setting": false, "choices": null, "doc": "Move the keyboard to the pane below, off a tag onto the pane under it."},
{"name": "Dump", "leader": "SPC s d", "also": ["topbar"], "arg": false, "scope": "root", "setting": false, "choices": null, "doc": "Write the session's panes and layout to a dump file, for Restore."},
{"name": "DumpConfig", "leader": null, "also": [], "arg": false, "scope": "root", "setting": false, "choices": null, "doc": "Open the settings in effect, each a word to click, and the startup file's path."},
diff --git a/docs/typ/cheatsheet.typ b/docs/typ/cheatsheet.typ
index d8ea87ac..e95f5076 100644
--- a/docs/typ/cheatsheet.typ
+++ b/docs/typ/cheatsheet.typ
@@ -41,7 +41,7 @@ Typed anywhere, then #btn("B3") or #key("Enter"):
addr(":40"), [the pane looked from, line 40 (`:40:5`, any address after `:`)],
addr("~/x"), [home; also in #word("Save"), #word("Restore"), `pardes ~/x`],
addr("@p3:12"), [pane 3 by serial, a terminal's lines too],
- addr("src/"), [a directory: `ls` in an idle terminal there, else a new one],
+ addr("src/"), [a directory: a pane listing it; `Get` reads it again],
)
Addresses are sam's: `#n`, `/re/`, `?re?`, `$`, `a,b`. #doc("fs", section: "look-and-exec")
diff --git a/docs/typ/guide.typ b/docs/typ/guide.typ
index 077c62f1..5bfff0ce 100644
--- a/docs/typ/guide.typ
+++ b/docs/typ/guide.typ
@@ -157,7 +157,7 @@ pardes.
addr("notes.txt"), [opens it, or goes to the pane already showing it],
addr("notes.txt:12"), [line 12],
addr("notes.txt:/TODO/"), [the next match of `TODO`],
- addr("src/"), [`ls` typed into a terminal idle there, else a new terminal there],
+ addr("src/"), [a pane listing it, as acme's directory window: a #word("Look") at an entry opens it, `..` goes up, `Get` reads it again (#word("DirLook") `terminal`: `ls` in a terminal there)],
addr("https://ziglang.org"), [the browser, through `xdg-open` (`open` on macOS); there is no plumber],
)
diff --git a/docs/typ/reference.typ b/docs/typ/reference.typ
index 29f535ee..a7ac997e 100644
--- a/docs/typ/reference.typ
+++ b/docs/typ/reference.typ
@@ -403,6 +403,7 @@ word clicked in a tag does. The same lines go in the startup file
[#word("Placement") `acme|pardes`], [`acme`: where new panes go (#doc("fs", section: "placement"))],
[#word("BootShell") `keep|replace`], [`keep`; `replace` closes the untouched lone shell a dragged document lands beside],
[#word("LookWord") `search|list`], [`search`: a word given to #word("Look") selects its next place, or lists all in `+Search`],
+ [#word("DirLook") `pane|terminal`], [`pane`: #word("Look") on a directory opens a pane listing it, as acme's directory window (#doc("reference", section: "from-acme")); `terminal` types `ls` into a terminal idle there, else opens one],
[#word("TermImages") `real|petscii`], [`real`: a new terminal draws its program's kitty graphics (yazi's previews) as pixels where the shell can; #word("Petscii") flips one terminal; a tty under a terminal without kitty graphics draws them as glyph art either way],
[#word("Shell") `<name or path>`], [`$SHELL` when it is executable, else `/bin/sh`: the shell the next terminal and command pane run; a bare name is searched for in the usual bin directories, not `$PATH`; bare #word("Shell"): `$SHELL` if it is executable, else `/bin/sh`],
[#word("DumpDir") `<dir>`], [`$XDG_DATA_HOME/pardes`, else `~/.local/share/pardes`: where #word("Dump") writes, an absolute or `~` path to a directory that may be written (made if missing); a relative one, or one under a directory that may not be written, is refused; bare returns to the default],
@@ -564,7 +565,7 @@ makes its column the active one (a folded pane stays folded); `no such pane`, or
while a column or workspace tag has the keyboard.
*Pane ctl.* Reading it gives acme's status line: serial, tag length, body
-length, isdir (0), dirty, width in cells, font, tab width, undo available,
+length, isdir (1 for a directory pane, else 0), dirty, width in cells, font, tab width, undo available,
redo available, then `current`/`notcurrent`, a REPL's id if bound,
`collapsed` when it is, and for a PDF `fit:width|height
tint:disabled|filtered|full`. It
@@ -1026,13 +1027,13 @@ 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`], [`get` on the pane's #file("ctl")],
+ [`Get`], [`get` on the pane's #file("ctl"); `Get` itself only in a directory pane],
[`Put`, `Delete`], [#word("Save"); a #word("Del") that does not ask],
[`Snarf`, `Cut`, `Paste`], [refused: the chords, #key("y"), #key("p")],
[acme's other builtins], [refused: `Putall`, `Zerox`, `Sort`, `Load`, `ID`, `Send`, `Tab`, `Indent`, `Local`, `Incl`, `Abort`],
[Edit], [no `< | >`, `X`, `Y`, `b B D e r w f`, no `\1`-`\9`; an alternation takes the first branch that matches, not the longest (#doc("fs", section: "edit"))],
[`win`], [#word("Tty") 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], [#word("Look") on a directory types `ls` into a terminal idle there, else opens one],
+ [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; #word("DirLook") `terminal` types `ls` into a terminal there instead],
[the plumber], [none: #word("Look") on an `http://` or `https://` URL runs `xdg-open` (`open` on macOS); files, addresses and directories follow built-in rules],
[#key("Esc") selects what was typed], [#key("Esc") leaves insert mode, or goes back a pane (#doc("tags", section: "modes"))],
)