summaryrefslogtreecommitdiff
path: root/docs/config.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/config.md')
-rw-r--r--docs/config.md38
1 files changed, 32 insertions, 6 deletions
diff --git a/docs/config.md b/docs/config.md
index cd719fd3..0332d854 100644
--- a/docs/config.md
+++ b/docs/config.md
@@ -111,9 +111,16 @@ themes and all imported names remain available.
`FocusTint` toggles the focused pane and column tag tints; it is on by default.
Workspace, column and pane command text can be edited directly; see
[editable tags](tags.md) for naming and saved-workspace behavior.
-`ColumnTags` toggles the column command row in both GUI and TTY; it is on by
-default. Add `ColumnTags` to startup configuration to reclaim that row on a
-compact screen. Hiding it preserves your custom column commands.
+The column command row is always shown; an old `ColumnTags` init line is
+ignored with a message.
+`Placement acme` (the default) puts new panes where acme would, in the active
+column; `Placement pardes` brings back pardes's own rules, which open a first
+document in a column of its own. See [where new panes go](tags.md#where-new-panes-go).
+`BootShell keep` (the default) leaves a shell alone when a document is dragged
+into the left column beside it, whatever it holds; `BootShell replace` closes
+such a shell there when it is the column's only one and nobody has typed
+into it (no scrollback, cursor still on the first prompt line), the boot's
+placeholder giving its rows to the document. Bare `BootShell` flips it.
`Verbose` toggles the message-row announcement every builtin makes of its own
name before it runs; it is on by default, and the builtins that own the message
row themselves (`Msg`) never announce. Turning it off leaves the row to the
@@ -314,9 +321,11 @@ name, thirteen required RGB roles (`sel_bg`, `sel_fg`, `tag_bg`, `tag_fg`,
`box`, `box_dim`, `kw`, `str`, `num`, `comment`, `lineno`, `scroll_track`,
`scroll_thumb`), nullable `bg`/`fg`, and either a 16-color RGB `palette` or
`null`. Optional nullable RGB roles extend this format:
-`tag_active_bg`, `tag_active_fg`, `tag_name_fg`, `tag_active_name_fg`, `border`, `lineno_active`, `search_bg`, `search_fg`,
-`diagnostic_error`, `diagnostic_warning`, `diagnostic_info`, and
-`diagnostic_hint`. Missing new roles use backward-compatible defaults, so
+`tag_active_bg`, `tag_active_fg`, `tag_name_fg`, `tag_active_name_fg`, `border`, `empty_col`, `lineno_active`, `search_bg`, `search_fg`,
+`diagnostic_error`, `diagnostic_warning`, `diagnostic_info`,
+`diagnostic_hint`, `tag_sel_bg`, `tag_rule`, `box_border` and `box_dirty`;
+`sweep_bg` and `sweep_fg` take three triples, and `rule_px` and `rail_px` a
+pixel count. Missing new roles use backward-compatible defaults, so
previously exported files remain valid. [Theme customization](themes.md)
describes each role and its fallback. RGB values are three-byte arrays, and
hex literals are accepted. The original fields remain required; there is no
@@ -527,6 +536,23 @@ the chain empty the pass is bypassed. CRT works in linear light with restrained
scanlines, mask, bloom and vignette, and no curvature, so clicks land where
they are drawn.
+The focused pane can stand off the page (SDL GUI, off by default):
+
+```text
+Lift shadow a soft drop shadow, on the other panes' bodies only
+Lift rim a hairline just above the focused tag (light, or shade on a light page)
+Lift auto a shadow on a light page; on a dark one the others recede
+Lift off
+InactiveDim 30 the unfocused panes' text fades 30% toward its ground
+Motion smooth off, crisp, smooth (the default), bouncy or playful
+GripWidth 150 the grip's button and the scrollbar under it, percent of the
+ theme's rail_px (12px at a 17px tagline; 50 to 300)
+```
+
+`InactiveDim` works everywhere (a grid shows it at once) and never takes a
+pair below its own contrast or 4.5. Under `Lift auto` on a dark page it is 30
+while unset. `Motion` sets how every such effect moves: see docs/effects.md.
+
`EffectCode PanelAscii` or `EffectCode Crt` lists the current backend's
build-embedded source paths under `/virtual`. Look opens each full file;
no checkout is needed, but the build must carry them (`-Dembed-sources=true`,