aboutsummaryrefslogtreecommitdiff
path: root/doc/rivertile.1.scd
diff options
context:
space:
mode:
authorIsaac Freund <ifreund@ifreund.xyz>2021-04-26 23:41:30 +0200
committerIsaac Freund <ifreund@ifreund.xyz>2021-04-27 00:10:20 +0200
commit07fd1b86caebc21242bd12bc86de03aa3b0b3b51 (patch)
tree0bc971aaa928b6306b90909036bea033cb7cc6c8 /doc/rivertile.1.scd
parente80b883a47d0a2fe3d42f42d1eb56969728ea162 (diff)
downloadriver-07fd1b86caebc21242bd12bc86de03aa3b0b3b51.tar.gz
river-07fd1b86caebc21242bd12bc86de03aa3b0b3b51.tar.xz
rivertile: support command line arguments
Add support for command line arguments to set default values for the various options of rivertile, bringing us back to rough feature parity with before the commit removing the river-options protocol.
Diffstat (limited to 'doc/rivertile.1.scd')
-rw-r--r--doc/rivertile.1.scd19
1 files changed, 18 insertions, 1 deletions
diff --git a/doc/rivertile.1.scd b/doc/rivertile.1.scd
index e94b39c..751e327 100644
--- a/doc/rivertile.1.scd
+++ b/doc/rivertile.1.scd
@@ -6,13 +6,30 @@ rivertile - Tiled layout generator for river
# SYNOPSIS
-*rivertile*
+*rivertile* [_options_]
# DESCRIPTION
*rivertile* is a layout client for river. It provides a simple tiled layout
split main/secondary stacks.
+# OPTIONS
+
+*-view-padding* _pixels_
+ Set the padding around views in pixels.
+
+*-outer-padding* _pixels_
+ Set the padding around the edge of the layout area in pixels.
+
+*-main-location* [*top*|*bottom*|*left*|*right*]
+ Set the default location of the main area in the layout.
+
+*-main-count* _count_
+ Set the default number of views in the main area of the layout.
+
+*-main-factor* _ratio_
+ Set the default ratio of main area to total layout area.
+
# VALUES
_main_location_ (string: top, bottom, left, or right)