OS Manuals

/usr/bin/swaylock

Screen locker for Wayland compositors implementing ext-session-lock-v1

From swaylock 1.8.6-r6 (enterprise-packages), captured 2026-11-09 by running swaylock --help (exit 1). permalink

Usage: swaylock [options...]

  -C, --config <config_file>       Path to the config file.
  -c, --color <color>              Turn the screen into the given color instead of light gray.
  -d, --debug                      Enable debugging output.
  -e, --ignore-empty-password      When an empty password is provided, do not validate it.
  -F, --show-failed-attempts       Show current count of failed authentication attempts.
  -f, --daemonize                  Detach from the controlling terminal after locking.
  -R, --ready-fd <fd>              File descriptor to send readiness notifications to.
  -h, --help                       Show help message and quit.
  -i, --image [[<output>]:]<path>  Display the given image, optionally only on the given output.
  -k, --show-keyboard-layout       Display the current xkb layout while typing.
  -K, --hide-keyboard-layout       Hide the current xkb layout while typing.
  -L, --disable-caps-lock-text     Disable the Caps Lock text.
  -l, --indicator-caps-lock        Show the current Caps Lock state also on the indicator.
  -s, --scaling <mode>             Image scaling mode: stretch, fill, fit, center, tile, solid_color.
  -t, --tiling                     Same as --scaling=tile.
  -u, --no-unlock-indicator        Disable the unlock indicator.
  -v, --version                    Show the version number and quit.
  --bs-hl-color <color>            Sets the color of backspace highlight segments.
  --caps-lock-bs-hl-color <color>  Sets the color of backspace highlight segments when Caps Lock is active.
  --caps-lock-key-hl-color <color> Sets the color of the key press highlight segments when Caps Lock is active.
  --font <font>                    Sets the font of the text.
  --font-size <size>               Sets a fixed font size for the indicator text.
  --indicator-idle-visible         Sets the indicator to show even if idle.
  --indicator-radius <radius>      Sets the indicator radius.
  --indicator-thickness <thick>    Sets the indicator thickness.
  --indicator-x-position <x>       Sets the horizontal position of the indicator.
  --indicator-y-position <y>       Sets the vertical position of the indicator.
  --inside-color <color>           Sets the color of the inside of the indicator.
  --inside-clear-color <color>     Sets the color of the inside of the indicator when cleared.
  --inside-caps-lock-color <color> Sets the color of the inside of the indicator when Caps Lock is active.
  --inside-ver-color <color>       Sets the color of the inside of the indicator when verifying.
  --inside-wrong-color <color>     Sets the color of the inside of the indicator when invalid.
  --key-hl-color <color>           Sets the color of the key press highlight segments.
  --layout-bg-color <color>        Sets the background color of the box containing the layout text.
  --layout-border-color <color>    Sets the color of the border of the box containing the layout text.
  --layout-text-color <color>      Sets the color of the layout text.
  --line-color <color>             Sets the color of the line between the inside and ring.
  --line-clear-color <color>       Sets the color of the line between the inside and ring when cleared.
  --line-caps-lock-color <color>   Sets the color of the line between the inside and ring when Caps Lock is active.
  --line-ver-color <color>         Sets the color of the line between the inside and ring when verifying.
  --line-wrong-color <color>       Sets the color of the line between the inside and ring when invalid.
  -n, --line-uses-inside           Use the inside color for the line between the inside and ring.
  -r, --line-uses-ring             Use the ring color for the line between the inside and ring.
  --ring-color <color>             Sets the color of the ring of the indicator.
  --ring-clear-color <color>       Sets the color of the ring of the indicator when cleared.
  --ring-caps-lock-color <color>   Sets the color of the ring of the indicator when Caps Lock is active.
  --ring-ver-color <color>         Sets the color of the ring of the indicator when verifying.
  --ring-wrong-color <color>       Sets the color of the ring of the indicator when invalid.
  --separator-color <color>        Sets the color of the lines that separate highlight segments.
  --text-color <color>             Sets the color of the text.
  --text-clear-color <color>       Sets the color of the text when cleared.
  --text-caps-lock-color <color>   Sets the color of the text when Caps Lock is active.
  --text-ver-color <color>         Sets the color of the text when verifying.
  --text-wrong-color <color>       Sets the color of the text when invalid.

All <color> options are of the form <rrggbb[aa]>.
2026-11-09 15:19:50 - [pam.c:88] getpwuid failed: Success
Options (52)
OptionDescriptionSource
-C, --config config_filePath to the config file.help + man
-c, --color colorTurn the screen into the given color instead of light gray.help
-d, --debugEnable debugging output.help + man
-e, --ignore-empty-passwordWhen an empty password is provided, do not validate it.help + man
-F, --show-failed-attemptsShow current count of failed authentication attempts.help + man
-f, --daemonizeDetach from the controlling terminal after locking.help + man
-R, --ready-fd fdFile descriptor to send readiness notifications to.help + man
-h, --helpShow help message and quit.help + man
-i, --image output>]:]<pathDisplay the given image, optionally only on the given output.help
-k, --show-keyboard-layoutDisplay the current xkb layout while typing.help
-K, --hide-keyboard-layoutHide the current xkb layout while typing.help
-L, --disable-caps-lock-textDisable the Caps Lock text.help
-l, --indicator-caps-lockShow the current Caps Lock state also on the indicator.help
-s, --scaling modeImage scaling mode: stretch, fill, fit, center, tile, solid_color.help
-t, --tilingSame as --scaling=tile.help
-u, --no-unlock-indicatorDisable the unlock indicator.help
-v, --versionShow the version number and quit.help + man
--bs-hl-color colorSets the color of backspace highlight segments.help
--caps-lock-bs-hl-color colorSets the color of backspace highlight segments when Caps Lock is active.help
--font fontSets the font of the text.help
--font-size sizeSets a fixed font size for the indicator text.help
--indicator-idle-visibleSets the indicator to show even if idle.help
--indicator-radius radiusSets the indicator radius.help
--indicator-thickness thickSets the indicator thickness.help
--indicator-x-position xSets the horizontal position of the indicator.help
--indicator-y-position ySets the vertical position of the indicator.help
--inside-color colorSets the color of the inside of the indicator.help
--inside-clear-color colorSets the color of the inside of the indicator when cleared.help
--inside-ver-color colorSets the color of the inside of the indicator when verifying.help
--inside-wrong-color colorSets the color of the inside of the indicator when invalid.help
--key-hl-color colorSets the color of the key press highlight segments.help
--layout-bg-color colorSets the background color of the box containing the layout text.help
--layout-border-color colorSets the color of the border of the box containing the layout text.help
--layout-text-color colorSets the color of the layout text.help
--line-color colorSets the color of the line between the inside and ring.help
--line-clear-color colorSets the color of the line between the inside and ring when cleared.help
--line-caps-lock-color colorSets the color of the line between the inside and ring when Caps Lock is active.help
--line-ver-color colorSets the color of the line between the inside and ring when verifying.help
--line-wrong-color colorSets the color of the line between the inside and ring when invalid.help
-n, --line-uses-insideUse the inside color for the line between the inside and ring.help
-r, --line-uses-ringUse the ring color for the line between the inside and ring.help
--ring-color colorSets the color of the ring of the indicator.help
--ring-clear-color colorSets the color of the ring of the indicator when cleared.help
--ring-caps-lock-color colorSets the color of the ring of the indicator when Caps Lock is active.help
--ring-ver-color colorSets the color of the ring of the indicator when verifying.help
--ring-wrong-color colorSets the color of the ring of the indicator when invalid.help
--separator-color colorSets the color of the lines that separate highlight segments.help
--text-color colorSets the color of the text.help
--text-clear-color colorSets the color of the text when cleared.help
--text-caps-lock-color colorSets the color of the text when Caps Lock is active.help
--text-ver-color colorSets the color of the text when verifying.help
--text-wrong-color colorSets the color of the text when invalid.help

Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.