i3lock(1)

1
2i3lock(1)                        User Manuals                        i3lock(1)
3
4
5

NAME

7       i3lock - improved screen locker
8
9

SYNOPSIS

11       i3lock  [-v] [-n] [-b] [-i image.png] [-c color] [-t] [-p pointer] [-u]
12       [-e] [-f]
13
14

RECOMMENDED USAGE

16       xss-lock --transfer-sleep-lock -- i3lock --nofork
17
18       Using xss-lock ensures that your screen is locked  before  your  laptop
19       suspends.
20
21       Notably,  using  a systemd service file is not adequate, as it will not
22       delay suspend until your screen is locked.
23
24

DESCRIPTION

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

IMPROVEMENTS

32       • i3lock forks, so you can combine it with an alias to suspend  to  RAM
33         (run  "i3lock  && echo mem > /sys/power/state" to get a locked screen
34         after waking up your computer from suspend to RAM)
35
36       • You can specify either a background color or a PNG image  which  will
37         be displayed while your screen is locked.
38
39       • You can specify whether i3lock should bell upon a wrong password.
40
41       • i3lock uses PAM and therefore is compatible with LDAP, etc.
42
43
44

OPTIONS

46       -v, --version
47              Display the version of your i3lock
48
49
50       -n, --nofork
51              Don't fork after starting.
52
53
54       -b, --beep
55              Enable beeping. Be sure to not do this when you are about to an‐
56              noy other people, like when opening your laptop in a boring lec‐
57              ture.
58
59
60       -u, --no-unlock-indicator
61              Disable the unlock indicator. i3lock will by default show an un‐
62              lock indicator after pressing keys. This will give feedback  for
63              every  keypress  and  it  will  show  you  the current PAM state
64              (whether your password is currently being verified or whether it
65              is wrong).
66
67
68       -i path, --image=path
69              Display the given PNG image instead of a blank screen.
70
71
72       --raw=format
73              Read  the  image given by --image as a raw image instead of PNG.
74              The argument is the image's format as <width>x<height>:<pixfmt>.
75              The  supported  pixel  formats  are:  ´native',  'rgb',  'xrgb',
76              'rgbx', 'bgr', 'xbgr', and 'bgrx'.  The  "native"  pixel  format
77              expects  a  pixel  as a 32-bit (4-byte) integer in the machine's
78              native endianness, with the upper 8 bits unused. Red, green  and
79              blue are stored in the remaining bits, in that order.
80
81              Example:
82                   --raw=1920x1080:rgb
83
84               You can use ImageMagick’s convert(1) program to feed raw images
85              into i3lock:
86
87
88                   convert wallpaper.jpg RGB:- | i3lock --raw 3840x2160:rgb --image /dev/stdin
89
90              This allows you to load  a  variety  of  image  formats  without
91              i3lock having to support each one explicitly.
92
93
94       -c rrggbb, --color=rrggbb
95              Turn  the  screen  into  the given color instead of white. Color
96              must be given in 3-byte format: rrggbb (i.e. ff0000 is red).
97
98
99       -t, --tiling
100              If an image is specified (via -i)  it  will  display  the  image
101              tiled  all  over the screen (if it is a multi-monitor setup, the
102              image is visible on all screens).
103
104
105       -p win|default, --pointer=win|default
106              If you specify  "default",  i3lock  does  not  hide  your  mouse
107              pointer.  If you specify "win", i3lock displays a hardcoded Win‐
108              dows-Pointer (thus enabling you to mess with your friends by us‐
109              ing a screenshot of a Windows desktop as a locking-screen).
110
111
112       -e, --ignore-empty-password
113              When  an empty password is provided by the user, do not validate
114              it. Without this option, the empty password will be provided  to
115              PAM  and,  if  invalid, the user will have to wait a few seconds
116              before another try. This can be useful  if  the  XF86ScreenSaver
117              key  is used to put a laptop to sleep and bounce on resume or if
118              you happen to wake up your computer with the enter key.
119
120
121       -f, --show-failed-attempts
122              Show the number of failed attempts, if any.
123
124
125       --debug
126              Enables debug logging.  Note, that this will  log  the  password
127              used for authentication to stdout.
128
129

DPMS

131       The  -d  (--dpms)  option was removed from i3lock in version 2.8. There
132       were plenty of use-cases that were not properly addressed,  and  plenty
133       of  bugs  surrounding that feature. While features are not normally re‐
134       moved from i3 and its tools, we felt the need to make an  exception  in
135       this case.
136
137       Users  who  wish  to  explicitly  enable DPMS only when their screen is
138       locked can use a wrapper script around i3lock like the following:
139
140            #!/bin/sh
141            revert() {
142              xset dpms 0 0 0
143            }
144            trap revert HUP INT TERM
145            xset +dpms dpms 5 5 5
146            i3lock -n
147            revert
148
149       The -I (--inactivity-timeout=seconds) was removed because it only makes
150       sense with DPMS.
151
152

AUTHOR

160       Michael Stapelberg <michael+i3lock at stapelberg dot de>
161
162       Jan-Erik Rediger <badboy at archlinux.us>
163
164
165
166Linux                            JANUARY 2012                        i3lock(1)