LinuxCommandLibrary

i3lock

Lock the screen

TLDR

Lock the screen showing a white background

$ i3lock
copy

Lock the screen with a simple color background (rrggbb format)
$ i3lock [[-c|--color]] [0000ff]
copy

Lock the screen to a PNG background
$ i3lock [[-i|--image]] [path/to/file.png]
copy

Lock the screen and disable the unlock indicator (removes feedback on keypress)
$ i3lock [[-u|--no-unlock-indicator]]
copy

Lock the screen and don't hide the mouse pointer
$ i3lock [[-p|--pointer]] [default]
copy

Lock the screen to a PNG background tiled over all monitors
$ i3lock [[-i|--image]] [path/to/file.png] [[-t|--tiling]]
copy

Lock the screen and show the number of failed login attempts
$ i3lock [[-f|--show-failed-attempts]]
copy

SYNOPSIS

i3lock [options]

PARAMETERS

-v
    Verbose output. Shows debug messages.

-n
    No unlock indicator. Hides the default password prompt feedback.

-m
    Specify indicator position. The possible values for are: 'top', 'bottom', 'center'.

-f
    Fail if another instance of i3lock is running.

-i
    Use as background. Overrides the blurred background.

-c
    Use as background. Specifies a hexadecimal color code (e.g., #RRGGBB).

-d
    Fork to background.

-u
    Disable unlocking.

-t
    Time out if no input after timeout. Requires -d flag.

-e
    Show the current X error during locking.

-version
    Show version and exit.

DESCRIPTION

i3lock is a simple screen locker designed for use with i3 window manager, but usable in any X11 environment. It locks your screen, preventing unauthorized access while you are away. i3lock replaces the screen contents with either a blurred image of the previous screen content, a solid color, or a custom image, and prompts for your password to unlock.

Its key features are: simple design, focus on security, optional image blurring using ImageMagick (or other image processing tools), extensibility through scripts, and support for PAM authentication for reliable password validation. i3lock aims to be lightweight and fast while providing an essential security feature.

CAVEATS

i3lock relies on PAM for authentication. Incorrect PAM configuration can lead to lock failures. Blurring requires external tools, like imagemagick.

<B>CUSTOMIZATION</B>

i3lock can be customized extensively through scripting. You can write scripts that run before locking, after unlocking, or during the lock process. This allows integrating with other tools, such as displaying system information on the lock screen or automatically suspending the system after a certain time.

<B>SECURITY CONSIDERATIONS</B>

While i3lock aims to be secure, it is crucial to keep your system and its dependencies up-to-date. Also be cautious with external scripts used with i3lock. Do not run untrusted scripts, as they can compromise the security of your system.

HISTORY

i3lock was created as part of the i3 window manager project to provide a simple and secure screen locking utility. It has evolved to support various configuration options and extensions, reflecting the needs of its user base. Development is active, with regular updates and bug fixes.

SEE ALSO

xlock(1), slock(1)

Copied to clipboard