.\" Generated by scdoc 1.11.5 .\" 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" "2026\-07\-09" .PP .SH NAME .PP swaylock \- Screen locker for Wayland .PP .SH SYNOPSIS .PP \fIswaylock\fR [options.\&.\&.\&] .PP Locks your Wayland session.\& .PP .SH OPTIONS .PP \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.\& For example: .PP .nf .RS 4 image=/usr/share/backgrounds/sway/Sway_Wallpaper_Blue_768x1024\&.png scaling=center show\-failed\-attempts ring\-color=#ff00ff .fi .RE .PP .RE \fB\-d, \-\-debug\fR .RS 4 Enable debugging output.\& .PP .RE \fB\-e, \-\-ignore\-empty\-password\fR .RS 4 When an empty password is provided, do not validate it.\& .PP .RE \fB\-F, \-\-show\-failed\-attempts\fR .RS 4 Show current count of failed authentication attempts.\& .PP .RE \fB\-f, \-\-daemonize\fR .RS 4 Detach from the controlling terminal after locking.\& .PP Note: this is the default behavior of i3lock.\& .PP .RE \fB\-R, \-\-ready\-fd\fR .RS 4 File descriptor to send readiness notifications to.\& .PP When the session has been locked, a single newline is written to the FD.\& At this point, the compositor guarantees that no security sensitive content is visible on\-screen.\& .PP .RE \fB\-h, \-\-help\fR .RS 4 Show help message and quit.\& .PP .RE \fB\-v, \-\-version\fR .RS 4 Show the version number and quit.\& .PP .RE .SH APPEARANCE .PP \fB\-u, \-\-no\-unlock\-indicator\fR .RS 4 Disable the unlock indicator.\& .PP .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 .\& .PP .RE \fB\-k, \-\-show\-keyboard\-layout\fR .RS 4 Display the current xkb layout while typing.\& .PP .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.\& .PP .RE \fB\-L, \-\-disable\-caps\-lock\-text\fR .RS 4 Disable the Caps Lock text.\& .PP .RE \fB\-l, \-\-indicator\-caps\-lock\fR .RS 4 Show the current Caps Lock state also on the indicator.\& .PP .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.\& .PP .RE \fB\-t, \-\-tiling\fR .RS 4 Same as \-\-scaling=tile.\& .PP .RE \fB\-c, \-\-color\fR .RS 4 Turn the screen into the given color instead of light gray.\& If \-i is used, this sets the background of the image to the given color.\& Defaults to light gray (A3A3A3).\& .PP .RE \fB\-\-bs\-hl\-color\fR .RS 4 Sets the color of backspace highlight segments.\& .PP .RE \fB\-\-caps\-lock\-bs\-hl\-color\fR .RS 4 Sets the color of backspace highlight segments when Caps Lock is active.\& .PP .RE \fB\-\-caps\-lock\-key\-hl\-color\fR .RS 4 Sets the color of the key press highlight segments when Caps Lock is active.\& .PP .RE \fB\-\-font\fR .RS 4 Sets the font of the text.\& .PP .RE \fB\-\-font\-size\fR .RS 4 Sets a fixed font size for the indicator text.\& .PP .RE \fB\-\-indicator\-idle\-visible\fR .RS 4 Sets the indicator to show even if idle.\& .PP .RE \fB\-\-indicator\-radius\fR .RS 4 Sets the indicator radius.\& The default value is 50.\& .PP .RE \fB\-\-indicator\-thickness\fR .RS 4 Sets the indicator thickness.\& The default value is 10.\& .PP .RE \fB\-\-indicator\-x\-position\fR .RS 4 Sets the horizontal position of the indicator.\& .PP .RE \fB\-\-indicator\-y\-position\fR .RS 4 Sets the vertical position of the indicator.\& .PP .RE \fB\-\-inside\-color\fR .RS 4 Sets the color of the inside of the indicator.\& .PP .RE \fB\-\-inside\-clear\-color\fR .RS 4 Sets the color of the inside of the indicator when cleared.\& .PP .RE \fB\-\-inside\-caps\-lock\-color\fR .RS 4 Sets the color of the inside of the indicator when Caps Lock is active.\& .PP .RE \fB\-\-inside\-ver\-color\fR .RS 4 Sets the color of the inside of the indicator when verifying.\& .PP .RE \fB\-\-inside\-wrong\-color\fR .RS 4 Sets the color of the inside of the indicator when invalid.\& .PP .RE \fB\-\-key\-hl\-color\fR .RS 4 Sets the color of the key press highlight segments.\& .PP .RE \fB\-\-layout\-bg\-color\fR .RS 4 Sets the background color of the box containing the layout text.\& .PP .RE \fB\-\-layout\-border\-color\fR .RS 4 Sets the color of the border of the box containing the layout text.\& .PP .RE \fB\-\-layout\-text\-color\fR .RS 4 Sets the color of the layout text.\& .PP .RE \fB\-\-line\-color\fR .RS 4 Sets the color of the line between the inside and ring.\& .PP .RE \fB\-\-line\-clear\-color\fR .RS 4 Sets the color of the line between the inside and ring when cleared.\& .PP .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.\& .PP .RE \fB\-\-line\-ver\-color\fR .RS 4 Sets the color of the line between the inside and ring when verifying.\& .PP .RE \fB\-\-line\-wrong\-color\fR .RS 4 Sets the color of the line between the inside and ring when invalid.\& .PP .RE \fB\-n, \-\-line\-uses\-inside\fR .RS 4 Use the inside color for the line between the inside and ring.\& .PP .RE \fB\-r, \-\-line\-uses\-ring\fR .RS 4 Use the ring color for the line between the inside and ring.\& .PP .RE \fB\-\-ring\-color\fR .RS 4 Sets the color of the ring of the indicator when typing or idle.\& .PP .RE \fB\-\-ring\-clear\-color\fR .RS 4 Sets the color of the ring of the indicator when cleared.\& .PP .RE \fB\-\-ring\-caps\-lock\-color\fR .RS 4 Sets the color of the ring of the indicator when Caps Lock is active.\& .PP .RE \fB\-\-ring\-ver\-color\fR .RS 4 Sets the color of the ring of the indicator when verifying.\& .PP .RE \fB\-\-ring\-wrong\-color\fR .RS 4 Sets the color of the ring of the indicator when invalid.\& .PP .RE \fB\-\-separator\-color\fR .RS 4 Sets the color of the lines that separate highlight segments.\& .PP .RE \fB\-\-text\-color\fR .RS 4 Sets the color of the text.\& .PP .RE \fB\-\-text\-clear\-color\fR .RS 4 Sets the color of the text when cleared.\& .PP .RE \fB\-\-text\-caps\-lock\-color\fR .RS 4 Sets the color of the text when Caps Lock is active.\& .PP .RE \fB\-\-text\-ver\-color\fR .RS 4 Sets the color of the text when verifying.\& .PP .RE \fB\-\-text\-wrong\-color\fR .RS 4 Sets the color of the text when invalid.\& .PP .RE .SH SIGNALS .PP \fBSIGUSR1\fR .RS 4 Unlock the screen and exit.\& .PP .RE .SH AUTHORS .PP Maintained by Drew DeVault , who is assisted by other open source contributors.\& For more information about swaylock development, see https://github.\&com/swaywm/swaylock.\&