diff options
Diffstat (limited to 'doc/riverctl.1.scd')
| -rw-r--r-- | doc/riverctl.1.scd | 53 |
1 files changed, 23 insertions, 30 deletions
diff --git a/doc/riverctl.1.scd b/doc/riverctl.1.scd index 46dd3a1..0d17e44 100644 --- a/doc/riverctl.1.scd +++ b/doc/riverctl.1.scd @@ -38,29 +38,6 @@ over the Wayland protocol. *focus-view* *next*|*previous* Focus the next or previous view in the stack. -*layout* *full*|_command_ - Provide a command which river will use for generating the layout - of non-floating windows on the currently focused output. See - *river-layouts*(7) for details on the expected formatting of the - output of layout commands. Alternatively, “full” can be given - instead of a command to cause river to use its single internal layout, - in which windows span the entire width and height of the output. - -*mod-main-count* _integer_ - Increase or decrease the number of "main" views which is relayed to the - layout generator. _integer_ can be positive or negative. Exactly how - "main" views are display, or if they are even displayed differently - from other views, is left to the layout generator. - -*mod-main-factor* _float_ - Increase or decrease the "main factor" relayed to layout - generators. _float_ is a positive or negative floating point number - (such as 0.05). This value is added to the current main factor which - is then clamped to the range [0.0, 1.0]. The layout generator is - free to interpret this value as it sees fit, or ignore it entirely. - *rivertile*(1) uses this to determine what percentage of the screen - the "main" area will occupy. - *move* *up*|*down*|*left*|*right* _delta_ Move the focused view in the specified direction by _delta_ logical pixels. The view will be set to floating. @@ -264,16 +241,10 @@ A complete list may be found in _/usr/include/linux/input-event-codes.h_ Setting _step-size_ to 1.0 disables transitions fully regardless of the value of _delta-t_. -*outer-padding* _pixels_ - Set the padding around the edge of the screen to _pixels_. - *set-repeat* _rate_ _delay_ Set the keyboard repeat rate to _rate_ key repeats per second and repeat delay to _delay_ milliseconds. -*view-padding* _pixels_ - Set the padding around the edge of each view to _pixels_. - *xcursor-theme* _theme_name_ [_size_] Set the xcursor theme to _theme_name_ and optionally set the _size_. The theme of the default seat determines the default for Xwayland @@ -309,6 +280,28 @@ River declares certain default options for all outputs. Changing this option changes the title of the wayland and X11 backend outputs. +*layout* (string) + The layout namespace used to determine which layout should arrange this + output. If set to null or no layout with this namespace exists for this + output, the output will enter floating mode. Defaults to null. + +*main_amount* (uint, optional hint for layouts) + An arbitrary positive integer indicating the amount of main views. Defaults + to 1. + +*main_factor* (float, optional hint for layouts) + A floating point numger indicating the relative size of the area reserved + for main views. Note that layouts commonly expect values between 0.1 and 0.9. + Defaults to 0.6. + +*view_padding* (uint, optional hint for layouts) + A positive integer indicating the padding in of pixels between / around + views. Defaults to 10. + +*outer_padding* (uint, optional hint for layouts) + A positive integer indicating the padding in of pixels around the layut. + Defaults to 10. + # EXAMPLES Bind bemenu-run to Super+P in normal mode: @@ -325,4 +318,4 @@ source contributors. For more information about river's development, see # SEE ALSO -*river*(1), *river-layouts*(7), *rivertile*(1) +*river*(1), *rivertile*(1) |