1wlogout(1) General Commands Manual wlogout(1)
2
3
4
6 wlogout - A Wayland logout menu
7
9 wlogout [options] [command]
10
12 -h, --help
13 Show help message and stop
14
15 -l, --layout <layout>
16 Specify a custom layout file
17
18 -v, --version
19 Show version number and stop
20
21 -C, -css <css>
22 Specify a custom css file
23
24 -b, --buttons-per-row <num>
25 Set the number of buttons per row
26
27 -c, --column-spacing <space>
28 Set space between buttons columns
29
30 -r, --row-spacing <space>
31 Set space between buttons rows
32
33 -m, --margin <padding>
34 Set margin on all sides
35
36 -L, --margin-left <padding>
37 Set margin for left of buttons
38
39 -R, --margin-right <padding>
40 Set margin for right of buttons
41
42 -T, --margin-right <padding>
43 Set margin for top of buttons
44
45 -B, --margin-right <padding>
46 Set margin for bottom of buttons
47
48 -p, --protocol <protocol>
49 Takes either layer-shell or xdg. The layer-shell allows transpar‐
50 ency effects; however, only a few compositors correctly support it.
51 The xdg protocol will work on almost all compositors, but does not
52 allow for transparency.
53
55 wlogout was created to replace oblogout with a native logout script for
56 Wayland. It also seeks to be a faster alternative that does not rely on
57 depracated technology such as python 2; while maintaining a small code
58 footprint.
59
60 You can run wlogout from any Wayland environment and it should just
61 work.
62
64 Wlogout searches for a layout and style.css file in the following loca‐
65 tions, in this order:
66
67 1. $XDG_CONFIG_HOME/wlogout/
68 2. /etc/wlogout/
69 3. /usr/local/etc/wlogout
70
71
72 If unset, $XDG_CONFIG_HOME defaults to ~/.config/.
73
74 An error is raised when no layout file is found; However, the style.css
75 file is optional. If you would like to customise either it is recom‐
76 mended that you copy the defaults from /etc/wlogout/ into ~/.config
77 and make any changes there.
78
80 Maintained by Haden Collins <collinshaden@gmail.com> for more informa‐
81 tion about wlogout, see <https://github.com/ArtsyMacaw/wlogout>.
82
84 wlogout(5)
85
86
87
88 2022-01-22 wlogout(1)