aboutsummaryrefslogtreecommitdiff
path: root/doc/river.1.scd
diff options
context:
space:
mode:
authorIsaac Freund <ifreund@ifreund.xyz>2020-12-30 23:10:41 +0100
committerIsaac Freund <ifreund@ifreund.xyz>2020-12-30 23:10:41 +0100
commit397f40e40594ff02b1ddf79a5c4a43b9357ef578 (patch)
tree865de363e10064155627fea3ec04917a3ef8fcfe /doc/river.1.scd
parent53d4c12d41a904d36fe294c7ab5573a7d6e00e30 (diff)
downloadriver-397f40e40594ff02b1ddf79a5c4a43b9357ef578.tar.gz
river-397f40e40594ff02b1ddf79a5c4a43b9357ef578.tar.xz
docs: Improve clarity of river/riverctl man pages
Diffstat (limited to 'doc/river.1.scd')
-rw-r--r--doc/river.1.scd13
1 files changed, 9 insertions, 4 deletions
diff --git a/doc/river.1.scd b/doc/river.1.scd
index 9d5f5b0..9ca0c43 100644
--- a/doc/river.1.scd
+++ b/doc/river.1.scd
@@ -2,7 +2,7 @@ RIVER(1) "github.com/ifreund/river" "General Commands Manual"
# NAME
-river - Dynamic tiling Wayland compositor
+river - dynamic tiling Wayland compositor
# SYNOPSIS
@@ -10,14 +10,19 @@ river - Dynamic tiling Wayland compositor
# DESCRIPTION
-*river* is a dynamic tiling Wayland compositor inspired by dwm and bspwm based
-on wlroots and written in Zig.
+*river* is a dynamic tiling Wayland compositor. Window management is based on
+a stack of views laid out dynamically by an external layout generator. Tags
+are used instead of workspaces allowing for increased flexibility.
+
+All runtime configuration and control happens through wayland protocols,
+including several river-specific protocol extensions. The *riverctl*(1)
+utility may be used to communicate with river over these protocols.
# OPTIONS
*-c* _shell_command_
Override the default search paths for an init executable: instead
- _shell_command_ will be run with `/bin/sh -c`. See the *CONFIGURATION*
+ _shell_command_ will be run with _/bin/sh -c_. See the *CONFIGURATION*
section for more details.
*-l* _log_level_