summaryrefslogtreecommitdiff
path: root/docs/typ/reference.typ
diff options
context:
space:
mode:
authorGabriel Schneider <[email protected]>2026-10-01 13:18:06 -0300
committerGabriel Schneider <[email protected]>2026-10-01 13:21:02 -0300
commit16422d0f4c60ae90081163bf78b12d365ebb45ed (patch)
tree5bd80356bb7d4dab47a938d7e634ea0407e3bd87 /docs/typ/reference.typ
parent4252afe6f4558b55fa34846b182312d6a384b96e (diff)
downloadpardes-16422d0f4c60ae90081163bf78b12d365ebb45ed.tar.gz
pardes-16422d0f4c60ae90081163bf78b12d365ebb45ed.zip
The remaining builtins in the reference, setup and the cheatsheet's 9P tree are written as #word, the window-only ones included, so each links to its glossary entry
Co-Authored-By: Claude Opus 5.5 <[email protected]>
Diffstat (limited to 'docs/typ/reference.typ')
-rw-r--r--docs/typ/reference.typ50
1 files changed, 25 insertions, 25 deletions
diff --git a/docs/typ/reference.typ b/docs/typ/reference.typ
index 916f6b33..71005349 100644
--- a/docs/typ/reference.typ
+++ b/docs/typ/reference.typ
@@ -269,7 +269,7 @@ A line written to #file("exec") is #word("Exec"):
`Delete` a #word("Del") that does not ask); the rest (`Get`, `Putall`,
`Snarf`, `Cut`, `Paste`, `Zerox`, `Sort`, `Load`, `ID`, `Send`, `Tab`,
`Indent`, `Local`, `Incl`, `Abort`) are refused, `invalid: acme's Get is not a pardes builtin: ...`, never run as commands. So is a GUI-only
- builtin (`Fonts`) on another frontend.
+ builtin (#word("Fonts")) on another frontend.
- 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
@@ -335,7 +335,7 @@ Writes take settings and session builtins (`scope = .session` in
`src/builtins.zig`), acting at the pane with the keyboard:
- A setting written bare steps to its next value (a switch flips; so do
- #word("Placement"), #word("BootShell"), `Crt`). A value it does not
+ #word("Placement"), #word("BootShell"), #word("Crt")). A value it does not
take is `bad value in control message; ...` naming what it takes;
#file("/commands") lists them. A setting the frontend cannot show is
refused (`Lift is GUI-only, invalid here`).
@@ -384,9 +384,9 @@ runs fails with the editor's words (`Mount: already mounted`, `Save /root/x: acc
== Settings <settings>
A setting that chooses among words (`on`/`off` switches,
-#word("Placement"), #word("BootShell"), `Crt`, `Bloom`,
-`Vignette`, `Grain`, `Lift`, #word("Motion"),
-`ShaderAnimation`) steps to its next value when given bare, as its
+#word("Placement"), #word("BootShell"), #word("Crt"), #word("Bloom"),
+#word("Vignette"), #word("Grain"), #word("Lift"), #word("Motion"),
+#word("ShaderAnimation")) steps to its next value when given bare, as its
word clicked in a tag does. The same lines go in the startup file
(#doc("config")).
@@ -410,16 +410,16 @@ word clicked in a tag does. The same lines go in the startup file
[#word("TreeContextTagStyle")], [on: draw those headers in the tagline style],
[#word("LocationsConfig") `...`], [the layout of #word("Grep"), search and language-server results (below)],
[#word("Wrap"), #word("Colors"), #word("Tagbottom"), #word("Debug")], [toggles],
- [`Font <name>[:<size>]`, `Fonts`], [SDL and macOS only; size 8-72 (pixels in SDL, points on macOS)],
- [`TaglineSize <1-100>`], [82: tagline face, percent; SDL and macOS],
- [`WindowOpacity <0-100>`], [100; SDL only: everything but text and the cursor],
- [`Ligatures`], [on; SDL only, macOS draws CoreText's own],
- [`Pet cat|frog|off`], [off; SDL only: a sprite in the workspace tag's blank space],
+ [#word("Font") `<name>[:<size>]`, #word("Fonts")], [SDL and macOS only; size 8-72 (pixels in SDL, points on macOS)],
+ [#word("TaglineSize") `<1-100>`], [82: tagline face, percent; SDL and macOS],
+ [#word("WindowOpacity") `<0-100>`], [100; SDL only: everything but text and the cursor],
+ [#word("Ligatures")], [on; SDL only, macOS draws CoreText's own],
+ [#word("Pet") `cat|frog|off`], [off; SDL only: a sprite in the workspace tag's blank space],
)
#word("LocationsConfig") with no argument prints the current settings as a line
that can be run again; with fields it changes only those:
-`LocationsConfig context:5 tscontext:on tslocations:off layout:stacked`.
+#word("LocationsConfig") `context:5 tscontext:on tslocations:off layout:stacked`.
`context` (0) is the source lines shown above and below each match;
`tscontext` (off) includes the enclosing tree-sitter declaration headers;
`tslocations` (on) shows a location on each declaration header; `layout`
@@ -435,19 +435,19 @@ turning it off: #word("PanelSlide"), #word("PanelZoom"),
#word("PanelCurtain"), #word("PanelScramble"), #word("PanelType"); all
start off, and the web shell has none. Scene passes (the SDL window, and
one attached to a detached session), each at a level 0-3 (`on` is 2), all
-off: `Crt`, `Bloom`, `Vignette`, `Grain`.
-`Shader <file.glsl>` adds a Shadertoy file written for ghostty to the
-chain (`Shader off` removes it; it recompiles when saved);
-`ShaderAnimation off|on|always` says when the chain animates by itself. The
-focused pane can stand off the page: `Lift shadow|rim|auto|off`,
+off: #word("Crt"), #word("Bloom"), #word("Vignette"), #word("Grain").
+#word("Shader") `<file.glsl>` adds a Shadertoy file written for ghostty to the
+chain (#word("Shader") `off` removes it; it recompiles when saved);
+#word("ShaderAnimation") `off|on|always` says when the chain animates by itself. The
+focused pane can stand off the page: #word("Lift") `shadow|rim|auto|off`,
#word("InactiveDim") `<percent>`, #word("Motion") `off|crisp|smooth|bouncy|playful` (default
-`smooth`), `SelectionGlow`, `HoverGlow`, `Occlusion`,
-`Parallax`, #word("JumpTrail"), #word("ChipShadow"),
-#word("ThumbFlash"), `CursorBlink`, `GripWidth <50-300>`. Most are
+`smooth`), #word("SelectionGlow"), #word("HoverGlow"), #word("Occlusion"),
+#word("Parallax"), #word("JumpTrail"), #word("ChipShadow"),
+#word("ThumbFlash"), #word("CursorBlink"), #word("GripWidth") `<50-300>`. Most are
the GUI's; #word("InactiveDim") works everywhere, and #word("JumpTrail"),
#word("ChipShadow") and #word("ThumbFlash") are the terminal's. No effect
may lower the contrast of text, the selection or a focus indicator.
-`EffectCode <effect>` lists that effect's sources under `/virtual` when the
+#word("EffectCode") `<effect>` lists that effect's sources under `/virtual` when the
build embeds them.
Resting the pointer on text for about 32 ms (`look_preview_delay_frames`,
@@ -589,7 +589,7 @@ takes:
- `answer <choice>` to the question the pane asks on its message row,
logged `ask <serial> <what> <choices>` (`ask 4 del k j`, `ask 4 repl a b`, `ask 4 save path`); `answer -` takes it back.
- acme's lowercase ctl words, done by what replaces each: `name x`, `put`
- (Save), `clean`/`dirty`, `del`, `delete` (no asking), `dot=addr`,
+ (#word("Save")), `clean`/`dirty`, `del`, `delete` (no asking), `dot=addr`,
`addr=dot`, `limit=addr`, `mark`/`nomark`, `show`, `cleartag`. `dump`,
`dumpdir`, `font`, `menu`, `nomenu` are refused, EINVAL. These lowercase
words are ctl-only: written to an #file("exec"), `del` is a command line.
@@ -679,7 +679,7 @@ ceiling:
== Edit <edit>
#word("Edit") `<sam commands>` on a pane's #file("ctl") or #file("exec") (or the
-root's, at the pane with the keyboard) runs acme's Edit on the body: addresses as
+root's, at the pane with the keyboard) runs acme's #word("Edit") on the body: addresses as
above, commands `x y g v c a i d s p = m t u` and `{ }`. All changes are
one undo step, applied only if every command succeeds; a failure changes
nothing and fails the write with acme's words (`Edit: no substitution`).
@@ -859,7 +859,7 @@ at 200, ending in `…`. Control characters become spaces.
permitted (`permission denied`, EACCES through a mount); ownership is
synthetic. Linux v9fs's truncation `mtime` hint is accepted and dropped.
- #file("/src/") (and #file("/shaders") on GUI builds) with
- `-Dembed-sources=true`; `EffectCode <effect>` lists an effect's files
+ `-Dembed-sources=true`; #word("EffectCode") `<effect>` lists an effect's files
under `/virtual`.
= The pardes command <command-line>
@@ -940,11 +940,11 @@ it was.
absolute, else `~/.config/pardes/init` (macOS:
`~/Library/Application Support/pardes/init`). A line that fails is a
notice and `err - init file line N: why`, and the rest still run; a
- setting only the other frontend has (`Font` in a terminal) is skipped;
+ 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,
selections, the theme and changed settings, but not a picture or a PDF
- that is on disk (Restore reads it from there); a terminal
+ 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
directory; undo history and REPL bindings are not kept. A crash appends
two lines (build, time, platform, pid; the panic message) to `crashes`