aboutsummaryrefslogtreecommitdiff
path: root/doc/rivertile.1.scd
diff options
context:
space:
mode:
authorLeon Henrik Plickat <leonhenrik.plickat@stud.uni-goettingen.de>2020-10-02 15:53:08 +0200
committerIsaac Freund <ifreund@ifreund.xyz>2021-04-20 18:27:03 +0200
commitf72656b72e5822481a4bc15b75d19b61b1bb7bc8 (patch)
tree525e40d5fa1e4279810f7f7537830f2bf89b1608 /doc/rivertile.1.scd
parentdf3e9930137c0ec4871208b09832e59d537453b7 (diff)
downloadriver-f72656b72e5822481a4bc15b75d19b61b1bb7bc8.tar.gz
river-f72656b72e5822481a4bc15b75d19b61b1bb7bc8.tar.xz
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>
Diffstat (limited to 'doc/rivertile.1.scd')
-rw-r--r--doc/rivertile.1.scd32
1 files changed, 10 insertions, 22 deletions
diff --git a/doc/rivertile.1.scd b/doc/rivertile.1.scd
index f77c177..cbf8f32 100644
--- a/doc/rivertile.1.scd
+++ b/doc/rivertile.1.scd
@@ -6,32 +6,19 @@ rivertile - Tiled layout generator for river
# SYNOPSIS
-*rivertile* *left*|*right*|*top*|*bottom* [args passed by river]
+*rivertile*
# DESCRIPTION
-*rivertile* is a layout generator for river. It produces tiled layouts with
-split main/secondary stacks in four configurable orientations.
+*rivertile* is a layout client for river. It provides four tiled layouts per
+output with split main/secondary stacks with the main area in different
+positions.
-# OPTIONS
+The namespaces of the four layouts are "tile-top", "tile-right", "tile-bottom"
+and "tile-left", corresponding to the position of the main area.
-*left*
- Place the main stack on the left side of the output.
-
-*right*
- Place the main stack on the right side of the output.
-
-*top*
- Place the main stack at the top of the output.
-
-*bottom*
- Place the main stack at the bottom of the output.
-
-# EXAMPLE
-
-Set river's layout to *rivertile*'s *left* layout using riverctl
-
- riverctl layout rivertile left
+*rivertile* uses the *main_amount*, *main_factor*, *view_padding* and
+*outer_padding* options.
# AUTHORS
@@ -41,4 +28,5 @@ source contributors. For more information about river's development, see
# SEE ALSO
-*river-layouts*(7), *river*(1), *riverctl*(1)
+*river*(1), *riverctl*(1)
+