diff options
| author | Isaac Freund <ifreund@ifreund.xyz> | 2021-04-15 00:28:39 +0200 |
|---|---|---|
| committer | Isaac Freund <ifreund@ifreund.xyz> | 2021-04-20 18:27:03 +0200 |
| commit | d08032d6850d28063c0715aa54b1c18e0d0b966d (patch) | |
| tree | 582f6e1ef56b395ccf599708136589ee09cdcb7f /doc/rivertile.1.scd | |
| parent | 33fb7725c5a9d68d28bc2a30537210518aef3486 (diff) | |
| download | river-d08032d6850d28063c0715aa54b1c18e0d0b966d.tar.gz river-d08032d6850d28063c0715aa54b1c18e0d0b966d.tar.xz | |
river-options: rework, bump to v2
Options are now all global but may be overridden per-output. If an
output local value is requested but none has been set, the global value
is provided instead. This makes for much better ergonomics when
configuring layout related options in particular.
Diffstat (limited to 'doc/rivertile.1.scd')
| -rw-r--r-- | doc/rivertile.1.scd | 31 |
1 files changed, 23 insertions, 8 deletions
diff --git a/doc/rivertile.1.scd b/doc/rivertile.1.scd index cbf8f32..b099a21 100644 --- a/doc/rivertile.1.scd +++ b/doc/rivertile.1.scd @@ -10,15 +10,31 @@ rivertile - Tiled layout generator for river # DESCRIPTION -*rivertile* is a layout client for river. It provides four tiled layouts per -output with split main/secondary stacks with the main area in different -positions. +*rivertile* is a layout client for river. It provides a simple tiled layout +split main/secondary stacks. -The namespaces of the four layouts are "tile-top", "tile-right", "tile-bottom" -and "tile-left", corresponding to the position of the main area. +# OPTIONS -*rivertile* uses the *main_amount*, *main_factor*, *view_padding* and -*outer_padding* options. +These options may be set using *riverctl*(1) or another river-options +wayland client. *rivertile* declares these options on startup, so setting +these options before starting rivertile requires them to be declared manually. + +*main_location* (string, default "top") + The location of the main area. Vaild locations are "top", "bottom", + "left", and "right". + +*main_count* (uint, default 1) + The number of main views. + +*main_factor* (fixed, default 0.6) + The percentage of the layout area reserved for main views. *rivertle* + clamps this to the range `[0.1, 0.9]`. + +*view_padding* (uint, default 6) + Padding around every view in pixels. + +*outer_padding* (uint, default 6) + Padding around the edge of the layout area in pixels. # AUTHORS @@ -29,4 +45,3 @@ source contributors. For more information about river's development, see # SEE ALSO *river*(1), *riverctl*(1) - |