From b2986fedd57f85e7af079caa997435512213c57d Mon Sep 17 00:00:00 2001 From: Lennard Hofmann Date: Mon, 15 Jun 2020 09:51:23 +0200 Subject: docs: use scdoc instead of roff for man pages --- doc/river.1.scd | 35 +++++++++++++++++++++++++++++++++++ 1 file changed, 35 insertions(+) create mode 100644 doc/river.1.scd (limited to 'doc/river.1.scd') diff --git a/doc/river.1.scd b/doc/river.1.scd new file mode 100644 index 0000000..bc04b06 --- /dev/null +++ b/doc/river.1.scd @@ -0,0 +1,35 @@ +RIVER(1) "github.com/ifreund/river" "General Commands Manual" +# NAME + +river - dynamic tiling Wayland compositor + +# SYNOPSIS + +*river* [*-c* _shell_command_] + +# DESCRIPTION + +*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 + before river gets started. This is where you define keymaps using + *riverctl*(1) and autostart programs. Make sure the script is + executable. + +# CONFIGURATION + +View border width, gap sizes, and programs which should float are +configured in _Config.zig_. Make your changes and recompile. + +Experimental XWayland support can be enabled on compile-time with the +_-Dxwayland=true_ flag. + +Keyboard layout and other XKB options can be set in _Keyboard.zig_. + +# SEE ALSO + +*riverctl*(1), *bspwm*(1), *dwm*(1) -- cgit v1.2.3