2024-04-15 11:23:05 +02:00
|
|
|
RIVERTILE(1)
|
2020-06-16 17:06:24 +02:00
|
|
|
|
|
|
|
|
# NAME
|
|
|
|
|
|
2021-07-24 19:45:25 +02:00
|
|
|
rivertile - tiled layout generator for river
|
2020-06-16 17:06:24 +02:00
|
|
|
|
|
|
|
|
# SYNOPSIS
|
|
|
|
|
|
2021-04-26 23:41:30 +02:00
|
|
|
*rivertile* [_options_]
|
2020-06-16 17:06:24 +02:00
|
|
|
|
|
|
|
|
# DESCRIPTION
|
|
|
|
|
|
2021-10-31 22:32:59 +01:00
|
|
|
*rivertile* is a layout generator for *river*(1). It provides a simple tiled
|
2021-05-01 12:49:49 +02:00
|
|
|
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).
|
2020-06-16 17:06:24 +02:00
|
|
|
|
2021-04-26 23:41:30 +02:00
|
|
|
# OPTIONS
|
|
|
|
|
|
2021-11-01 00:34:15 +01:00
|
|
|
*-h*
|
2021-07-24 19:42:34 +02:00
|
|
|
Print a help message and exit.
|
|
|
|
|
|
|
|
|
|
*-version*
|
|
|
|
|
Print the version number and exit.
|
|
|
|
|
|
2021-04-26 23:41:30 +02:00
|
|
|
*-view-padding* _pixels_
|
2021-05-01 12:49:49 +02:00
|
|
|
Set the padding around views in pixels. (Default: 6)
|
2021-04-26 23:41:30 +02:00
|
|
|
|
|
|
|
|
*-outer-padding* _pixels_
|
|
|
|
|
Set the padding around the edge of the layout area in pixels.
|
2021-05-01 12:49:49 +02:00
|
|
|
(Default: 6)
|
2021-04-26 23:41:30 +02:00
|
|
|
|
|
|
|
|
*-main-location* [*top*|*bottom*|*left*|*right*]
|
2021-05-01 12:49:49 +02:00
|
|
|
Set the initial location of the main area in the layout.
|
|
|
|
|
(Default: *left*)
|
2021-04-26 23:41:30 +02:00
|
|
|
|
|
|
|
|
*-main-count* _count_
|
2021-05-01 12:49:49 +02:00
|
|
|
Set the initial number of views in the main area of the
|
|
|
|
|
layout. (Default: 1)
|
2021-04-26 23:41:30 +02:00
|
|
|
|
2021-07-15 13:22:37 +02:00
|
|
|
*-main-ratio* _ratio_
|
2021-07-15 22:57:50 +02:00
|
|
|
Set the initial ratio of the main area to total layout area. The
|
|
|
|
|
_ratio_ must be between 0.1 and 0.9, inclusive. (Default: 0.6)
|
2021-04-26 23:41:30 +02:00
|
|
|
|
2021-07-15 13:22:37 +02:00
|
|
|
# COMMANDS
|
2021-04-26 21:03:28 +02:00
|
|
|
|
2021-07-15 13:22:37 +02:00
|
|
|
These commands may be sent to rivertile at runtime with the help of
|
2021-05-01 12:49:49 +02:00
|
|
|
*riverctl*(1).
|
|
|
|
|
|
2021-07-15 22:57:50 +02:00
|
|
|
*main-location* [*top*|*bottom*|*left*|*right*]
|
2021-07-15 13:22:37 +02:00
|
|
|
Set the location of the main area in the layout.
|
2021-04-26 21:03:28 +02:00
|
|
|
|
2021-07-15 22:57:50 +02:00
|
|
|
*main-count* _value_
|
|
|
|
|
Set or modify the number of views in the main area of the layout. If
|
|
|
|
|
_value_ is prefixed by a +/- sign, _value_ is added/subtracted from the
|
|
|
|
|
current count. If there is no sign, the main count is set to _value_.
|
2023-01-06 17:47:54 +01:00
|
|
|
Note that the main count cannot be decreased below 1.
|
2021-04-26 21:03:28 +02:00
|
|
|
|
2021-07-26 20:31:34 -03:00
|
|
|
*main-ratio* _value_
|
2021-07-15 22:57:50 +02:00
|
|
|
Set or modify the ratio of the main area to total layout area. If
|
|
|
|
|
_value_ is prefixed by a +/- sign, _value_ is added/subtracted from
|
|
|
|
|
the current ratio. If there is no sign, the main ratio is set to
|
|
|
|
|
_value_. Note that the ratio will always be clamped to the range
|
|
|
|
|
0.1 to 0.9.
|
2021-04-26 21:03:28 +02:00
|
|
|
|
2021-05-01 12:49:49 +02:00
|
|
|
# EXAMPLES
|
|
|
|
|
|
2021-07-15 22:57:50 +02:00
|
|
|
Start *rivertile* with 4 pixels outer padding and the *top* main location:
|
2021-05-01 12:49:49 +02:00
|
|
|
|
2021-07-15 22:57:50 +02:00
|
|
|
rivertile -outer-padding 4 -main-location top
|
2021-05-01 12:49:49 +02:00
|
|
|
|
2021-07-15 22:57:50 +02:00
|
|
|
Increase the main ratio by 0.1 at runtime:
|
2021-05-01 12:49:49 +02:00
|
|
|
|
2021-07-15 22:57:50 +02:00
|
|
|
riverctl send-layout-cmd rivertile "main-ratio +0.1"
|
|
|
|
|
|
|
|
|
|
Set the main count to 3 at runtime:
|
|
|
|
|
|
|
|
|
|
riverctl send-layout-cmd rivertile "main-count 3"
|
2021-05-01 12:49:49 +02:00
|
|
|
|
2020-11-11 20:44:41 +01:00
|
|
|
# AUTHORS
|
|
|
|
|
|
2021-10-02 13:01:58 +02:00
|
|
|
Maintained by Isaac Freund <mail@isaacfreund.com> who is assisted by open
|
2020-11-11 20:44:41 +01:00
|
|
|
source contributors. For more information about river's development, see
|
2024-04-15 11:23:05 +02:00
|
|
|
<https://isaacfreund.com/software/river>.
|
2020-11-11 20:44:41 +01:00
|
|
|
|
2020-06-16 17:06:24 +02:00
|
|
|
# SEE ALSO
|
|
|
|
|
|
2020-10-02 15:53:08 +02:00
|
|
|
*river*(1), *riverctl*(1)
|
