aboutsummaryrefslogtreecommitdiff
path: root/doc/rivertile.1.scd
blob: b099a2190b335758e6f387c46e0b6651580df208 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
RIVERTILE(1) "github.com/ifreund/river" "General Commands Manual"

# NAME

rivertile - Tiled layout generator for river

# SYNOPSIS

*rivertile*

# DESCRIPTION

*rivertile* is a layout client for river. It provides a simple tiled layout
split main/secondary stacks.

# OPTIONS

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.

# 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>.

# SEE ALSO

*river*(1), *riverctl*(1)