summaryrefslogtreecommitdiff
path: root/docs/typ/cheatsheet.typ
diff options
context:
space:
mode:
authorGabriel Schneider <[email protected]>2026-10-01 12:48:17 -0300
committerGabriel Schneider <[email protected]>2026-10-01 12:58:23 -0300
commita99edf403dbcebae2ce557e2ba39078ffe876a92 (patch)
treeab2b7de7934124c0f63c51737b6c651cf4e0dd98 /docs/typ/cheatsheet.typ
parent0c3f1694ad547d734b332b1f69620e8df7bcf97c (diff)
downloadpardes-a99edf403dbcebae2ce557e2ba39078ffe876a92.tar.gz
pardes-a99edf403dbcebae2ce557e2ba39078ffe876a92.zip
Builtins are written by name: each chapter and the tutor define Look and Exec once and then say Look and Exec; the cheatsheet draws every mouse button as its icon; one-button clicks (Alt is B2, Super is B3) are in the guide and cheatsheet; building says how to send patches to the list
Co-Authored-By: Claude Opus 5.5 <[email protected]>
Diffstat (limited to 'docs/typ/cheatsheet.typ')
-rw-r--r--docs/typ/cheatsheet.typ27
1 files changed, 14 insertions, 13 deletions
diff --git a/docs/typ/cheatsheet.typ b/docs/typ/cheatsheet.typ
index 1291d838..c4be1641 100644
--- a/docs/typ/cheatsheet.typ
+++ b/docs/typ/cheatsheet.typ
@@ -7,20 +7,21 @@
== The mouse
#pairs(
btn("B1"), [select, and focus the pane. On a tag: type there.],
- btn("B2"), [*execute* the word or selection: a builtin, else a shell line.],
- btn("B3"), [*look*: open the file, address, directory or URL, else find the word's next place. Resting the pointer tints what B3 would take.],
- [sweep], [drag B2 or B3 to run or look at exactly what you swept.],
+ btn("B2"), [#word("Exec") the word or selection: a builtin, else a shell line.],
+ btn("B3"), [#word("Look"): open the file, address, directory or URL, else find the word's next place. Resting the pointer tints what #btn("B3") would take.],
+ [sweep], [drag #btn("B2") or #btn("B3") to #word("Exec") or #word("Look") exactly what you swept.],
[grip], [drag the box left of a tag: up/down resizes, onto another column moves the pane. A column's right edge drags its width.],
)
=== Chords: hold the first, click the next
#pairs(
- chord("B1", "B2"), [cut the B1 selection],
+ chord("B1", "B2"), [cut the #btn("B1") selection],
chord("B1", "B3"), [paste over it],
- chord("B1", "B2", "B3"), [copy: cut, then paste back, B1 still down],
- chord("B2", "B1"), [execute the word with the B1 selection as argument (#word("Grep") on a selected name)],
+ chord("B1", "B2", "B3"), [copy: cut, then paste back, #btn("B1") still down],
+ chord("B2", "B1"), [#word("Exec") the word with the #btn("B1") selection as argument (#word("Grep") on a selected name)],
chord("B2", "B3"), [cancel the sweep (#chord("B3", "B2") too)],
)
Over a program that takes the mouse, Shift swaps: #btn("B1", shift: true) selects, #btn("B2", shift: true) goes to the program.
+One button: Alt/Option-click is #btn("B2"), Cmd/Super-click #btn("B3"), sweeps too (a terminal passes only Alt); Ctrl-click is a definition; a program that takes the mouse gets the plain click.
== Tags
#tag("Newcol Joincol Find Grep Help Changelog Tutor Dump Themes Config Debug Exit")
@@ -28,17 +29,17 @@ Over a program that takes the mouse, Shift swaps: #btn("B1", shift: true) select
#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 Collapse Del", path: "manual.pdf [1/12]")
-- #word("Del") over unsaved text refuses once; again discards. `Del j`: rows below.
+- #word("Del") over unsaved text refuses once; again discards. #word("Del") `j`: rows below.
- #word("Undo") #word("Redo") #word("Edit") #word("Mode") work typed anywhere. #doc("tags")
-== Look addresses
+== #word("Look") addresses
Typed anywhere, then #btn("B3") or #key("Enter"):
#pairs(
addr("file:12"), [line 12],
addr("file:12:5"), [line 12, byte column 5],
addr("file:/re/"), [next match after the selection (`file:0/re/`: first)],
addr(":40"), [the pane looked from, line 40 (`:40:5`, any address after `:`)],
- addr("~/x"), [home; also in `Save`, `Restore`, `pardes ~/x`],
+ 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],
)
@@ -63,7 +64,7 @@ Helix-style: motions *select*, then an edit acts on the selection. Mode box: bla
[#key("|")], [pipe each selection through the shell],
[#keys("g d", "g r")], [definition, references (language server)],
[#keys("Ctrl-d", "Ctrl-u")], [half page down, up],
- [#keys("Enter", "Tab")], [look, execute the selection (like #btn("B3"), #btn("B2"))],
+ [#keys("Enter", "Tab")], [#word("Look"), #word("Exec") the selection (like #btn("B3"), #btn("B2"))],
[#key(":")], [to the pane's tag and back],
)
#doc("keys")
@@ -112,7 +113,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").
- #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. `Repl python`: `.py` clicks go to it.
+- #word("Kill") `make` stops it; #word("Exit") quits. #word("Repl") `python`: `.py` clicks go to it.
== Reviewing diffs
`git diff` output is a diff: #btn("B3") on a file line, an `@@` or a line's `+`/`-` jumps there. #doc("tags", section: "reviewing-diffs")
@@ -124,7 +125,7 @@ Helix-style: motions *select*, then an edit acts on the selection. Mode box: bla
`pardes --detach=work`; `--attach=work` or #word("Attach") `work`; #word("Detach") leaves it running. #doc("detached")
== Config
-#word("Config") (#key("SPC f c")): `~/.config/pardes/init`, a builtin a line (`Theme atelier`). #word("DumpConfig"): every setting. #word("Dump") / #word("Restore"): the workspace. #doc("config")
+#word("Config") (#key("SPC f c")): `~/.config/pardes/init`, a builtin a line (#word("Theme") `atelier`). #word("DumpConfig"): every setting. #word("Dump") / #word("Restore"): the workspace. #doc("config")
== Themes
#word("Themes") lists them; #word("Theme") `name`; #word("NextColor"); #word("ThemeFile") `x.zon`. #doc("themes")
@@ -139,7 +140,7 @@ Pane shells get `$PARDES_9P` (the socket) and `$PARDES_PANE` (their own pane); a
file("log"), [events; write `follow` to wait],
file("pane/new"), [open to make a pane],
file("pane/N/addr"), [an address; `data` reads/replaces it],
- file("pane/N/ctl"), [builtins: `Save`, `Edit ...`],
+ file("pane/N/ctl"), [builtins: #word("Save"), #word("Edit") `...`],
file("pane/N/body tag"), [its text (`>>` appends)],
)
#cmd("echo notes.txt:12 > $m/pane/$n/look")