~novakane/rivercarro

ref: 67e0d63423c94424dfe523fee0928a5a2a466a7a rivercarro/doc/rivercarro.1.scd -rw-r--r-- 2.5 KiB
67e0d634Hugo Machet README: Improve contributing section 8 months ago
                                                                                
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
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
RIVERCARRO(1)

# NAME

rivercarro - tiled layout generator for river

# SYNOPSIS

*rivercarro* [_options_]

# DESCRIPTION

*rivercarro* is a fork of *rivertile*(1) layout generator for *river*(1).
It provides a simple tiled 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 rivercarro is running with the
help of *riverctl*(1).

In addition to *rivertile*(1), *rivercarro* provides:

- Monocle layout, views will takes all the usable area on the screen.
- Smart gaps, if there is only one view, gaps will be disable.
- Inner gaps instead of padding around views.

# OPTIONS

*-h*
	Print a help message and exit.

*-version*
	Print the version number and exit.

*-view-padding* _pixels_
	Set the padding around views in pixels. (Default: 6)

*-outer-padding* _pixels_
	Set the padding around the edge of the layout area in pixels.
	(Default: 6)

*-main-location* [*top*|*bottom*|*left*|*right*|*monocle*]
	Set the initial location of the main area in the layout.
	(Default: *left*)

*-main-count* _count_
	Set the initial number of views in the main area of the
	layout. (Default: 1)

*-main-ratio* _ratio_
	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)

*-no-smart-gaps*
	Disable smart gaps.

# COMMANDS

These commands may be sent to rivercarro at runtime with the help of
*riverctl*(1).

*main-location* [*top*|*bottom*|*left*|*right*|*monocle*]
	Set the location of the main area in the layout.

*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_.

*main-ratio* _value_
	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.

# EXAMPLES

Start *rivercarro* with 4 pixels outer padding and the *top* main location:

	rivercarro -outer-padding 4 -main-location top

Increase the main ratio by 0.1 at runtime:

	riverctl send-layout-cmd rivercarro "main-ratio +0.1"

Set the main count to 3 at runtime:

	riverctl send-layout-cmd rivercarro "main-count 3"

# SEE ALSO

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