Zander671/river
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
84f5283889
river/doc/rivertile.1.scd

48 lines
1.2 KiB
Plaintext
Raw Normal View History

docs: add rivertile man page
2020-06-16 08:06:24 -07:00
RIVERTILE(1) "github.com/ifreund/river" "General Commands Manual"
# NAME
doc: unify scdoc style This unifies the style of the man page source files. Most noticable are the now consistent line endings at 80 chars (assuming a tabwidth of 8).
2020-12-12 15:51:51 -08:00
rivertile - Tiled layout generator for river
docs: add rivertile man page
2020-06-16 08:06:24 -07:00
# SYNOPSIS
river-layout: create and implement protocol Replace the current layout mechanism based on passing args to a child process and parsing it's stdout with a new wayland protocol. This much more robust and allows for more featureful layout generators. Co-authored-by: Isaac Freund <ifreund@ifreund.xyz>
2020-10-02 06:53:08 -07:00
*rivertile*
docs: add rivertile man page
2020-06-16 08:06:24 -07:00
# DESCRIPTION
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.
2021-04-14 15:28:39 -07:00
*rivertile* is a layout client for river. It provides a simple tiled layout
split main/secondary stacks.
docs: add rivertile man page
2020-06-16 08:06:24 -07:00
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.
2021-04-14 15:28:39 -07:00
# OPTIONS
docs: add rivertile man page
2020-06-16 08:06:24 -07:00
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.
2021-04-14 15:28:39 -07:00
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.
docs: add rivertile man page
2020-06-16 08:06:24 -07:00
doc: add AUTHORS section to man pages
2020-11-11 11:44:41 -08:00
# AUTHORS
Maintained by Isaac Freund <ifreund@ifreund.xyz> who is assisted by open
source contributors. For more information about river's development, see
<https://github.com/ifreund/river>.
docs: add rivertile man page
2020-06-16 08:06:24 -07:00
# SEE ALSO
river-layout: create and implement protocol Replace the current layout mechanism based on passing args to a child process and parsing it's stdout with a new wayland protocol. This much more robust and allows for more featureful layout generators. Co-authored-by: Isaac Freund <ifreund@ifreund.xyz>
2020-10-02 06:53:08 -07:00
*river*(1), *riverctl*(1)
Reference in New Issue Copy Permalink