1swaylock(1) General Commands Manual swaylock(1)
2
6 swaylock - Screen locker for Wayland
7
9 swaylock [options...]
10 Locks your Wayland session.
12
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-
19 option=value. For options such as ignore-empty-password, just sup‐
20 ply the long-option. All leading dashes should be omitted and the
21 equals sign is required for flags that take an argument.
22 -d, --debug
24 Enable debugging output.
25 -e, --ignore-empty-password
27 When an empty password is provided by the user, do not validate it.
28 -F, --show-failed-attempts
30 Show the number of failed authentication attempts on the indicator.
31 -f, --daemonize
33 Detach from the controlling terminal after locking.
34 Note: this is the default behavior of i3lock.
36 -h, --help
38 Show help message and quit.
39 -v, --version
41 Show the version number and quit.
42
44 -u, --no-unlock-indicator
45 Disable the unlock indicator.
46 -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 -k, --show-keyboard-layout
53 Force displaying the current xkb layout while typing, even if only
54 one layout is configured.
55 -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 -L, --disable-caps-lock-text
61 Disable the Caps Lock Text.
62 -l, --indicator-caps-lock
64 Show the current Caps Lock state also on the indicator.
65 -s, --scaling
67 Scaling mode for images: stretch, fill, fit, center, or tile. Use
68 the additional mode solid_color to display only the background
69 color, even if a background image is specified.
70 -t, --tiling
72 Same as --scaling=tile.
73 -c, --color <rrggbb[aa]>
75 Turn the screen into the given color. If -i is used, this sets the
76 background of the image to the given color. Defaults to white
77 (FFFFFF).
78 --bs-hl-color <rrggbb[aa]>
80 Sets the color of backspace highlight segments.
81 --caps-lock-bs-hl-color <rrggbb[aa]>
83 Sets the color of backspace highlight segments when Caps Lock is
84 active.
85 --caps-lock-key-hl-color <rrggbb[aa]>
87 Sets the color of the key press highlight segments when Caps Lock
88 is active.
89 --font <font>
91 Sets the font of the text inside the indicator.
92 --indicator-radius <radius>
94 Sets the radius of the indicator to radius pixels. The default
95 value is 50.
96 --indicator-thickness <thickness>
98 Sets the thickness of the indicator to thickness pixels. The
99 default value is 10.
100 --inside-color <rrggbb[aa]>
102 Sets the color of the inside of the indicator when typing or idle.
103 --inside-clear-color <rrggbb[aa]>
105 Sets the color of the inside of the indicator when cleared.
106 --inside-caps-lock-color <rrggbb[aa]>
108 Sets the color of the inside of the indicator when Caps Lock is
109 active.
110 --inside-ver-color <rrggbb[aa]>
112 Sets the color of the inside of the indicator when verifying.
113 --inside-wrong-color <rrggbb[aa]>
115 Sets the color of the inside of the indicator when invalid.
116 --key-hl-color <rrggbb[aa]>
118 Sets the color of key press highlight segments.
119 --layout-bg-color <rrggbb[aa]>
121 Sets the background color of the box containing the layout text.
122 --layout-border-color <rrggbb[aa]>
124 Sets the color of the border of the box containing the layout text.
125 --layout-text-color <rrggbb[aa]>
127 Sets the color of the layout text.
128 --line-color <rrggbb[aa]>
130 Sets the color of the lines that separate the inside and outside of
131 the indicator when typing or idle.
132 --line-clear-color <rrggbb[aa]>
134 Sets the color of the lines that separate the inside and outside of
135 the indicator when cleared.
136 --line-caps-lock-color <rrggbb[aa]>
138 Sets the color of the line between the inside and ring when Caps
139 Lock is active.
140 --line-ver-color <rrggbb[aa]>
142 Sets the color of the lines that separate the inside and outside of
143 the indicator when verifying.
144 --line-wrong-color <rrggbb[aa]>
146 Sets the color of the lines that separate the inside and outside of
147 the indicator when invalid.
148 -n, --line-uses-inside
150 Use the color of the inside of the indicator for the line separat‐
151 ing the inside and outside of the indicator.
152 -r, --line-uses-ring
154 Use the outer ring's color for the line separating the inside and
155 outside of the indicator.
156 --ring-color <rrggbb[aa]>
158 Sets the color of the outside of the indicator when typing or idle.
159 --ring-clear-color <rrggbb[aa]>
161 Sets the color of the outside of the indicator when cleared.
162 --ring-caps-lock-color <rrggbb[aa]>
164 Sets the color of the ring of the indicator when Caps Lock is
165 active.
166 --ring-ver-color <rrggbb[aa]>
168 Sets the color of the outside of the indicator when verifying.
169 --ring-wrong-color <rrggbb[aa]>
171 Sets the color of the outside of the indicator when invalid.
172 --separator-color <rrggbb[aa]>
174 Sets the color of the lines that separate highlight segments.
175 --text-color <rrggbb[aa]>
177 Sets the color of the text inside the indicator when typing or
178 idle.
179 --text-clear-color <rrggbb[aa]>
181 Sets the color of the text inside the indicator when cleared.
182 --text-caps-lock-color <rrggbb[aa]>
184 Sets the color of the text when Caps Lock is active.
185 --text-ver-color <rrggbb[aa]>
187 Sets the color of the text inside the indicator when verifying.
188 --text-wrong-color <rrggbb[aa]>
190 Sets the color of the text inside the indicator when invalid.
191
193 Maintained by Drew DeVault <sir@cmpwn.com>, who is assisted by other
194 open source contributors. For more information about swaylock develop‐
195 ment, see https://github.com/swaywm/swaylock.
196 2019-07-27 swaylock(1)