labwc/docs/labwc.1.md

55 lines
1.4 KiB
Markdown
Raw Normal View History

2020-07-18 11:50:08 +01:00
% labwc(1)
% Johan Malm
2020-10-08 21:18:09 +01:00
% 8 Oct, 2020
2020-07-18 11:50:08 +01:00
# NAME
labwc - A Wayland stacking compositor with the look and feel of Openbox
# SYNOPSIS
2020-09-25 20:35:48 +01:00
labwc \[\-c <*config-file*>] \[\-h] \[\-s <*startup-command*>]
2020-07-18 11:50:08 +01:00
# DESCRIPTION
Labwc is a [WIP] free, stacking compositor for Wayland. It aims to be light-weight and have the feel of Openbox.
# OPTIONS
`-c <config-file>`
: Specify path to rc.xml
2020-09-25 20:35:48 +01:00
`-h`
: Show help message
`-s <startup-command>`
: Specify startup command
2020-08-07 20:35:18 +01:00
# CONFIGURATION AND THEMES
2020-07-18 11:50:08 +01:00
2020-08-07 20:35:18 +01:00
Labwc aims to be compatible with openbox configuration and theming, with the
2020-08-18 20:03:52 +01:00
following files controlling the look and behaviour:
2020-07-18 11:50:08 +01:00
2020-10-08 21:18:09 +01:00
- ~/.config/labwc/rc.xml (see labwc-config(5) for details)
- ~/.config/labwc/autostart
- ~/.config/labwc/environment
- ~/.themes/<name>/openbox-3/themerc (see labwc-theme(5) for details)
2020-07-18 11:50:08 +01:00
2020-10-08 21:18:09 +01:00
Equivalent XDG Base Directory Specification locations are also honoured.
2020-09-25 20:35:48 +01:00
2020-10-08 21:18:09 +01:00
The configuration file and theme are re-loaded on receiving signal SIGHUP.
The autostart file is executed as a shell script. This is a place for setting
a background image, launching a panel, and so on.
The environment file is parsed as `<variable>=<value>` and sets environment
variables accordingly. It is recommended to specify keyboard settings here,
for example: `XKB_DEFAULT_LAYOUT=gb`. See xkeyboard-config(7) for details.
2020-07-18 11:50:08 +01:00
# SEE ALSO
labwc-config(5), labwc-theme(5), labwc-actions(5)