aboutsummaryrefslogtreecommitdiff
path: root/doc/river.1.scd
diff options
context:
space:
mode:
authorLeon Henrik Plickat <leonhenrik.plickat@stud.uni-goettingen.de>2020-12-13 00:51:51 +0100
committerIsaac Freund <ifreund@ifreund.xyz>2020-12-13 01:19:27 +0100
commitf08d37ab2887c6ba706ace3862a97c6e2c9c6194 (patch)
tree56e55682b7f485102ed0b251d9cc85eb5b2b243e /doc/river.1.scd
parentb2b1a1f5e1f16fd42d547024001d00021c4a25c9 (diff)
downloadriver-f08d37ab2887c6ba706ace3862a97c6e2c9c6194.tar.gz
river-f08d37ab2887c6ba706ace3862a97c6e2c9c6194.tar.xz
doc: unify scdoc style
This unifies the style of the man page source files. Most noticable are the now consistent line endings at 80 chars (assuming a tabwidth of 8).
Diffstat (limited to 'doc/river.1.scd')
-rw-r--r--doc/river.1.scd25
1 files changed, 13 insertions, 12 deletions
diff --git a/doc/river.1.scd b/doc/river.1.scd
index ef16577..c08a696 100644
--- a/doc/river.1.scd
+++ b/doc/river.1.scd
@@ -1,7 +1,8 @@
RIVER(1) "github.com/ifreund/river" "General Commands Manual"
+
# NAME
-river - dynamic tiling Wayland compositor
+river - Dynamic tiling Wayland compositor
# SYNOPSIS
@@ -9,19 +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 inspired by dwm and bspwm based
+on wlroots and written in Zig.
# OPTIONS
*-c* _shell_command_
- Run a shell command or give the path to a script that will be run
- after river's wayland server is initialized but before entering the
- main loop. You may use this to configure river and define keymaps
- using *riverctl*(1), start programs such as a status bar, or perhaps
- run a service manager. If the process started by this flag is still
- running when river exits, river will send SIGTERM and and wait for it
- to terminate.
+ Run a shell command or give the path to a script that will be run after
+ river's wayland server is initialized but before entering the main
+ loop. You may use this to configure river and define keymaps using
+ *riverctl*(1), start programs such as a status bar, or perhaps run a
+ service manager. If the process started by this flag is still running
+ when river exits, river will send SIGTERM and and wait for it to
+ terminate.
*-l* _log_level_
Set the log level of river to a value from 0 to 7 with 0 being the
@@ -30,8 +31,8 @@ bspwm based on wlroots and written in Zig.
# CONFIGURATION
-You can define the list of programs which should float in _Config.zig_.
-Make your changes and recompile.
+You can define the list of programs which should float in _Config.zig_. Make
+your changes and recompile.
Experimental XWayland support can be enabled on compile-time with the
_-Dxwayland=true_ flag.