aboutsummaryrefslogtreecommitdiffstats
path: root/docs/config.md
diff options
context:
space:
mode:
authoruser <user@clank>2026-08-16 20:09:33 +0200
committeruser <user@clank>2026-08-16 20:09:33 +0200
commit7c4038906a9ee584f24bc935f863500a8394aa12 (patch)
tree84583b087d20eee0e477599e3aeb70ae9cf3e559 /docs/config.md
parentsl0ppty: drag a pane onto a tab (diff)
downloadslosh-7c4038906a9ee584f24bc935f863500a8394aa12.tar.gz
slosh-7c4038906a9ee584f24bc935f863500a8394aa12.tar.xz
slosh-7c4038906a9ee584f24bc935f863500a8394aa12.zip
sl0ppty: docs that match the program
Audited every page against the source and the binary rather than against my memory of it. Eight pages changed; the lists were all fine and the *numbers* were all wrong. Checked mechanically, and each of these came out complete: all 37 action names, all 28 control verbs, all 9 shader names, the expression language's 10 variables, 2 constants and 7 functions, the 8 pane states, every knob the dump prints, every OSC verb, every internal link and anchor, and every page's place in `docs/nav`. Every fenced `kdl` block was run through `--check`; every `{"cmd":...}` in an example is a verb that exists. What was stale: - **`make` does not build.** The default goal is `help`, so the install block -- `make vendor`, `make`, `make test` -- never produced a binary. It says `make all` now, timed at 5.5s from clean rather than "about a second". - **700-odd checks in about eight seconds** is now 1,500-odd in about thirteen, plus 260 from the C unit tests, which the sentence did not count at all. - **About 10k lines of C** is 15k. (10,799 of those are neither blank nor a comment, which is presumably where the old figure came from.) - **Seven chrome presets** are thirteen, and the six new ones use `sin` and `TAU` -- so the perimeter section gained the angle idiom it now depends on, and its "two things fall out of it" became three. - **`--check`'s example transcript showed two errors nobody can produce any more**: `bad prefix: C-a` and `bad key: ←`. Both inputs became *valid* -- `C-a` when the chord parser learned the notation the cheatsheet prints, and `←` when it learned the arrow glyphs, precisely so a chord copied off the screen parses. Replaced with a transcript I generated, and a note that the problems go to stderr, which matters for the pre-commit hook the page suggests. - **`bell_indicator`** was a real knob documented nowhere. - **"There is no key for this yet"** about moving a pane between tabs, two commits after the keys and the drag landed. - The cheatsheet's `+N more` line, the finder's `C-u`, and `tab_id` in a pane report were all real and unmentioned. Verified: the whole suite green, `make docs` builds nine pages, and the changed pages read correctly in a browser -- including the new transcript and the `>` `<` row of the key table.
Diffstat (limited to 'docs/config.md')
-rw-r--r--docs/config.md13
1 files changed, 8 insertions, 5 deletions
diff --git a/docs/config.md b/docs/config.md
index 57b816c..0878eed 100644
--- a/docs/config.md
+++ b/docs/config.md
@@ -40,13 +40,16 @@ $ sl0ppty --check themes/mine.kdl # or one you have not installed yet
Every problem it found, one per line, with the file and line it happened at:
```
- config.kdl:101: bad prefix: C-a
- config.kdl:116: bad key: ←
+ cannot open /home/you/.config/sl0ppty/themes/nope.kdl
+ config.kdl:12: bad prefix: ctrl+nope
+ config.kdl:14: bad key: wobble
+ config.kdl:15: unknown action: fly
themes/mine.kdl:7: unknown shader: bloom
-~/.config/sl0ppty/config.kdl: 3 problems
+~/.config/sl0ppty/config.kdl: 5 problems
```
-It exits 1 when it has anything to say, so it drops into an editor's compile
+The problems go to stderr and the summary with them. It exits 1 when it has
+anything to say, so it drops into an editor's compile
step or a pre-commit hook with no glue. A clean run prints what it read — the
files, the prefix it ended up with, how many bindings — because otherwise a
config that was never opened and a config with nothing wrong look identical.
@@ -103,7 +106,7 @@ theme { frame_focus "#00ff88" } // ...but that one colour is mine
| group | what is in it |
|---|---|
| geometry | `gap` `gap_aspect` `padding` `rounded` `title_align` `title_inset` `min_pane` `min_split` |
-| chrome | `status_bar` `status_line` `status_pad` `hints` `version_banner` `pane_buttons` and the marks (`zoom_mark` `zoom_on_mark` `close_mark` `min_mark` `newtab_mark` `bell_mark`) |
+| chrome | `status_bar` `status_line` `status_pad` `hints` `version_banner` `pane_buttons` `bell_indicator` and the marks (`zoom_mark` `zoom_on_mark` `close_mark` `min_mark` `newtab_mark` `bell_mark`) |
| behaviour | `focus_follows_mouse` `scroll_lines` `toast_ms` `hover_delay_ms` `double_click_ms` `anim_ms` `modal_scrim` `dim_unfocused` `keep_dead` `in_band_shaders` `shell` `editor` `shader_dir` |
| colour | `theme { }` |
| effects | `shaders { }`, `states { }` — see [shaders](shaders.md) and [chrome](chrome.md) |