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

AUTHORS

192       Maintained by Drew DeVault <sir@cmpwn.com>, who is assisted by other
193       open source contributors. For more information about swaylock develop‐
194       ment, see https://github.com/swaywm/swaylock.
195
196
197
198                                  2021-01-27                       swaylock(1)
Impressum