From 35ceb08e1eb6fa4945da161d0c7de9b9d45e83ff Mon Sep 17 00:00:00 2001 From: Lennard Hofmann Date: Thu, 4 Jun 2020 19:52:21 +0200 Subject: Add man pages --- doc/river.1 | 41 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 41 insertions(+) create mode 100644 doc/river.1 (limited to 'doc/river.1') diff --git a/doc/river.1 b/doc/river.1 new file mode 100644 index 0000000..3f72980 --- /dev/null +++ b/doc/river.1 @@ -0,0 +1,41 @@ +.TH RIVER 1 2020-06-04 github.com/ifreund/river "General Commands Manual" + +.SH NAME +river \- dynamic tiling Wayland compositor + +.SH SYNOPSIS +.BR river " [" -c +.IR shell_command ] + +.SH DESCRIPTION +.B river +is a dynamic tiling Wayland compositor inspired by dwm and bspwm +based on wlroots and written in Zig. + +.SH OPTIONS + +.TP +.BI -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 +.BR riverctl (1) +and autostart programs. +Make sure the script is executable. + +.SH CONFIGURATION +View border width, gap sizes, and programs which should float are configured in +.IR Config.zig . +Make your changes and recompile. + +.PP +Experimental XWayland support can be enabled on compile-time with the +.I -Dxwayland=true +flag. + +Keyboard layout and other XKB options can be set in +.IR Keyboard.zig . + +.SH SEE ALSO + +.BR riverctl "(1), " bspwm "(1), " dwm (1) -- cgit v1.2.3