.\" Generated by scdoc 1.11.2 .\" Complete documentation for this program is not available as a GNU info page .ie \n(.g .ds Aq \(aq .el .ds Aq ' .nh .ad l .\" Begin generated content: .TH "swaylock" "1" "2023-01-28" .P .SH NAME .P swaylock - Screen locker for Wayland .P .SH SYNOPSIS .P \fIswaylock\fR [options.\&.\&.\&] .P Locks your Wayland session.\& .P .SH OPTIONS .P \fB-C, --config\fR .RS 4 The config file to use.\& By default, the following paths are checked: \fI$HOME/.\&swaylock/config\fR, \fI$XDG_CONFIG_HOME/swaylock/config\fR, and \fISYSCONFDIR/swaylock/config\fR.\& All flags aside from this one are valid options in the configuration file using the format \fIlong-option=value\fR.\& For options such as \fIignore-empty-password\fR, just supply the \fIlong-option\fR.\& All leading dashes should be omitted and the equals sign is required for flags that take an argument.\& .P .RE \fB-d, --debug\fR .RS 4 Enable debugging output.\& .P .RE \fB-e, --ignore-empty-password\fR .RS 4 When an empty password is provided, do not validate it.\& .P .RE \fB-F, --show-failed-attempts\fR .RS 4 Show current count of failed authentication attempts.\& .P .RE \fB-f, --daemonize\fR .RS 4 Detach from the controlling terminal after locking.\& .P Note: this is the default behavior of i3lock.\& .P .RE \fB-h, --help\fR .RS 4 Show help message and quit.\& .P .RE \fB-v, --version\fR .RS 4 Show the version number and quit.\& .P .RE .SH APPEARANCE .P \fB-u, --no-unlock-indicator\fR .RS 4 Disable the unlock indicator.\& .P .RE \fB-i, --image\fR [[]:] .RS 4 Display the given image, optionally only on the given output.\& Use -c to set a background color.\& If the path potentially contains a '\&:'\&, prefix it with another \&'\&:'\& to prevent interpreting part of it as .\& .P .RE \fB-k, --show-keyboard-layout\fR .RS 4 Display the current xkb layout while typing.\& .P .RE \fB-K, --hide-keyboard-layout\fR .RS 4 Force hiding the current xkb layout while typing, even if more than one layout is configured or the show-keyboard-layout option is set.\& .P .RE \fB-L, --disable-caps-lock-text\fR .RS 4 Disable the Caps Lock text.\& .P .RE \fB-l, --indicator-caps-lock\fR .RS 4 Show the current Caps Lock state also on the indicator.\& .P .RE \fB-s, --scaling\fR .RS 4 Image scaling mode: \fIstretch\fR, \fIfill\fR, \fIfit\fR, \fIcenter\fR, \fItile\fR, \fIsolid_color\fR.\& Use \fIsolid_color\fR to display only the background color, even if a background image is specified.\& .P .RE \fB-t, --tiling\fR .RS 4 Same as --scaling=tile.\& .P .RE \fB-c, --color\fR .RS 4 Turn the screen into the given color instead of white.\& If -i is used, this sets the background of the image to the given color.\& Defaults to white (FFFFFF).\& .P .RE \fB--bs-hl-color\fR .RS 4 Sets the color of backspace highlight segments.\& .P .RE \fB--caps-lock-bs-hl-color\fR .RS 4 Sets the color of backspace highlight segments when Caps Lock is active.\& .P .RE \fB--caps-lock-key-hl-color\fR .RS 4 Sets the color of the key press highlight segments when Caps Lock is active.\& .P .RE \fB--font\fR .RS 4 Sets the font of the text.\& .P .RE \fB--font-size\fR .RS 4 Sets a fixed font size for the indicator text.\& .P .RE \fB--indicator-idle-visible\fR .RS 4 Sets the indicator to show even if idle.\& .P .RE \fB--indicator-radius\fR .RS 4 Sets the indicator radius.\& The default value is 50.\& .P .RE \fB--indicator-thickness\fR .RS 4 Sets the indicator thickness.\& The default value is 10.\& .P .RE \fB--indicator-x-position\fR .RS 4 Sets the horizontal position of the indicator.\& .P .RE \fB--indicator-y-position\fR .RS 4 Sets the vertical position of the indicator.\& .P .RE \fB--inside-color\fR .RS 4 Sets the color of the inside of the indicator.\& .P .RE \fB--inside-clear-color\fR .RS 4 Sets the color of the inside of the indicator when cleared.\& .P .RE \fB--inside-caps-lock-color\fR .RS 4 Sets the color of the inside of the indicator when Caps Lock is active.\& .P .RE \fB--inside-ver-color\fR .RS 4 Sets the color of the inside of the indicator when verifying.\& .P .RE \fB--inside-wrong-color\fR .RS 4 Sets the color of the inside of the indicator when invalid.\& .P .RE \fB--key-hl-color\fR .RS 4 Sets the color of the key press highlight segments.\& .P .RE \fB--layout-bg-color\fR .RS 4 Sets the background color of the box containing the layout text.\& .P .RE \fB--layout-border-color\fR .RS 4 Sets the color of the border of the box containing the layout text.\& .P .RE \fB--layout-text-color\fR .RS 4 Sets the color of the layout text.\& .P .RE \fB--line-color\fR .RS 4 Sets the color of the line between the inside and ring.\& .P .RE \fB--line-clear-color\fR .RS 4 Sets the color of the line between the inside and ring when cleared.\& .P .RE \fB--line-caps-lock-color\fR .RS 4 Sets the color of the line between the inside and ring when Caps Lock is active.\& .P .RE \fB--line-ver-color\fR .RS 4 Sets the color of the line between the inside and ring when verifying.\& .P .RE \fB--line-wrong-color\fR .RS 4 Sets the color of the line between the inside and ring when invalid.\& .P .RE \fB-n, --line-uses-inside\fR .RS 4 Use the inside color for the line between the inside and ring.\& .P .RE \fB-r, --line-uses-ring\fR .RS 4 Use the ring color for the line between the inside and ring.\& .P .RE \fB--ring-color\fR .RS 4 Sets the color of the ring of the indicator when typing or idle.\& .P .RE \fB--ring-clear-color\fR .RS 4 Sets the color of the ring of the indicator when cleared.\& .P .RE \fB--ring-caps-lock-color\fR .RS 4 Sets the color of the ring of the indicator when Caps Lock is active.\& .P .RE \fB--ring-ver-color\fR .RS 4 Sets the color of the ring of the indicator when verifying.\& .P .RE \fB--ring-wrong-color\fR .RS 4 Sets the color of the ring of the indicator when invalid.\& .P .RE \fB--separator-color\fR .RS 4 Sets the color of the lines that separate highlight segments.\& .P .RE \fB--text-color\fR .RS 4 Sets the color of the text.\& .P .RE \fB--text-clear-color\fR .RS 4 Sets the color of the text when cleared.\& .P .RE \fB--text-caps-lock-color\fR .RS 4 Sets the color of the text when Caps Lock is active.\& .P .RE \fB--text-ver-color\fR .RS 4 Sets the color of the text when verifying.\& .P .RE \fB--text-wrong-color\fR .RS 4 Sets the color of the text when invalid.\& .P .RE .SH SIGNALS .P \fBSIGUSR1\fR .RS 4 Unlock the screen and exit.\& .P .RE .SH AUTHORS .P Maintained by Drew DeVault , who is assisted by other open source contributors.\& For more information about swaylock development, see https://github.\&com/swaywm/swaylock.\&