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

DESCRIPTION

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

IMPROVEMENTS

22       · i3lock forks, so you can combine it with an alias to suspend  to  RAM
23         (run  "i3lock  && echo mem > /sys/power/state" to get a locked screen
24         after waking up your computer from suspend to RAM)
25
26       · You can specify either a background color or a PNG image  which  will
27         be displayed while your screen is locked.
28
29       · You can specify whether i3lock should bell upon a wrong password.
30
31       · i3lock uses PAM and therefore is compatible with LDAP, etc.
32
33
34

OPTIONS

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

DPMS

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

AUTHOR

150       Michael Stapelberg <michael+i3lock at stapelberg dot de>
151
152       Jan-Erik Rediger <badboy at archlinux.us>
153
154
155
156Linux                            JANUARY 2012                        i3lock(1)