summaryrefslogtreecommitdiff
path: root/docs/typ/reference.typ
diff options
context:
space:
mode:
authorGabriel Schneider <[email protected]>2026-09-30 23:12:54 -0300
committerGabriel Schneider <[email protected]>2026-10-01 00:12:17 -0300
commit9155fb6632c1337ed077b76e06e9d176b5b4889f (patch)
treedb1bd14398054d1ff57f0e160547e090eb6a9ac8 /docs/typ/reference.typ
parent450ce314c18603b045f0ce808f21c8577237ba83 (diff)
downloadpardes-9155fb6632c1337ed077b76e06e9d176b5b4889f.tar.gz
pardes-9155fb6632c1337ed077b76e06e9d176b5b4889f.zip
The book and the HTML hold every topic, and #doc links to its chapter or section
chapters now names guide, cheatsheet, scripting, reference, themes and building. #doc takes the chapter ids, keeps the old ones mapped onto them (tags and fs to the guide and the reference, config, keys and detached to their guide sections), and links in the book and the HTML, where a doc-links state says every chapter is there; on the A4 sheet it names the chapter and section. The reference points at the scripting and building chapters by #doc instead of in words, and the guide heading for pardes FILE and --wait keeps its two dashes. Co-Authored-By: Claude Opus 5.5 <[email protected]>
Diffstat (limited to 'docs/typ/reference.typ')
-rw-r--r--docs/typ/reference.typ10
1 files changed, 5 insertions, 5 deletions
diff --git a/docs/typ/reference.typ b/docs/typ/reference.typ
index 5fc2dd1d..37f3acbc 100644
--- a/docs/typ/reference.typ
+++ b/docs/typ/reference.typ
@@ -7,7 +7,7 @@
Every native session serves 9P2000 (not .u, not .L) as a control
filesystem, in acme's manner: panes, columns, tags and the session are
files. Paths here are the served ones (#file("/pane/2/body")); through a
-mount they sit under the session's directory (`$m`; the scripting chapter
+mount they sit under the session's directory (`$m`; #doc("scripting", section: "find-the-session")
says how to find it). The served #file("/README") is a
one-screen summary of this page.
@@ -75,8 +75,8 @@ The whole write is checked first (a control character other than a tab
fails it all, EINVAL); then lines run in order, and a failing line fails
the write after the lines before it took effect, as acme's ctl does. Blank
lines are skipped. A line runs once it is whole: a write's last line runs
-without its newline, except where a mount cut the write (the building
-chapter has the mechanics); end a write with a newline when its result
+without its newline, except where a mount cut the write
+(#doc("building", section: "writes-through-a-mount")); end a write with a newline when its result
matters. An `Edit` whose `{` or `a`/`c`/`i` text is still
open waits for the next write on that open. A line held past 1 MiB is
refused.
@@ -690,8 +690,8 @@ at 200, ending in `…`. Control characters become spaces.
closed one at its last (a PDF's is its page); a look at a row reopens it
there.
- #file("/status"): `pid`, `version`, `panes`.
-- #file("/listeners"): the session's dial addresses, a line each (the
- building chapter has the listeners).
+- #file("/listeners"): the session's dial addresses, a line each
+ (#doc("building", section: "listeners")).
- #file("/os/"): existing regular files take read, write and truncation to
zero; create, remove, rename and mode changes are refused as not
permitted (`permission denied`, EACCES through a mount); ownership is