Zander671/river
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

command: s/master/main/g (breaking change)

Browse Source 
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.
This commit is contained in:
Isaac Freund
2020-12-30 18:15:47 +01:00
parent 5f4ba06566
commit ba9df86472
10 changed files with 96 additions and 90 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
doc/river-layouts.7.scd
View File

@ -16,8 +16,8 @@ When running the executable, river will provide it with five parameters which
are appended to the end of the command in the following order:
. The amount of visible clients (integer)
. The amount of views dedicated as master (integer)
. The screen size multiplier for the master area (float between 0.0 and 1.0)
. The amount of views dedicated as main (integer)
. The screen size multiplier for the main area (float between 0.0 and 1.0)
. The useable width of the output (integer)
. The useable height of the output (integer)

24
doc/riverctl.1.scd
View File

@ -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-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-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-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

10
doc/rivertile.1.scd
View File

@ -11,21 +11,21 @@ rivertile - Tiled layout generator for river
# DESCRIPTION
*rivertile* is a layout generator for river. It produces tiled layouts with
split master/secondary stacks in four configurable orientations.
split main/secondary stacks in four configurable orientations.
# OPTIONS
*left*
Place the master stack on the left side of the output.
Place the main stack on the left side of the output.
*right*
Place the master stack on the right side of the output.
Place the main stack on the right side of the output.
*top*
Place the master stack at the top of the output.
Place the main stack at the top of the output.
*bottom*
Place the master stack at the bottom of the output.
Place the main stack at the bottom of the output.
# EXAMPLE