rivertile(1)

1RIVERTILE(1)                General Commands Manual               RIVERTILE(1)
2
3
4

NAME

6       rivertile - tiled layout generator for river
7

SYNOPSIS

9       rivertile [options]
10

DESCRIPTION

12       rivertile is a layout generator for river(1). It provides a simple
13       tiled layout with split main/secondary stacks. The initial state may be
14       configured with various options passed on startup. Some values may ad‐
15       ditionally be modified while rivertile is running with the help of
16       riverctl(1).
17

OPTIONS

19       -h
20           Print a help message and exit.
21
22       -version
23           Print the version number and exit.
24
25       -view-padding pixels
26           Set the padding around views in pixels. (Default: 6)
27
28       -outer-padding pixels
29           Set the padding around the edge of the layout area in pixels. (De‐
30           fault: 6)
31
32       -main-location [top|bottom|left|right]
33           Set the initial location of the main area in the layout. (Default:
34           left)
35
36       -main-count count
37           Set the initial number of views in the main area of the layout.
38           (Default: 1)
39
40       -main-ratio ratio
41           Set the initial ratio of the main area to total layout area. The
42           ratio must be between 0.1 and 0.9, inclusive. (Default: 0.6)
43

COMMANDS

45       These commands may be sent to rivertile at runtime with the help of
46       riverctl(1).
47
48       main-location [top|bottom|left|right]
49           Set the location of the main area in the layout.
50
51       main-count value
52           Set or modify the number of views in the main area of the layout.
53           If value is prefixed by a +/- sign, value is added/subtracted from
54           the current count. If there is no sign, the main count is set to
55           value. Note that the main count cannot be decreased below 1.
56
57       main-ratio value
58           Set or modify the ratio of the main area to total layout area. If
59           value is prefixed by a +/- sign, value is added/subtracted from the
60           current ratio. If there is no sign, the main ratio is set to value.
61           Note that the ratio will always be clamped to the range 0.1 to 0.9.
62

EXAMPLES

64       Start rivertile with 4 pixels outer padding and the top main location:
65
66           rivertile -outer-padding 4 -main-location top
67
68       Increase the main ratio by 0.1 at runtime:
69
70           riverctl send-layout-cmd rivertile "main-ratio +0.1"
71
72       Set the main count to 3 at runtime:
73
74           riverctl send-layout-cmd rivertile "main-count 3"
75

AUTHORS

77       Maintained by Isaac Freund <mail@isaacfreund.com> who is assisted by
78       open source contributors. For more information about river's develop‐
79       ment, see <https://github.com/riverwm/river>.
80