diff options
| author | user <user@clank> | 2026-08-27 16:11:26 +0200 |
|---|---|---|
| committer | user <user@clank> | 2026-08-27 16:11:26 +0200 |
| commit | 238b1a7eb51c576254537705597f8a039e1d9c86 (patch) | |
| tree | 19c7959037b1a16564520f71a394f228b9b545d8 /docs/panes.md | |
| parent | README/docs: spell the dash --, as the rest of the tree does (diff) | |
| download | slosh-238b1a7eb51c576254537705597f8a039e1d9c86.tar.gz slosh-238b1a7eb51c576254537705597f8a039e1d9c86.tar.xz slosh-238b1a7eb51c576254537705597f8a039e1d9c86.zip | |
README/docs: stop leaning on the aside dash
Some 230 sentences hung their qualifications between dashes, and at that
density the tic reads as the writing's signature rather than a tool it
occasionally picks up. Each one is now the punctuation the sentence
actually wanted: a colon where the aside defines, parentheses where it
whispers, a comma where it barely pauses, a full stop where two thoughts
were pretending to be one. Definition lists and reference tables take
colons throughout.
Two double hyphens remain on purpose, both literal: the argv separator
in a shell example, and a table cell that means 'takes nothing'.
Diffstat (limited to 'docs/panes.md')
| -rw-r--r-- | docs/panes.md | 82 |
1 files changed, 41 insertions, 41 deletions
diff --git a/docs/panes.md b/docs/panes.md index d72471e..4161d2f 100644 --- a/docs/panes.md +++ b/docs/panes.md @@ -20,7 +20,7 @@ looking at is drawn. - **Resize** with `C-a H J K L`: the boundary moves the way you press, whichever side of it you are on. Sizes are *weights*, so a resized layout survives the window changing size. -- **`C-a 0`** gives every visible pane an even share again -- each split divided +- **`C-a 0`** gives every visible pane an even share again: each split divided between the panes behind it, so one pane beside a stack of three is a quarter of the width rather than half of it. - **`C-a Space`** turns the whole tab a quarter turn clockwise. Every split @@ -29,8 +29,8 @@ looking at is drawn. A turn that would squeeze a pane under the floor is refused with a word. - **`C-a z`** fills the tab with one pane and back; **`C-a m`** puts one away into a strip along the bottom, still running. Each put-away pane sits there - as a **miniature pane frame** -- a frame is what a pane looks like here, so - a shrunken one reads as exactly what it is -- and clicking it anywhere + as a **miniature pane frame** (a frame is what a pane looks like here, so + a shrunken one reads as exactly what it is) and clicking it anywhere brings the pane back: ``` @@ -44,12 +44,12 @@ looking at is drawn. Every mouse verb starts from the same list of rects the drawing filled in, so nothing you click can disagree with what is on screen. -- **Click the middle of a pane's border to split toward it** -- the side you click +- **Click the middle of a pane's border to split toward it**: the side you click is the side the new pane appears on. Only the middle of an edge splits: three to seven cells of it, called the handle, because a whole edge is a long target to brush past and a changed layout is an expensive accident. Resting anywhere on an edge fills the handle in solid, with an arrow in it for the way it will - split -- a cell wider on the left and right edges, and no taller on the top and + split. A cell wider on the left and right edges, and no taller on the top and bottom ones, since a row is about twice a column and a two-row bar reads as a wall. Resting *on* the handle adds a dashed line where the new boundary will land. The rest of the edge does nothing when clicked. @@ -58,23 +58,23 @@ nothing you click can disagree with what is on screen. of the row as the row allows: centred when the row is empty, and against the title when the title is holding the middle, since the title keeps its own cells for the double-click rename. Arming an edge leaves the name, the buttons and a - dead pane's epitaph legible -- the heavy rule goes round them. + dead pane's epitaph legible: the heavy rule goes round them. - **Drag the gap between panes** to move that boundary. Where two gaps cross, drag the crossing to move both at once. With `gap 0` there is no gap to - grab, so grabbing the border itself and pulling does the same thing -- a + grab, so grabbing the border itself and pulling does the same thing; a border press that never moves is still the click that splits. - **[`compact true`](config.md#compact)** trades the gaps for shared 1-cell - divider lines -- tmux-style density, same mouse: dividers drag, crossings + divider lines. Same mouse, tmux-style density: dividers drag, crossings drag both ways, titles ride the line above their pane. Interior edges give up click-to-split (the line is all resize handle); the outer frame keeps it. -- **Drag a pane by its title** onto another to swap them -- or to *place* it: +- **Drag a pane by its title** onto another to swap them, or to *place* it: the pane under the pointer subdivides into a centre and four edge bands, and where you let go is what the drop means. The centre trades places, as it always has; a band means "insert me beside this pane, on this side", and fills the half of the pane the drop would hand over, so what you see - is where it lands. A side there is no room for offers no band -- the same - floor a border click's split honours -- except between neighbours along the + is where it lands. A side there is no room for offers no band (the same + floor a border click's split honours) except between neighbours along the same row or column, where a drop is a reorder and always fits. Everything it could land on greys out; the pane in your hand keeps its colour. Between the bands and the strip, the whole layout can be rebuilt without touching the keyboard. @@ -83,12 +83,12 @@ nothing you click can disagree with what is on screen. one under the pointer fills; the tab it already lives in does not offer itself. A toast says where it went, since the pane lands somewhere you are not looking. - **Name a pane and it stops listening to its program.** `pane_title` prefers a - name while there is one, so a program that keeps announcing something stale -- - an agent still spinning the summary of a task it finished -- is overruled by + name while there is one, so a program that keeps announcing something stale + (an agent still spinning the summary of a task it finished) is overruled by naming its pane, from the gesture below or from a script: `slosh cmd '{"cmd":"set-name","target":"pane","id":3,"name":"agent: gbos"}'`. An empty name hands the label back. -- **Double-click a name to rename it in place** -- a pane's title or a tab in the +- **Double-click a name to rename it in place**: a pane's title or a tab in the strip. Enter keeps it, Escape abandons it, `C-u` clears the field (a rename seeds with the current label, since it is usually an edit), empty gives it back to the program. The same two verbs are in the palette as `rename-pane` @@ -103,7 +103,7 @@ nothing you click can disagree with what is on screen. frame's corner to minimise (`▬`), zoom (`□`) or close (`✕`) it. - **A tab in the strip has no `✕`** and closes with `C-a X` instead. A mark per tab would cost two columns of every tab on every frame, forever, for a verb pressed - rarely -- the same arithmetic that took the per-pane `+` away. A pane's marks + rarely, the same arithmetic that took the per-pane `+` away. A pane's marks earn their cells because there is one set of them and it is where you are looking. - Hovering anything says what it does, in a word, in the status line. @@ -111,16 +111,16 @@ nothing you click can disagree with what is on screen. ## Floating a pane `C-a f` lifts a pane out of the layout and draws it on top of the tiled ones --- below the modals -- where it can be moved and shaped freely. It **pops to +(below the modals) where it can be moved and shaped freely. It **pops to the centre of the tab**, because the jump is what says the float happened; a pane lifted in place would look like a pane whose neighbours flinched. Pressing `f` again puts it back in the seat it kept, with the layout exactly as it was. (`f` is what "float" sounds like; finding a pane is `C-a s`, -search.) `C-a F` opens a **new floating shell** over whatever you are doing --- the throwaway terminal -- in the focused pane's directory; `exit` closes it +search.) `C-a F` opens a **new floating shell**, the throwaway terminal, over +whatever you are doing, in the focused pane's directory; `exit` closes it like any shell, and un-floating lands it beside the pane it was opened over. -- **Drag its title to move it, any other border to resize it** -- a bottom +- **Drag its title to move it, any other border to resize it**; a bottom corner resizes on both axes. Hovering says so: the edge a grab would move goes heavy in the resize colour with a double arrow at the grab point (a corner lights both edges), and the held edges stay lit through the drag. @@ -141,11 +141,11 @@ like any shell, and un-floating lands it beside the pane it was opened over. every other pane. - Focusing a float raises it above other floats; minimising works as ever and it comes back floating; zooming fills the tab and returns it on the way - out. The last tiled pane cannot float -- an overlay needs something to be - over -- and closing the last tiled pane lands the float in its place. + out. The last tiled pane cannot float (an overlay needs something to be + over) and closing the last tiled pane lands the float in its place. - **It survives being written down.** `dump-layout` and - [`save-workspace`](workspaces.md) record `floating=true x= y= w= h=` -- the - *wanted* rect, which the next screen's layout clamps like any frame -- and a + [`save-workspace`](workspaces.md) record `floating=true x= y= w= h=`, the + *wanted* rect, which the next screen's layout clamps like any frame, and a [layout file](layouts.md) can declare the same. From a [script](scripting.md), `{"cmd":"float","id":N}` toggles, `{"cmd":"float","id":N,"x":10,"y":5,"w":40,"h":12}` places (floats first @@ -153,47 +153,47 @@ like any shell, and un-floating lands it beside the pane it was opened over. `{"cmd":"new-float"}` opens one. - **Images know their place.** A kitty-graphics picture in a pane a float covers is cropped at the float's edge, or not drawn while the float sits - across its middle -- a placement is one rectangle, and it must not paint + across its middle: a placement is one rectangle, and it must not paint over what covers it. ## Links -**OSC 8 hyperlinks pass through.** A program that emits real hyperlinks -- -`ls --hyperlink`, gcc's diagnostics, delta -- keeps them: the compositor +**OSC 8 hyperlinks pass through.** A program that emits real hyperlinks +(`ls --hyperlink`, gcc's diagnostics, delta) keeps them: the compositor carries the link beside each cell and re-emits it to your terminal, which offers it with its own gesture. Anything painted over a link (a frame, a modal, a floating pane) takes the link with it, so chrome is never clickable with a pane's URL. Links survive scrollback with the text that carries them. **Plain-text URLs are your terminal's own matcher**, running over what slosh -paints -- with one catch worth knowing. While any program owns the mouse (a +paints, with one catch worth knowing. While any program owns the mouse (a multiplexer does), Ghostty only offers links when **shift** is added to the usual gesture: shift is its mouse-capture escape, and it is stripped before -the link's own modifier is checked. So the gesture inside slosh -- or tmux, -or zellij -- is **shift+cmd+hover** to highlight and **shift+cmd+click** to +the link's own modifier is checked. So the gesture inside slosh (or tmux, +or zellij) is **shift+cmd+hover** to highlight and **shift+cmd+click** to open (shift+ctrl on Linux). A URL that *wraps* onto a second row cannot be -matched this way through any multiplexer -- the screen is repainted row by -row, so the terminal sees two hard lines -- which is exactly what OSC 8 +matched this way through any multiplexer, because the screen is repainted row +by row and the terminal sees two hard lines. That is exactly what OSC 8 links, which pass through whole, are for. ## Finding a pane Tabs stop being navigation somewhere around six projects. `C-a s` opens a picker -over the whole session -- every tab, including panes a small window has collapsed +over the whole session: every tab, including panes a small window has collapsed out of sight. Type to narrow it by pane title, tab name or [purpose](layouts.md#purposes); arrows, `C-n`/`C-p` or tab to move, `C-u` to clear what you typed, enter to go. A dot marks where you already are. -The finder searches what this session has; `C-a w` lists what is on disk -- +The finder searches what this session has; `C-a w` lists what is on disk, every project under your roots, open or not ([workspaces](workspaces.md)). A project you have not opened yet has no pane for the finder to match. ## Panes that were given a command Split off a shell, do something, type `exit`: it closes, like a terminal should. -But a pane that was *told to run something* -- from a [layout](layouts.md) or the -[control API](scripting.md) -- keeps what it printed when that something exits, +But a pane that was *told to run something*, from a [layout](layouts.md) or the +[control API](scripting.md), keeps what it printed when that something exits, with two lines saying what ran and how it ended, and two buttons: ``` @@ -203,14 +203,14 @@ with two lines saying what ran and how it ended, and two buttons: ``` **The command is written down because `[re-run]` is one button.** Without it, -pressing it is a guess -- most of all in a tab that a [project's +pressing it is a guess, most of all in a tab that a [project's layout](workspaces.md) built, where the command was never typed into that pane to be scrolled back to. A pane running the session's shell has no command to name and gets the exit line alone. `[re-run]` (or `C-a r`) runs the same command again in the same pane, keeping the previous run above it in the scrollback. So the two notes turn a pane you re-run -into a log of what ran rather than a pile of identical epitaphs -- and a command +into a log of what ran rather than a pile of identical epitaphs, and a command that failed while you were looking elsewhere still has its error message when you get back, while a mistyped command in a fresh session no longer closes it. @@ -220,14 +220,14 @@ or `none`. ## Small terminals When the panes no longer fit, the tab becomes a list of one-line headers with -the focused pane open below them -- and returns to exactly the layout you had +the focused pane open below them, and returns to exactly the layout you had when there is room again. Nothing is stored and restored: the arrangement is recomputed from the tree every frame, and the list is what that function returns when the room runs out. `min_pane` is where that starts happening; `min_split` is the smaller pane a split is willing to *create*. A split is refused when either floor would be -broken -- including the axis it does not divide, since splitting cannot improve +broken, including the axis it does not divide, since splitting cannot improve that one: a pane already too short for two rows has no room for two columns either, whatever its width says. @@ -237,7 +237,7 @@ either, whatever its width says. sent to your terminal over ssh as well as locally. Middle click pastes. - **Double-click a word to select it**, and it is copied the same way a drag is: the highlight *is* the copy. What counts as one word is `word_separators`, - which lists what a word stops at rather than what it is made of -- so + which lists what a word stops at rather than what it is made of, so `src/app.c:1234`, `https://a.b/c?d=1`, `snake_case` and a run of CJK each come out whole, while a quote or a bracket ends one. A click on a blank cell or on a separator selects nothing and leaves your clipboard as it was. @@ -247,6 +247,6 @@ either, whatever its width says. each pane, so a program can size an image without saying how many cells to cover. PNG uploads are decoded here, because the terminal core ships no image decoder. (Sixel is not supported.) -- **A pane that beeps says so** -- in its title, in its tab, and until you look at +- **A pane that beeps says so**: in its title, in its tab, and until you look at it. `bell_indicator false` makes a bell silent *and* invisible, which is a real choice. A [chrome shader](chrome.md) can make it louder. |
