Nulo/river
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity
river/doc/rivertile.1.scd

53 lines
1.2 KiB
Text
Raw Normal View History

docs: add rivertile man page
2020-06-16 15:06:24 +00: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 23:51:51 +00:00
rivertile - Tiled layout generator for river
docs: add rivertile man page
2020-06-16 15:06:24 +00:00
# SYNOPSIS
rivertile: support command line arguments Add support for command line arguments to set default values for the various options of rivertile, bringing us back to rough feature parity with before the commit removing the river-options protocol.
2021-04-26 21:41:30 +00:00
*rivertile* [_options_]
docs: add rivertile man page
2020-06-16 15:06:24 +00: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 22:28:39 +00: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 15:06:24 +00:00
rivertile: support command line arguments Add support for command line arguments to set default values for the various options of rivertile, bringing us back to rough feature parity with before the commit removing the river-options protocol.
2021-04-26 21:41:30 +00:00
# OPTIONS
*-view-padding* _pixels_
Set the padding around views in pixels.
*-outer-padding* _pixels_
Set the padding around the edge of the layout area in pixels.
*-main-location* [*top*|*bottom*|*left*|*right*]
Set the default location of the main area in the layout.
*-main-count* _count_
Set the default number of views in the main area of the layout.
*-main-factor* _ratio_
Set the default ratio of main area to total layout area.
river-layout: update to v2 This implements the changes to the river-layout protocol proposed in the previous commit removing river-options.
2021-04-26 19:03:28 +00:00
# VALUES
_main_location_ (string: top, bottom, left, or right)
The location of the main area in the layout.
_main_count_ (int)
The number of views in the main area of the layout.
_main_factor_ (fixed: [0.1, 0.9])
The ratio of main area to total layout area.
doc: add AUTHORS section to man pages
2020-11-11 19:44:41 +00: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 15:06:24 +00: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 13:53:08 +00:00
*river*(1), *riverctl*(1)
Reference in a new issue Copy permalink