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

rivertile: add -h/--help, improve man page

Browse Source
This commit is contained in:
Isaac Freund
2021-05-01 12:49:49 +02:00
parent 0c8e718d95
commit 4684f9fa47
2 changed files with 46 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
doc/rivertile.1.scd
View File

@ -10,28 +10,36 @@ rivertile - Tiled layout generator for river
# DESCRIPTION
*rivertile* is a layout client for river. It provides a simple tiled layout
split main/secondary stacks.
*rivertile* is a layout client for *river*(1). It provides a simple tiled
layout with split main/secondary stacks. The initial state may be configured
with various options passed on startup. Some values may additionally be
modified while rivertile is running with the help of *riverctl*(1).
# OPTIONS
*-view-padding* _pixels_
Set the padding around views in pixels.
Set the padding around views in pixels. (Default: 6)
*-outer-padding* _pixels_
Set the padding around the edge of the layout area in pixels.
(Default: 6)
*-main-location* [*top*|*bottom*|*left*|*right*]
Set the default location of the main area in the layout.
Set the initial location of the main area in the layout.
(Default: *left*)
*-main-count* _count_
Set the default number of views in the main area of the layout.
Set the initial number of views in the main area of the
layout. (Default: 1)
*-main-factor* _ratio_
Set the default ratio of main area to total layout area.
Set the initial ratio of main area to total layout area. (Default: 0.6)
# VALUES
These values may be modified while rivertile is running with the help of
*riverctl*(1).
_main_location_ (string: top, bottom, left, or right)
The location of the main area in the layout.
@ -41,6 +49,16 @@ _main_count_ (int)
_main_factor_ (fixed: [0.1, 0.9])
The ratio of main area to total layout area.
# EXAMPLES
Start *rivertile* with 4 pixels outer padding and 2 main views:
rivertile -outer-padding 4 -main-count 2
Set the main location of rivertile to top at runtime:
riverctl send-layout-value rivertile string main_location top
# AUTHORS
Maintained by Isaac Freund <ifreund@ifreund.xyz> who is assisted by open