i3lock.1

.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..

.TH i3lock 1 "JANUARY 2012" Linux "User Manuals"

.SH NAME
i3lock \- improved screen locker

.SH SYNOPSIS
.B i3lock
.RB [\|\-v\|]
.RB [\|\-n\|]
.RB [\|\-b\|]
.RB [\|\-i
.IR image.png \|]
.RB [\|\-c
.IR color \|]
.RB [\|\-t\|]
.RB [\|\-p
.IR pointer \|]
.RB [\|\-u\|]
.RB [\|\-e\|]
.RB [\|\-f\|]
.RB [\|\-4\|]
.RB [\|\-C
.IR config.conf \|]

.SH DESCRIPTION
.B i3lock
is a simple screen locker like slock. After starting it, you will see a white
screen (you can configure the color/an image). You can return to your screen by
entering your password.

.SH IMPROVEMENTS

.IP \[bu] 2
i3lock forks, so you can combine it with an alias to suspend to RAM (run "i3lock && echo mem > /sys/power/state" to get a locked screen after waking up your computer from suspend to RAM)
.IP \[bu]
You can specify either a background color or a PNG image which will be displayed while your screen is locked.
.IP \[bu]
You can specify whether i3lock should bell upon a wrong password.
.IP \[bu]
i3lock uses PAM and therefore is compatible with LDAP, etc.
.IP \[bu]
This version of i3lock supports reading options from a config file. It will try to parse
the files "/etc/i3lock.conf", "~/.i3lock.conf" and "~/.config/i3lock.conf". Additional
config file paths can be provided on the command line.


.SH OPTIONS
.TP
.B \-v, \-\-version
Display the version of your
.B i3lock

.TP
.B \-n, \-\-nofork
Don't fork after starting.

.TP
.B \-b, \-\-beep
Enable beeping. Be sure to not do this when you are about to annoy other people,
like when opening your laptop in a boring lecture.

.TP
.B \-u, \-\-no-unlock-indicator
Disable the unlock indicator. i3lock will by default show an unlock indicator
after pressing keys. This will give feedback for every keypress and it will
show you the current PAM state (whether your password is currently being
verified or whether it is wrong).

.TP
.BI \-i\  path \fR,\ \fB\-\-image= path
Display the given PNG image instead of a blank screen.

.TP
.BI \-c\  rrggbb \fR,\ \fB\-\-color= rrggbb
Turn the screen into the given color instead of white. Color must be given in 3-byte
format: rrggbb (i.e. ff0000 is red).

.TP
.B \-t, \-\-tiling
If an image is specified (via \-i) it will display the image tiled all over the screen
(if it is a multi-monitor setup, the image is visible on all screens).

.TP
.BI \-p\  win|default \fR,\ \fB\-\-pointer= win|default
If you specify "default",
.B i3lock
does not hide your mouse pointer. If you specify "win",
.B i3lock
displays a hardcoded Windows-Pointer (thus enabling you to mess with your
friends by using a screenshot of a Windows desktop as a locking-screen).

.TP
.B \-e, \-\-ignore-empty-password
When an empty password is provided by the user, do not validate
it. Without this option, the empty password will be provided to PAM
and, if invalid, the user will have to wait a few seconds before
another try. This can be useful if the XF86ScreenSaver key is used to
put a laptop to sleep and bounce on resume or if you happen to wake up
your computer with the enter key.

.TP
.B \-f, \-\-show-failed-attempts
Show the number of failed attempts, if any.

.TP
.B \-f, \-\-show-failed-attempts
Show the number of failed attempts, if any.

.TP
.B \-\-time-format= format
Use the given format string to format the displayed time. See
.B strftime(3)
for details on the format string.

.TP
.B \-\-date-format= format
Use the given format string to format the displayed date. See
.B strftime(3)
for details on the format string.

.TP
.B \-a, \-\-circle-alpha= alpha
Set the opacity of the unlock indicator background.  Takes a number between
0 (completely transparent) and 100 (completely opaque).

.TP
.BI \-C\  i3lock.conf \fR,\ \fB\-\-config= i3lock.conf
Loads configuration from the given file.

.SH DPMS

The \-d (\-\-dpms) option was removed from i3lock in version 2.8. There were
plenty of use-cases that were not properly addressed, and plenty of bugs
surrounding that feature. While features are not normally removed from i3 and
its tools, we felt the need to make an exception in this case.

Users who wish to explicitly enable DPMS only when their screen is locked can
use a wrapper script around i3lock like the following:

.Vb 6
\&	#!/bin/sh
\&	revert() {
\&	  xset dpms 0 0 0
\&	}
\&	trap revert HUP INT TERM
\&	xset +dpms dpms 5 5 5
\&	i3lock -n
\&	revert
.Ve

The \-I (-\-inactivity-timeout=seconds) was removed because it only makes sense with DPMS.

.SH SIGNALS

Send SIGUSR1 to the main process to redraw the screen, e.g. to update the displayed time directly after resume:

.Vb 6
\&      pkill -USR1 i3lock
.Ve

.SH FILES
.TP
.B /etc/i3lock.conf
System-wide configuration file.
.TP
.BR ~/.i3lock.conf " or " ~/.config/i3lock.conf
Per-user configuration file.

.PP
\fBSample configuration\fR. 
.sp
.if n \{\
.RS 4
.\}
.nf
#
# i3lock configuration file
#

# Background color as RGB hex string.
\fBcolor\fR = \fI#101010\fR
# Path to the background image, PNG only.
\fBimage\fR = \fI~/.local/wallpaper.png\fR
# Whether the image should be tiling.
\fBtiling\fR = \fIfalse\fR
# Color of the unlock indicator when verifying the password.
\fBverify-color\fR = \fI#00dd00\fR
# Color of the unlock indicator when a wrong password was entered.
\fBwrong-color\fR = \fI#dd0000\fR
# Color of the unlock indicator when idle.
\fBidle-color\fR = \fI#dddddd\fR
# Opacity of the unlock indicator, in percent.
\fBcircle-alpha\fR = \fI20\fR
# Supported values: default, win, none.
\fBpointer\fR = \fInone\fR

# Time format according to strftime(3).
# Time is displayed in the center of the unlock indicator.
\fBtime-format\fR = \fI%H:%M\fR
# Date format according to strftime(3).
# Date is displayed in smaller script beneath the time.
\fBdate-format\fR = \fI%d.%m.%Y\fR

# Whether to ever show the unlock indicator.
\fBunlock-indicator\fR = \fItrue\fR
# Whether to ingore the return key when nothing was typed.
\fBignore-empty-password\fR = \fItrue\fR
# Whether to show the number of failed attempts.
\fBshow-failed-attempts\fR = \fIfalse\fR

# Whether not to fork, useful for debugging.
\fBnofork\fR = \fIfalse\fR
# Whether to beep. Warning, may annoy others!
\fBfork\fR = \fIfalse\fR

#
# This version of i3lock supports custom keybindings on the lockscreen.
# Configure them here using the following syntax:
#
#    command = <modifier>+<key> = <command to run>
#

# Some example commands
\fBcommand\fR = \fIXF86AudioPlay\fR = playerctl play-pause
\fBcommand\fR = \fIXF86AudioPlay\fR = playerctl next
\fBcommand\fR = \fIXF86AudioPlay\fR = playerctl prev
\fBcommand\fR = \fIsuper+up\fR = brightnessctl +5%
\fBcommand\fR = \fIsuper+down\fR = brightnessctl -5%
.fi
.if n \{\
.RE
.\}
.sp

.SH SEE ALSO
.IR xautolock(1)
\- use i3lock as your screen saver

.SH AUTHOR
Michael Stapelberg <michael+i3lock at stapelberg dot de>

Jan-Erik Rediger <badboy at archlinux.us>

.SH CONTRIBUTORS

s3lph <5564491+s3lph at users.noreply.github.com>