diff options
| author | Isaac Freund <ifreund@ifreund.xyz> | 2020-12-30 18:15:47 +0100 |
|---|---|---|
| committer | Isaac Freund <ifreund@ifreund.xyz> | 2020-12-30 18:15:47 +0100 |
| commit | ba9df864729c7ffba6171ce7be5eb0e91399e6da (patch) | |
| tree | a0d8b825e7997611d4dcd0795d500e60b509102d /doc/riverctl.1.scd | |
| parent | 5f4ba065668089e7d5b158f60f26dd0be893ccf8 (diff) | |
| download | river-ba9df864729c7ffba6171ce7be5eb0e91399e6da.tar.gz river-ba9df864729c7ffba6171ce7be5eb0e91399e6da.tar.xz | |
command: s/master/main/g (breaking change)
main is a better term to use here for several reasons:
1. It is more accurate: "master" implies that the designated views have
some kind of control over the other views, which is not the case. "main"
better expresses that the difference between the "main" view and others
is one of importance/focus.
2. It is a shorter word. 2 whole characters saved!
3. It reduces the chance of future development time being lost to
good-intentioned people complaining about usage of the word master as
has recently happened with regards to the default git branch name.
Diffstat (limited to 'doc/riverctl.1.scd')
| -rw-r--r-- | doc/riverctl.1.scd | 26 |
1 files changed, 16 insertions, 10 deletions
diff --git a/doc/riverctl.1.scd b/doc/riverctl.1.scd index 6994fcd..3e0f205 100644 --- a/doc/riverctl.1.scd +++ b/doc/riverctl.1.scd @@ -46,14 +46,20 @@ control and configure river. command to cause river to use its single internal layout, in which windows span the entire width and height of the output. -*mod-master-count* _integer_ - Increase or decrease the number of master views. _integer_ can be - positive or negative. - -*mod-master-factor* _float_ - Make the master area bigger or smaller. _float_ is a positive or - negative floating point number (such as 0.05) where 1 corresponds to - the whole screen. +*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_. The view @@ -89,8 +95,8 @@ control and configure river. Toggle the fullscreen state of the focused view. *zoom* - Bump the focused view to the top of the layout stack to make it the new - master. + Bump the focused view to the top of the layout stack. If the top view + in the stack is already focused, bump the second view. ## TAG MANAGEMENT |