diff options
Diffstat (limited to 'docs/typ')
| -rw-r--r-- | docs/typ/README | 14 | ||||
| -rw-r--r-- | docs/typ/building.typ | 16 | ||||
| -rw-r--r-- | docs/typ/builtins-gui.json | 2 | ||||
| -rw-r--r-- | docs/typ/builtins-tui.json (renamed from docs/typ/builtins-tty.json) | 2 | ||||
| -rw-r--r-- | docs/typ/builtins.typ | 2 | ||||
| -rw-r--r-- | docs/typ/cheatsheet.typ | 12 | ||||
| -rw-r--r-- | docs/typ/guide.typ | 12 | ||||
| -rw-r--r-- | docs/typ/install.typ | 2 | ||||
| -rw-r--r-- | docs/typ/reference.typ | 17 | ||||
| -rw-r--r-- | docs/typ/style.typ | 12 | ||||
| -rw-r--r-- | docs/typ/themes.typ | 4 |
11 files changed, 48 insertions, 47 deletions
diff --git a/docs/typ/README b/docs/typ/README index 9d3913c0..d246c3ed 100644 --- a/docs/typ/README +++ b/docs/typ/README @@ -26,10 +26,10 @@ the topics, since the book and the HTML hold them all. Build (from the repo root): typst compile --ignore-system-fonts docs/typ/cheatsheet-a4.typ - zig build cheatsheet -Dplatform=tty --prefix DIR # DIR/share/doc/pardes/cheatsheet.pdf + zig build cheatsheet -Dplatform=tui --prefix DIR # DIR/share/doc/pardes/cheatsheet.pdf typst compile --root . --ignore-system-fonts docs/typ/book.typ typst compile --root . --format bundle --features bundle,html docs/site/site.typ OUT - zig build site -Dplatform=tty --prefix DIR # DIR/share/doc/pardes/site/ + zig build site -Dplatform=tui --prefix DIR # DIR/share/doc/pardes/site/ (--root . because book and HTML read the tutor from src/tutor.txt.) The contract for content files @@ -45,7 +45,7 @@ new function instead. word(w) a builtin or tag word, drawn as a chip on the tag's ground; a builtin links to its entry in the Builtins chapter wherever that chapter is in the same output. - #word("Save") #word("Tty+bash") + #word("Save") #word("Term+bash") key(k) one press, or a sequence of presses separated by spaces, drawn as one pill (Ctrl + w, g › g). Modifiers: Ctrl-, Alt-, Shift-. @@ -59,7 +59,7 @@ new function instead. #chord("B2", "B1") #chord("B1", "B2", "B3") tag(words, path:) a whole default tagline; words must be a default tag. - #tag("Save Tty Collapse Del", path: "/home/me/notes.txt") + #tag("Save Term Collapse Del", path: "/home/me/notes.txt") addr(a) a look address. #addr("file:12:5") file(p) a 9P path. #file("pane/N/addr") cmd(c) a shell line, as a block. #cmd("echo Save > $m/pane/$n/ctl") @@ -102,12 +102,12 @@ new function instead. Builtins -------- -builtins-tty.json and builtins-gui.json are every builtin of the terminal +builtins-tui.json and builtins-gui.json are every builtin of the terminal and the window build (name, leader, Help's other shortcuts, arg, scope, -setting, choices, doc), written by `zig build builtins-json -Dplatform=tty` +setting, choices, doc), written by `zig build builtins-json -Dplatform=tui` and `-Dplatform=gui` from the registry and the Help rows (src/builtins_json.zig). style.typ merges them, marking each word "both", -"tty" or "gui". The doc steps refresh their build's file first, and each +"tui" or "gui". The doc steps refresh their build's file first, and each build's unit-test fails when its file is stale. #word takes a name from either file. builtins.typ draws it as the glossary; `everyday`, `internals` and `builtin-groups` in style.typ say diff --git a/docs/typ/building.typ b/docs/typ/building.typ index c6ca4e36..24229f08 100644 --- a/docs/typ/building.typ +++ b/docs/typ/building.typ @@ -17,7 +17,7 @@ builds MuPDF and is on by default (`-Dmupdf=false` drops it). 9P over QUIC #pairs( [`zig build`], [the terminal shell and the SDL window together, *installed into `~/.local/bin`* (`pardes` and `pardes-gui`)], - [`zig build -Dplatform=tty`], [the terminal shell alone], + [`zig build -Dplatform=tui`], [the terminal shell alone], [`zig build -Dplatform=gui`], [the SDL3 window alone], [`zig build web -Dplatform=web -Dtarget=wasm32-freestanding -Ddump=<file>`], [a freestanding wasm core plus vanilla JavaScript (`docs/web.md`)], [`zig build -Dplatform=macos`], [an AppKit and CoreText app over a static `libpardes.a` (`docs/macos.md`)], @@ -45,7 +45,7 @@ there; its namespace is in `src/esp32p4_gpio.zig`. `zig build --help` lists the options for the selected platform. #pairs( - [`-Dplatform`], [`tty`, `gui`, `web`, `macos`, `esp32p4`; absent: the tty and SDL shells together, installed into `~/.local`], + [`-Dplatform`], [`tui`, `gui`, `web`, `macos`, `esp32p4`; absent: the tui and SDL shells together, installed into `~/.local`], [`-Dstatic`], [bool, `false`], [`-Dquic`], [bool, `false`: 9P over QUIC with system OpenSSL 3.6+], [`-Dmupdf`], [bool; on natively, off for web and esp32p4], @@ -75,7 +75,7 @@ zig build core-test core tests without native shell tests zig build pane-test pane, output, PDF and namespace integration tests zig build kitty-test kitty graphics conformance of terminal panes, at the core zig build kitty-harness kitty graphics through a pane end to end (a fake kitty - terminal outside on the tty, the GPU capture on the gui; + terminal outside on the tui, the GPU capture on the gui; kitten icat and chafa too when installed) zig build syntax-test tree-sitter tests without building the editor zig build syntax deterministic per-byte highlighting snapshots @@ -104,7 +104,7 @@ zig build cheatsheet render the cheatsheet PDF (needs typst) reading its diff, never all), `snap -- --no-retry` makes the first failure decisive. Snapshot scripts can use `snap9p` to capture core cells through 9P. -- `zig build monkey -Dplatform=tty -- <seeds> [steps] [--from=N] [--out=DIR] [--keep]` writes one random script per seed and keeps any +- `zig build monkey -Dplatform=tui -- <seeds> [steps] [--from=N] [--out=DIR] [--keep]` writes one random script per seed and keeps any that panics; a seed always makes the same script. Each crash found gets a fix and a regression script in `test/snapshots/`. - The tutor's practice blocks (`# keys:`, `# before`, `# after` in @@ -126,10 +126,10 @@ zig build cheatsheet render the cheatsheet PDF (needs typst) == Release gates -A release passes all of these first: `unit-test` with `-Dplatform=tty` and +A release passes all of these first: `unit-test` with `-Dplatform=tui` and with `-Dplatform=gui`, `core-test`, `behaviour-test`, `process-test`, `snap`, the GUI goldens (`python3 -B test/gui_golden.py <a Debug pardes-gui>`, a hidden window), -`web`, and the ReleaseSafe tty and ReleaseFast gui builds. The committed +`web`, and the ReleaseSafe tui and ReleaseFast gui builds. The committed `docs/typ/cheatsheet-a4.pdf` is rendered again when the docs change. = Sending patches <patches> @@ -142,7 +142,7 @@ Mail patches to the list `~gbrls/[email protected]`; it is the preferred way to = The core and its shells -One core, five shells (tty, gui, web, macos, esp32p4). The core owns +One core, five shells (tui, gui, web, macos, esp32p4). The core owns editing, layout, rendering and the virtual filesystem it serves over 9P; a shell turns native input into `pardes.Event`, presents `pardes.Surface`, and performs host effects such as spawning processes. @@ -165,7 +165,7 @@ effects such as spawning processes. that the tests use. Comptime decides what a build has (`pardes.platform`, `hosted`, `can_attach`, `terminal_panes`, `pdf_enabled`); the vtable decides who serves it. -- The root module is chosen by platform: `main.zig` (tty, gui), +- The root module is chosen by platform: `main.zig` (tui, gui), `web.zig`, `macos.zig`, `esp32p4.zig`. The web and macOS shells are libraries whose host owns `main()`. - `memory.limits` is the one home for capacities that differ on the ESP32-P4 diff --git a/docs/typ/builtins-gui.json b/docs/typ/builtins-gui.json index c7553186..a78c2af0 100644 --- a/docs/typ/builtins-gui.json +++ b/docs/typ/builtins-gui.json @@ -137,6 +137,7 @@ {"name": "Tab", "leader": null, "also": [], "arg": true, "scope": "root", "setting": true, "choices": null, "doc": "A tab's width in cells, 1 through 16, in every pane; bare, it says the width."}, {"name": "Tagbottom", "leader": "SPC t b", "also": [], "arg": true, "scope": "root", "setting": true, "choices": "on, off", "doc": "Each pane's tag goes at its foot rather than its head, on or off."}, {"name": "TaglineSize", "leader": null, "also": [], "arg": true, "scope": "root", "setting": true, "choices": null, "doc": "Scale the tag font, a percentage."}, + {"name": "Term", "leader": "SPC n t", "also": [], "arg": true, "scope": "pane", "setting": false, "choices": null, "doc": "A shell in the calling pane's directory, raw from the first frame."}, {"name": "TermImages", "leader": null, "also": [], "arg": true, "scope": "root", "setting": true, "choices": "real, petscii", "doc": "How a new terminal draws its program's kitty graphics: real, as pixels where it can, or petscii, as glyph art."}, {"name": "Theme", "leader": null, "also": [], "arg": true, "scope": "root", "setting": true, "choices": null, "doc": "Switch to the named theme."}, {"name": "ThemeFile", "leader": null, "also": [], "arg": true, "scope": "root", "setting": false, "choices": null, "doc": "Load a theme from a file."}, @@ -145,7 +146,6 @@ {"name": "Togglettymode", "leader": null, "also": [], "arg": false, "scope": "pane", "setting": false, "choices": null, "doc": "Switch this terminal between raw program input and normal editor mode."}, {"name": "TreeContext", "leader": null, "also": [], "arg": true, "scope": "pane", "setting": false, "choices": null, "doc": "Show the declarations enclosing the top row at the pane's head, on or off."}, {"name": "TreeContextTagStyle", "leader": null, "also": [], "arg": true, "scope": "root", "setting": true, "choices": "on, off", "doc": "A pane's TreeContext rows draw in the tag's style, on or off."}, - {"name": "Tty", "leader": "SPC n t", "also": [], "arg": true, "scope": "pane", "setting": false, "choices": null, "doc": "A shell in the calling pane's directory, raw from the first frame."}, {"name": "Tutor", "leader": "SPC h t", "also": ["topbar"], "arg": false, "scope": "root", "setting": false, "choices": null, "doc": "Open the tutor, a document to work through."}, {"name": "Unattach", "leader": null, "also": [], "arg": false, "scope": "pane", "setting": false, "choices": null, "doc": "Unattach a pane from the pane it answers for: it stays where it is, a pane of its own, and the next search from that pane opens another under it."}, {"name": "Undo", "leader": null, "also": [], "arg": false, "scope": "pane", "setting": false, "choices": null, "doc": "acme's Undo and Redo: step the pane's body back or forward through its edits, from a tag, a pane ctl or exec."}, diff --git a/docs/typ/builtins-tty.json b/docs/typ/builtins-tui.json index 613627a7..7592a745 100644 --- a/docs/typ/builtins-tty.json +++ b/docs/typ/builtins-tui.json @@ -120,6 +120,7 @@ {"name": "SyntaxBold", "leader": null, "also": [], "arg": true, "scope": "root", "setting": true, "choices": "on, off", "doc": "Keywords and the like are drawn bold, on or off."}, {"name": "Tab", "leader": null, "also": [], "arg": true, "scope": "root", "setting": true, "choices": null, "doc": "A tab's width in cells, 1 through 16, in every pane; bare, it says the width."}, {"name": "Tagbottom", "leader": "SPC t b", "also": [], "arg": true, "scope": "root", "setting": true, "choices": "on, off", "doc": "Each pane's tag goes at its foot rather than its head, on or off."}, + {"name": "Term", "leader": "SPC n t", "also": [], "arg": true, "scope": "pane", "setting": false, "choices": null, "doc": "A shell in the calling pane's directory, raw from the first frame."}, {"name": "TermImages", "leader": null, "also": [], "arg": true, "scope": "root", "setting": true, "choices": "real, petscii", "doc": "How a new terminal draws its program's kitty graphics: real, as pixels where it can, or petscii, as glyph art."}, {"name": "Theme", "leader": null, "also": [], "arg": true, "scope": "root", "setting": true, "choices": null, "doc": "Switch to the named theme."}, {"name": "ThemeFile", "leader": null, "also": [], "arg": true, "scope": "root", "setting": false, "choices": null, "doc": "Load a theme from a file."}, @@ -128,7 +129,6 @@ {"name": "Togglettymode", "leader": null, "also": [], "arg": false, "scope": "pane", "setting": false, "choices": null, "doc": "Switch this terminal between raw program input and normal editor mode."}, {"name": "TreeContext", "leader": null, "also": [], "arg": true, "scope": "pane", "setting": false, "choices": null, "doc": "Show the declarations enclosing the top row at the pane's head, on or off."}, {"name": "TreeContextTagStyle", "leader": null, "also": [], "arg": true, "scope": "root", "setting": true, "choices": "on, off", "doc": "A pane's TreeContext rows draw in the tag's style, on or off."}, - {"name": "Tty", "leader": "SPC n t", "also": [], "arg": true, "scope": "pane", "setting": false, "choices": null, "doc": "A shell in the calling pane's directory, raw from the first frame."}, {"name": "Tutor", "leader": "SPC h t", "also": ["topbar"], "arg": false, "scope": "root", "setting": false, "choices": null, "doc": "Open the tutor, a document to work through."}, {"name": "Unattach", "leader": null, "also": [], "arg": false, "scope": "pane", "setting": false, "choices": null, "doc": "Unattach a pane from the pane it answers for: it stays where it is, a pane of its own, and the next search from that pane opens another under it."}, {"name": "Undo", "leader": null, "also": [], "arg": false, "scope": "pane", "setting": false, "choices": null, "doc": "acme's Undo and Redo: step the pane's body back or forward through its edits, from a tag, a pane ctl or exec."}, diff --git a/docs/typ/builtins.typ b/docs/typ/builtins.typ index 8375d5de..be069823 100644 --- a/docs/typ/builtins.typ +++ b/docs/typ/builtins.typ @@ -1,5 +1,5 @@ // Every builtin: the words you click in a tag (Exec runs them) or type as -// commands. The entries come from docs/typ/builtins-tty.json and +// commands. The entries come from docs/typ/builtins-tui.json and // builtins-gui.json, which // `zig build builtins-json` writes from the registry and the Help rows, // so this chapter and Help cannot drift. diff --git a/docs/typ/cheatsheet.typ b/docs/typ/cheatsheet.typ index a70b56e2..0e984efe 100644 --- a/docs/typ/cheatsheet.typ +++ b/docs/typ/cheatsheet.typ @@ -25,10 +25,10 @@ One button: Alt/Option-click is #btn("B2"), Cmd/Super-click #btn("B3"), sweeps t == Tags #tag("Newcol Joincol Find Grep Help Changelog Tutor Dump Themes Config Debug Exit") -#tag("New Tty Find Grep Joincol Delcol") -#tag("Save Tty Collapse Del", path: "/home/me/notes.txt") -#tag("Tty+bash Save Mode Filter Collapse Del", path: "/home/me/src") -#tag("Tty PdfSections PdfTint PdfFit Collapse Del", path: "manual.pdf [1/12]") +#tag("New Term Find Grep Joincol Delcol") +#tag("Save Term Collapse Del", path: "/home/me/notes.txt") +#tag("Term+bash Save Mode Filter Collapse Del", path: "/home/me/src") +#tag("Term PdfSections PdfTint PdfFit Collapse Del", path: "manual.pdf [1/12]") - #word("Del") over unsaved text refuses once; again discards. #word("Del") `j`: rows below. #key("SPC d") between two panes takes #key("k") (rows above) or #key("j") (below), asking only if you pause. - #word("Undo") #word("Redo") #word("Edit") #word("Mode") work typed anywhere. #doc("tags") @@ -91,7 +91,7 @@ Helix-style: motions *select*, then an edit acts on the selection. Mode box: bla key("SPC s s"), [declarations], key("SPC f c"), word("Config"), key("SPC d"), word("Del"), - key("SPC n t"), word("Tty"), + key("SPC n t"), word("Term"), key("SPC w"), word("Window"), key("SPC j j"), word("Last"), key("SPC j l"), word("Jumplist"), @@ -111,7 +111,7 @@ Helix-style: motions *select*, then an edit acts on the selection. Mode box: bla ) == Terminals and commands -- #key("Ctrl-b"): raw (`$`) or normal. #word("Mode") cycles raw, normal, insert. #word("Filter"), #word("Tty+bash"). +- #key("Ctrl-b"): raw (`$`) or normal. #word("Mode") cycles raw, normal, insert. #word("Filter"), #word("Term+bash"). - #btn("B2") on a non-builtin line runs it in a *command pane*: #tag("Kill Save Collapse Del", path: "/home/me/src (make) exit 0") - #word("Kill") `make` stops it; #word("Exit") quits. #word("Repl") `python`: `.py` clicks go to it. diff --git a/docs/typ/guide.typ b/docs/typ/guide.typ index 74a0df86..d45f5cc5 100644 --- a/docs/typ/guide.typ +++ b/docs/typ/guide.typ @@ -32,7 +32,7 @@ Each pane keeps its own mode. The box left of its tag shows it. #pairs( [#mode-box(" ") normal], [keys move and select; an edit acts on the selection. File and PDF panes start here, and so does a terminal from #key("Alt-n").], [#mode-box("^") insert], [keys type. #keys("i", "a", "o") and the rest enter it.], - [#mode-box("$") raw, terminals only], [keys go to the program. A terminal from #word("Tty"), the shell a bare `pardes` starts with, and a command pane start here.], + [#mode-box("$") raw, terminals only], [keys go to the program. A terminal from #word("Term"), the shell a bare `pardes` starts with, and a command pane start here.], ) #key("Ctrl-b") switches a terminal between raw and normal. In normal, @@ -93,8 +93,8 @@ the registers. #key("SPC y") and #key("SPC p") use the system clipboard. = Tags <tags> #tag("Newcol Joincol Find Grep Help Changelog Tutor Dump Themes Config Debug Exit") -#tag("New Tty Find Grep Joincol Delcol") -#tag("Save Tty Collapse Del", path: "/home/me/notes.txt") +#tag("New Term Find Grep Joincol Delcol") +#tag("Save Term Collapse Del", path: "/home/me/notes.txt") A tag is text with undo. Type `make` into one and #word("Exec") it, or delete the words you never use. Any word runs from any tag: #word("Exit") @@ -227,10 +227,10 @@ do nothing. = Terminals <terminals> -#tag("Tty+bash Save Mode Filter Collapse Del", path: "/home/me/src") +#tag("Term+bash Save Mode Filter Collapse Del", path: "/home/me/src") -- #word("Tty") opens a terminal in the pane's directory, #key("Alt-n") one in - the session's directory; #word("Tty+bash") picks the shell. +- #word("Term") opens a terminal in the pane's directory, #key("Alt-n") one in + the session's directory; #word("Term+bash") picks the shell. - #word("Del") closes a terminal and its shell at once, running or not, and a shell that exits closes its pane. - #word("Save") writes the scrollback to a path it asks for. diff --git a/docs/typ/install.typ b/docs/typ/install.typ index d97d30f7..7489d069 100644 --- a/docs/typ/install.typ +++ b/docs/typ/install.typ @@ -20,6 +20,6 @@ With Zig 0.17 (the build fetches everything else; once that is downloaded, a first build from a clean cache took 62 seconds on 16 cores): -#cmd("# pardes, in a terminal\nzig build -Dplatform=tty --prefix ~/.local") +#cmd("# pardes, in a terminal\nzig build -Dplatform=tui --prefix ~/.local") #cmd("# pardes-gui, its own window\nzig build -Dplatform=gui --prefix ~/.local") Then run `pardes` or `pardes FILE`. diff --git a/docs/typ/reference.typ b/docs/typ/reference.typ index b272306c..0669780a 100644 --- a/docs/typ/reference.typ +++ b/docs/typ/reference.typ @@ -39,7 +39,7 @@ tagexec a word clicked in the workspace tag @co col/ the columns @columns-and-tags <n>/ column <n>; rmdir closes it when empty @columns-and-tags tag its tag - ctl its builtins (Delcol Joincol New Tty) + ctl its builtins (Delcol Joincol New Term) exec a word clicked in its tag pane/ the panes @panes new open it to make a pane; read answers the serial @panes @@ -291,6 +291,7 @@ A line written to #file("exec") is #word("Exec"): `Abort`) are refused, `invalid: acme's Snarf is not a pardes builtin: ...`, never run as commands. So is a GUI-only builtin (#word("Fonts")) on another frontend. +- `Tty` is #word("Term")'s old name, run as it, `Tty+fish` too. - Anything else is a command line (a typo ends `exit 127`), at most 1024 bytes, run as the guide says (#doc("tags", section: "command-panes")): typed into a terminal idle at an empty prompt, else run in a command pane. #file("exec") reads back @@ -399,7 +400,7 @@ Writes take settings and session builtins (`scope = .session` in rows (`size: too small for the panes, each its tag and 2 rows`). A bad `size` is refused quoting the value it got (`"5 2"`). -A word that takes its argument after a `+` (#word("Tty+bash")) works on a ctl as +A word that takes its argument after a `+` (#word("Term+bash")) works on a ctl as in a tag. A write is refused whole, before anything runs, in Plan 9's words: `unknown control message "X"`, `wrong #args in control message "X"`, `bad value in control message ...`, or a word of the other ctl: `not a session control message "Undo": write it to pane/<n>/ctl`, `... "Delcol": write it to col/<serial>/ctl`, `not a window control message "X": write it to /ctl`. A builtin that would open a prompt (#word("Save") on a scratch) @@ -431,7 +432,7 @@ word clicked in a tag does. The same lines go in the startup file [#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("JumpScope") `file|all`], [`file`: #word("Back") and #word("Forward") keep to the focused pane's file, that pane's places first, then the file's in another pane, and go to another file only when the file has no place left that way; from a terminal or a pane with no file they step through every place; `all`: every place, in the order it was jumped to], - [#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("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 tui 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], [#word("TreeContext")], [off: sticky declaration headers in a source pane (per pane, dumped)], @@ -500,7 +501,7 @@ and leave one under its tag and two rows (`Newcol: no space for a column: the pa alone and uses up no column serial. #file("/col/<n>/ctl") takes #word("Delcol"), #word("Joincol"), -#word("New") and #word("Tty") for that column; #file("/col/<n>/exec") is +#word("New") and #word("Term") for that column; #file("/col/<n>/exec") is a click in its tag; `rmdir /col/<n>` closes an empty column (one with panes: ENOTEMPTY). Closing a column's last pane leaves it empty (the keyboard goes to its tag, #file("focus") reads empty, the log says only @@ -534,7 +535,7 @@ tag would (#doc("fs", section: "placement")): in the active column, filling it if empty, else the bottom half of its last pane. A session holds 64 panes (`no space for a pane: 64 max`), and every pane keeps its tag and 2 rows (`no space for a pane in that column: each keeps its tag and 2 rows`); both are ENOSPC, for this open and for #word("Look"), #word("Exec"), -#word("New") or #word("Tty") alike. A #file("pane/new") whose column is +#word("New") or #word("Term") alike. A #file("pane/new") whose column is full takes its rows from a pane in another column that has them, last column first, as acme does, and is refused only when no pane anywhere can give them. `rmdir /pane/<n>` closes the pane, unsaved or not. @@ -608,7 +609,7 @@ takes: below), #word("Save") `[path]` (bare, on a `+`-named pane that is no output, such as `+Tutor`, it asks for a path; making the directories the file goes in first, whichever name it writes), #word("Collapse"), #word("Undo")/#word("Redo") - (256 steps each), #word("Find") `pat`, #word("Edit") `...`, #word("Tty") `[shell]` (a new terminal + (256 steps each), #word("Find") `pat`, #word("Edit") `...`, #word("Term") `[shell]` (a new terminal in its directory), #word("Delcol") for its column, and #word("Left")/#word("Right")/#word("Up")/#word("Down"), which give the keyboard to the pane beside it that way, up from a column's top pane to @@ -988,7 +989,7 @@ asked, else the active column (last typed or left-clicked in, dropped into, its tag given the keyboard, or given the last new pane), never a new column. An empty column it takes whole; #word("New") and #file("pane/new") take the bottom half of the column's last pane; a pane -opened from a pane's text (#word("Look"), #word("Tty"), #key("Alt-n")) goes under +opened from a pane's text (#word("Look"), #word("Term"), #key("Alt-n")) goes under the pane with the most blank rows, or halves the biggest. #word("New") in a pane's tag names its `+New` in that pane's directory and column; from a column tag, in that column and the session's directory. A command pane @@ -1162,7 +1163,7 @@ with Client(sys.argv[1]) as c: # a socket path, or (ip, port) [`Font`, `Send`, `ID`], [#word("Font"); #word("Repl") and #word("Exec"); `$winid`], [acme's other builtins], [refused: `Sort`, `Local`, `Abort` (plan9port's debugging word)], [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("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], + [`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; #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"))], diff --git a/docs/typ/style.typ b/docs/typ/style.typ index b5c2ff85..e2eafc87 100644 --- a/docs/typ/style.typ +++ b/docs/typ/style.typ @@ -186,16 +186,16 @@ /// Every builtin of either build, written by `zig build builtins-json` /// from the registry and the Help rows (src/builtins_json.zig), a file per /// build: name, leader, also (Help's other shortcuts), arg, scope, setting, -/// choices, doc. Merged here, each with `platforms`: "both", "tty" (the +/// choices, doc. Merged here, each with `platforms`: "both", "tui" (the /// terminal only) or "gui" (the window only). #let builtin-data = { - let tty = json("builtins-tty.json") + let tui = json("builtins-tui.json") let gui = json("builtins-gui.json") - let in-tty = tty.map(b => b.name) + let in-tui = tui.map(b => b.name) let in-gui = gui.map(b => b.name) - let all = (tty + gui.filter(b => b.name not in in-tty)).sorted(key: b => b.name) + let all = (tui + gui.filter(b => b.name not in in-tui)).sorted(key: b => b.name) all.map(b => { - b.insert("platforms", if b.name in in-tty and b.name in in-gui { "both" } else if b.name in in-tty { "tty" } else { "gui" }) + b.insert("platforms", if b.name in in-tui and b.name in in-gui { "both" } else if b.name in in-tui { "tui" } else { "gui" }) b }) } @@ -367,7 +367,7 @@ /// The newcomer's words, first in the glossary; every other builtin goes /// under its group below. Each must be in builtins.json. #let everyday = ("Look", "Exec", "Save", "Undo", "Redo", "New", "Newcol", "Del", "Delcol", - "Tty", "Kill", "Find", "Grep", "Recent", "Dump", "Restore", "Exit", "Help", "Tutor", "Themes", "Config") + "Term", "Kill", "Find", "Grep", "Recent", "Dump", "Restore", "Exit", "Help", "Tutor", "Themes", "Config") /// Debugging and developer words, last whatever their leader path. #let internals = ("Debug", "EffectCode", "Lspwhy", "Messages", "DumpConfig", "DumpThemes") diff --git a/docs/typ/themes.typ b/docs/typ/themes.typ index edfaa7ad..6dc92b3b 100644 --- a/docs/typ/themes.typ +++ b/docs/typ/themes.typ @@ -39,7 +39,7 @@ syntax identity but are not exact ports; their sources are in pane's and column's tags shift tone on tone rather than invert: dark palettes keep dark tags, light ones light tags. The file name in a pane's path, and `+Search` and the like, take a distinct hue at the same -brightness as the tag text; a terminal's tag tints its #word("Tty") word +brightness as the tag text; a terminal's tag tints its #word("Term") word instead. Every native palette sets its own ANSI colours, so a terminal's indexed @@ -110,7 +110,7 @@ take `null`, so older files stay valid: #pairs( [`tag_active_bg`, `tag_active_fg`], [the focused pane's tag; a ground closer than 1.25:1 to `tag_bg` is pushed further the way it leans, as far as its text keeps its contrast. Absent: `tag_bg`, `tag_fg`], - [`tag_name_fg`, `tag_active_name_fg`], [the file name's or a terminal's #word("Tty") tint, in normal and focused tags. Absent: the tag's foreground], + [`tag_name_fg`, `tag_active_name_fg`], [the file name's or a terminal's #word("Term") tint, in normal and focused tags. Absent: the tag's foreground], [`column_box`, `column_box_dim`], [a column's grip held (and its drag rail), and at rest. Absent: `num`; a mix of `column_box` and `tag_bg`], [`border`], [quiet separators, lifted to 1.6:1 when under 1.5:1 off the page. Absent: `scroll_track`], [`empty_col`], [a column with no pane, under its tag (acme: white). Absent: `border`], |
