1swaylock(1)                 General Commands Manual                swaylock(1)
2
3
4

NAME

6       swaylock - Screen locker for Wayland
7

SYNOPSIS

9       swaylock [options...]
10
11       Locks your Wayland session.
12

OPTIONS

14       -C, --config <path>
15           The config file to use. By default, the following paths are
16           checked: $HOME/.swaylock/config, $XDG_CONFIG_HOME/swaylock/config,
17           and SYSCONFDIR/swaylock/config. All flags aside from this one are
18           valid options in the configuration file using the format long-op‐
19           tion=value. For options such as ignore-empty-password, just supply
20           the long-option. All leading dashes should be omitted and the
21           equals sign is required for flags that take an argument.
22
23       -d, --debug
24           Enable debugging output.
25
26       -e, --ignore-empty-password
27           When an empty password is provided, do not validate it.
28
29       -F, --show-failed-attempts
30           Show current count of failed authentication attempts.
31
32       -f, --daemonize
33           Detach from the controlling terminal after locking.
34
35           Note: this is the default behavior of i3lock.
36
37       -h, --help
38           Show help message and quit.
39
40       -v, --version
41           Show the version number and quit.
42

APPEARANCE

44       -u, --no-unlock-indicator
45           Disable the unlock indicator.
46
47       -i, --image [[<output>]:]<path>
48           Display the given image, optionally only on the given output. Use
49           -c to set a background color. If the path potentially contains a
50           ':', prefix it with another ':' to prevent interpreting part of it
51           as <output>.
52
53       -k, --show-keyboard-layout
54           Display the current xkb layout while typing.
55
56       -K, --hide-keyboard-layout
57           Force hiding the current xkb layout while typing, even if more than
58           one layout is configured or the show-keyboard-layout option is set.
59
60       -L, --disable-caps-lock-text
61           Disable the Caps Lock text.
62
63       -l, --indicator-caps-lock
64           Show the current Caps Lock state also on the indicator.
65
66       -s, --scaling
67           Image scaling mode: stretch, fill, fit, center, tile, solid_color.
68           Use solid_color to display only the background color, even if a
69           background image is specified.
70
71       -t, --tiling
72           Same as --scaling=tile.
73
74       -c, --color <rrggbb[aa]>
75           Turn the screen into the given color instead of white. If -i is
76           used, this sets the background of the image to the given color. De‐
77           faults to white (FFFFFF).
78
79       --bs-hl-color <rrggbb[aa]>
80           Sets the color of backspace highlight segments.
81
82       --caps-lock-bs-hl-color <rrggbb[aa]>
83           Sets the color of backspace highlight segments when Caps Lock is
84           active.
85
86       --caps-lock-key-hl-color <rrggbb[aa]>
87           Sets the color of the key press highlight segments when Caps Lock
88           is active.
89
90       --font <font>
91           Sets the font of the text.
92
93       --font-size <size>
94           Sets a fixed font size for the indicator text.
95
96       --indicator-idle-visible
97           Sets the indicator to show even if idle.
98
99       --indicator-radius <radius>
100           Sets the indicator radius. The default value is 50.
101
102       --indicator-thickness <thickness>
103           Sets the indicator thickness. The default value is 10.
104
105       --indicator-x-position <x>
106           Sets the horizontal position of the indicator.
107
108       --indicator-y-position <y>
109           Sets the vertical position of the indicator.
110
111       --inside-color <rrggbb[aa]>
112           Sets the color of the inside of the indicator.
113
114       --inside-clear-color <rrggbb[aa]>
115           Sets the color of the inside of the indicator when cleared.
116
117       --inside-caps-lock-color <rrggbb[aa]>
118           Sets the color of the inside of the indicator when Caps Lock is ac‐
119           tive.
120
121       --inside-ver-color <rrggbb[aa]>
122           Sets the color of the inside of the indicator when verifying.
123
124       --inside-wrong-color <rrggbb[aa]>
125           Sets the color of the inside of the indicator when invalid.
126
127       --key-hl-color <rrggbb[aa]>
128           Sets the color of the key press highlight segments.
129
130       --layout-bg-color <rrggbb[aa]>
131           Sets the background color of the box containing the layout text.
132
133       --layout-border-color <rrggbb[aa]>
134           Sets the color of the border of the box containing the layout text.
135
136       --layout-text-color <rrggbb[aa]>
137           Sets the color of the layout text.
138
139       --line-color <rrggbb[aa]>
140           Sets the color of the line between the inside and ring.
141
142       --line-clear-color <rrggbb[aa]>
143           Sets the color of the line between the inside and ring when
144           cleared.
145
146       --line-caps-lock-color <rrggbb[aa]>
147           Sets the color of the line between the inside and ring when Caps
148           Lock is active.
149
150       --line-ver-color <rrggbb[aa]>
151           Sets the color of the line between the inside and ring when verify‐
152           ing.
153
154       --line-wrong-color <rrggbb[aa]>
155           Sets the color of the line between the inside and ring when in‐
156           valid.
157
158       -n, --line-uses-inside
159           Use the inside color for the line between the inside and ring.
160
161       -r, --line-uses-ring
162           Use the ring color for the line between the inside and ring.
163
164       --ring-color <rrggbb[aa]>
165           Sets the color of the ring of the indicator when typing or idle.
166
167       --ring-clear-color <rrggbb[aa]>
168           Sets the color of the ring of the indicator when cleared.
169
170       --ring-caps-lock-color <rrggbb[aa]>
171           Sets the color of the ring of the indicator when Caps Lock is ac‐
172           tive.
173
174       --ring-ver-color <rrggbb[aa]>
175           Sets the color of the ring of the indicator when verifying.
176
177       --ring-wrong-color <rrggbb[aa]>
178           Sets the color of the ring of the indicator when invalid.
179
180       --separator-color <rrggbb[aa]>
181           Sets the color of the lines that separate highlight segments.
182
183       --text-color <rrggbb[aa]>
184           Sets the color of the text.
185
186       --text-clear-color <rrggbb[aa]>
187           Sets the color of the text when cleared.
188
189       --text-caps-lock-color <rrggbb[aa]>
190           Sets the color of the text when Caps Lock is active.
191
192       --text-ver-color <rrggbb[aa]>
193           Sets the color of the text when verifying.
194
195       --text-wrong-color <rrggbb[aa]>
196           Sets the color of the text when invalid.
197

SIGNALS

199       SIGUSR1
200           Unlock the screen and exit.
201

AUTHORS

203       Maintained by Drew DeVault <sir@cmpwn.com>, who is assisted by other
204       open source contributors. For more information about swaylock develop‐
205       ment, see https://github.com/swaywm/swaylock.
206
207
208
209                                  2023-07-22                       swaylock(1)
Impressum