summaryrefslogtreecommitdiff
path: root/src
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 /src
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 'src')
-rw-r--r--src/tutor.txt59
1 files changed, 31 insertions, 28 deletions
diff --git a/src/tutor.txt b/src/tutor.txt
index a6adcb35..dc9ceb87 100644
--- a/src/tutor.txt
+++ b/src/tutor.txt
@@ -10,8 +10,11 @@
The guide (docs/typ/guide.typ) explains; this is the hands-on part.
Each lesson is a few things to do, then names its guide section.
- Words in backticks, like `Save`, are builtins: type one in any tag
- and middle-click it. Lines starting with "| " are tags.
+ Words in backticks, like `Save`, are builtins. Two carry the rest:
+ `Exec` (middle-click, B2) runs the builtin a word names, or else
+ runs it as a shell line; `Look` (right-click, B3) opens what the
+ text names, or else finds it. Type a builtin in any tag and `Exec`
+ it. Lines starting with "| " are tags.
Press j until you reach part 1.
@@ -20,7 +23,7 @@
= PART 1 — MODES =
=================================================================
- 1. Look at the box left of this pane's tag: blank, so you are in
+ 1. The box left of this pane's tag is blank, so you are in
NORMAL mode. Press i: it shows ^ (INSERT). Type a word, then
Esc: blank again.
2. Press Esc once more, in NORMAL: the keyboard goes back to the
@@ -37,14 +40,14 @@
= PART 2 — THE MOUSE =
=================================================================
- 1. Right-click (B3) the word mouse in this sentence: the next mouse
- is selected.
- 2. Middle-click (B2) the word `Help` here: the list of keys opens.
+ 1. `Look` (B3) the word mouse in this sentence: the next mouse is
+ selected.
+ 2. `Exec` (B2) the word `Help` here: the list of keys opens.
Close it with `Del` in its tag.
3. Select a word with B1, keep B1 down, click B2: it is cut. Still
holding B1, click B3: it comes back. That pair is a copy.
- 4. Put the cursor on `Help` and press Tab: the same as B2. Enter
- is B3.
+ 4. Put the cursor on `Help` and press Tab: `Exec`, as B2. Enter
+ is `Look`, as B3.
-> Guide: The mouse
@@ -64,7 +67,7 @@
| Tty Collapse Del
1. Press : here: the keyboard goes to this pane's tag, on `Save`.
- Press A, type a space and Help, press Esc, then middle-click
+ Press A, type a space and Help, press Esc, then `Exec`
`Help` there. Press : again to come back.
2. Click `Collapse` in this tag: the pane folds to its tag. Click
it again.
@@ -77,9 +80,9 @@
= PART 4 — WHERE COMMANDS RUN AND PANES GO =
=================================================================
- 1. Type date on a line here and middle-click it: a command pane
+ 1. Type date on a line here and `Exec` it: a command pane
shows its output, and the keyboard stays here.
- 2. Middle-click `New` in this column's tag: a scratch opens and
+ 2. `Exec` `New` in this column's tag: a scratch opens and
takes the keyboard.
3. Ctrl-w h, j, k, l move the keyboard between panes; Ctrl-o and
Ctrl-i walk back and forward through where you have been.
@@ -89,15 +92,15 @@
=================================================================
-= PART 5 — LOOKING =
+= PART 5 — LOOK =
=================================================================
- 1. Right-click :20 here: the cursor goes to line 20 of this pane.
- 2. Right-click :/UNSAVED/ to go to the next match of UNSAVED.
+ 1. `Look` :20 here: the cursor goes to line 20 of this pane.
+ 2. `Look` :/UNSAVED/ to go to the next match of UNSAVED.
3. Press /, type keys, press Enter: a +Search lists the lines with
keys and the cursor goes to the first. n and N step through.
- -> Guide: Looking
+ -> Guide: Look
=================================================================
@@ -118,10 +121,10 @@
= PART 7 — UNSAVED PANES =
=================================================================
- 1. Middle-click `New`, type a few hundred characters, then `Del` it:
+ 1. `Exec` `New`, type a few hundred characters, then `Del` it:
it refuses once, saying so on the message row. `Del` again
discards it.
- 2. To quit pardes, press SPC q or middle-click `Exit` in the
+ 2. To quit pardes, press SPC q or `Exec` `Exit` in the
workspace tag; it refuses once over unsaved panes the same way.
-> Guide: Unsaved panes
@@ -255,7 +258,7 @@ typed
| filter every selection through the shell
/ case-insensitive SUBSTRING search, one hit a line; the
regex lives on s and S
- n / N the next/previous look-able text, as above
+ n / N the next/previous text `Look` would open, as above
Ctrl-c comment or uncomment the lines
VIEWPORT
@@ -273,7 +276,7 @@ typed
= 9.6 SPC — THE LEADER =
-----------------------------------------------------------------
- Nearly every builtin has a NAME you can execute wherever text lives
+ Nearly every builtin has a NAME you can `Exec` wherever text lives
and a KEY PATH you can press. SPC in NORMAL mode starts the path;
what you have typed shows on the message row until it fires. Esc
abandons it, and so does any key that leads nowhere.
@@ -303,12 +306,12 @@ typed
m=$PARDES_MOUNT the session, under 9ns
cat $m/index a line per pane
n=$(cat $m/pane/new) a pane of your own
- echo notes.txt:12 > $m/pane/$n/look a right click in it
+ echo notes.txt:12 > $m/pane/$n/look a `Look` in it
echo Save > $m/pane/3/ctl a builtin on pane 3
- While a program holds a pane's event file open, middle and right
- clicks in that pane come to it instead of acting, and writing a
- click back makes pardes perform it: arbitrary command execution by
+ While a program holds a pane's event file open, each `Exec` and
+ `Look` in that pane comes to it instead of acting, and writing one
+ back makes pardes perform it: arbitrary command execution by
design. The socket sits in your private runtime directory.
-> The Scripting chapter (docs/typ/scripting.typ)
@@ -324,10 +327,10 @@ typed
GUI; elsewhere it is a plain Esc)
Ctrl-b toggles RAW and NORMAL
- MOUSE L select/focus M execute R look
+ MOUSE L select/focus M `Exec` R `Look`
1-2 cut 1-3 paste 1-2 then 1-3 copy
- 2-1 execute the middle word with the left selection
- keyboard: Enter = look, Tab = execute
+ 2-1 `Exec` the middle word with the left selection
+ keyboard: Enter = `Look`, Tab = `Exec`
PANES Ctrl-w h/j/k/l focus a neighbour (NORMAL mode)
Ctrl-o / Ctrl-i jump history back / forward
@@ -343,12 +346,12 @@ typed
SPC is the leader (SPC ? lists every path)
vs HELIX selection is LINE-first (x), v for characters; / is a
- substring search; n/N walk look-able text.
+ substring search; n/N walk what `Look` would open.
vs VIM no verb+noun: the motion already selected, so wd is
what dw was; Esc goes back a pane; bare G does nothing.
vs BOTH a terminal is just a pane, and the session can outlive
the terminal that is showing it.
- Open this tutor again: middle-click `Tutor` in the top tag, or
+ Open this tutor again: `Exec` `Tutor` in the top tag, or
SPC h t. `Exit` in the top tag quits everything; `Kill` only stops
commands.