]> git.mdlowis.com Git - proto/labwc.git/commitdiff
Add labwc(1) man page
authorJohan Malm <jgm323@gmail.com>
Sat, 18 Jul 2020 10:50:08 +0000 (11:50 +0100)
committerJohan Malm <jgm323@gmail.com>
Sat, 18 Jul 2020 10:50:08 +0000 (11:50 +0100)
docs/labwc.1.md [new file with mode: 0644]

diff --git a/docs/labwc.1.md b/docs/labwc.1.md
new file mode 100644 (file)
index 0000000..3595ff3
--- /dev/null
@@ -0,0 +1,58 @@
+% labwc(1)
+% Johan Malm
+% 18 July, 2020
+
+# NAME
+
+labwc - A Wayland stacking compositor with the look and feel of Openbox
+
+# SYNOPSIS
+
+labwc \[\-s <*startup-command*>] \[\-c <*config-file*>]  
+
+# DESCRIPTION
+
+Labwc is a [WIP] free, stacking compositor for Wayland. It aims to be light-weight and have the feel of Openbox.
+
+# OPTIONS
+
+`-s <startup-command>`
+
+:   Specify startup command
+
+`-c <config-file>`
+
+:   Specify path to rc.xml
+
+# CONFIGURATION FILES
+
+If no file is specified using the -c option, the XDG Base Directory
+Specification is adhered to using `labwc` in preference to `openbox`.
+
+Configuration files will be searched for in the following order:
+
+- `${XDG_CONFIG_HOME:-$HOME/.config}/labwc`  
+- `${XDG_CONFIG_DIRS:-/etc/xdg}/labwc`  
+- `${XDG_CONFIG_HOME:-$HOME/.config}/openbox`  
+- `${XDG_CONFIG_DIRS:-/etc/xdg}/openbox`  
+
+See labwc(5) for rc.xml options.
+
+# THEME
+
+The theme engine aims to be compatible with openbox themes.
+
+Themes will be searched for in the following order:
+
+- `${XDG_DATA_HOME:-$HOME/.local/share}/themes`  
+- `$HOME/.themes`  
+- `/usr/share/themes`  
+- `/usr/local/share/themes`  
+- `/opt/share/themes`  
+
+See labwc(5) for theme options.
+
+# SEE ALSO
+
+- `labwc(5)`
+