summaryrefslogtreecommitdiff
path: root/docs/typ/README
diff options
context:
space:
mode:
authorGabriel Schneider <[email protected]>2026-11-04 20:54:21 -0300
committerGabriel Schneider <[email protected]>2026-11-04 21:12:33 -0300
commit0ff1fc99eb870f8a1e714a71c1a853066737c822 (patch)
tree2c8b4720e2ed190e6f9062cfe8586c3da22aeb42 /docs/typ/README
parent3b082687c7da1c5d8cc52c71fdf4ddd38d860cd8 (diff)
downloadpardes-0ff1fc99eb870f8a1e714a71c1a853066737c822.tar.gz
pardes-0ff1fc99eb870f8a1e714a71c1a853066737c822.zip
rename: the terminal frontend is the tui (-Dplatform=tui, src/tui/tui.zig, --tui with --tty kept as its old spelling, the process tests' backend .tui and --backend=tui, docs/typ/builtins-tui.json, the Settings report's platform), and the builtin Tty is Term (its registry entry, SPC n t, every default tag, the docs, tests and snap scripts), Tty still run as Term through exec.acme_words, Tty+fish too on a tag and a ctl; tty as a pane's raw mode and as the OS's terminal unchanged
Co-Authored-By: Claude Opus 5.5 <[email protected]> Claude-Session: https://claude.ai/code/session_016Y9MNAtZenFv4weoMD3cge
Diffstat (limited to 'docs/typ/README')
-rw-r--r--docs/typ/README14
1 files changed, 7 insertions, 7 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