summaryrefslogtreecommitdiff
path: root/docs/typ/guide.typ
diff options
context:
space:
mode:
authorGabriel Schneider <[email protected]>2026-10-01 09:13:02 -0300
committerGabriel Schneider <[email protected]>2026-10-01 09:13:02 -0300
commit47e000b0569ef1fca9f6e6eda214bb5952f35975 (patch)
treebc827c6495b8ae77d1172208d5ee2a37498135d5 /docs/typ/guide.typ
parentde78a167532d1f78611381accd8839fac066fd56 (diff)
downloadpardes-47e000b0569ef1fca9f6e6eda214bb5952f35975.tar.gz
pardes-47e000b0569ef1fca9f6e6eda214bb5952f35975.zip
The docs take round 36: empty names, get as an undo step, what a Dump keeps and Restore reads, Find and Grep caps and notes, the ctl read's collapsed and fit/tint, PDF search hits, ./x misses, 1 MiB lines, DumpDir, bad dials, /pager files, rename previews, Lspinfo, and --wait from an agent
Co-Authored-By: Claude Opus 5.5 <[email protected]>
Diffstat (limited to 'docs/typ/guide.typ')
-rw-r--r--docs/typ/guide.typ21
1 files changed, 16 insertions, 5 deletions
diff --git a/docs/typ/guide.typ b/docs/typ/guide.typ
index 9f45350b..8bab9e56 100644
--- a/docs/typ/guide.typ
+++ b/docs/typ/guide.typ
@@ -139,8 +139,15 @@ a terminal there. A URL opens in the browser. #word("Find") `name` lists the fil
below the pane's directory whose names hold it; #word("Grep") `text` lists
the lines that contain that text, literally (ASCII case aside, no regular
expression), in files under every pane's directory. Both land in `+Search`,
-a place per row for #btn("B3"); a directory the walk cannot open is
-skipped, and the list ends `N directories skipped: permission denied`.
+a place per row for #btn("B3"). Grep reads at most 256 KiB of a file and
+stops at 512 hits, Find at 512 names; the walk stops at 20000 files or
+100000 entries, 16 deep, and passes over `.git`, `.jj`, `target`,
+`node_modules`, `.venv`, `__pycache__`, `.zig-cache` and `zig-out`. A cap
+hit, or a directory it could not open, is said at the end (`cut at 512
+hits`, `N files read only in part (first 256 KiB)`, `walk cut at N
+entries`, `N directories skipped: permission denied`). A search that finds
+nothing and skipped nothing fails, `Grep: pattern not found`, and leaves
+the `+Search` as it was.
A relative path is looked for where the click was, then where you have
been: first in the looking pane's own directory, then in the directory of
@@ -246,7 +253,9 @@ search or write, `permission denied`) is printed and the command exits 1.
`--` ends the options: `pardes -- -name` opens a file named `-name`.
`pardes --wait FILE` (`-w`) returns when the pane showing FILE is closed
-(exit 0) or the session goes away (exit 1), as acme's `E` does. Set
+(exit 0) or the session goes away (exit 1), as acme's `E` does. With
+`$PARDES_9P` set but no pane of its own (an agent's `EDITOR`) it opens FILE
+in that session and waits there. Set
`EDITOR='pardes --wait'` (`GIT_EDITOR` follows it), and `git commit`,
`crontab -e` and fish's Alt-E open in a pane and read the file once you
close it. Bare `pardes` inside a pane refuses and names `--nested`, which
@@ -285,8 +294,10 @@ One answer jumps; several open a list where #key("Enter") on a row goes
there. In insert mode #key("Tab") after a `.` lists the candidate
declarations and inserts nothing. A format or a rename within the file is
one undo step. A rename that reaches other files applies nothing: it opens
-a `+Search` preview of the edits, telling the server first of every open
-file of its language so those are included. A server is `not started yet`
+a `+Search` preview of the edits. So does one the server answers in this
+file alone while another open file of its language still holds the old
+name, with a row per such file (zls does this renaming at a declaration;
+from a use it reaches every file). A server is `not started yet`
until its first query.
= Sessions <sessions>