summaryrefslogtreecommitdiff
path: root/i3lock.1
diff options
context:
space:
mode:
authorSimeon Simeonov2020-03-19 16:51:23 +0100
committerSimeon Simeonov2020-03-19 16:51:23 +0100
commiteba48b7cec388325b237fd1b5a3c6d2e04deba12 (patch)
tree3e6a57a3ffec9310c2a769adcfc6e5f8e272572f /i3lock.1
parent69a05d516bd0c7e369a0ba1fb78aac57a5ea26f2 (diff)
Initial merge i3lock-extended -> i3lock
Diffstat (limited to 'i3lock.1')
-rw-r--r--i3lock.1173
1 files changed, 0 insertions, 173 deletions
diff --git a/i3lock.1 b/i3lock.1
deleted file mode 100644
index cefd0d8..0000000
--- a/i3lock.1
+++ /dev/null
@@ -1,173 +0,0 @@
1.de Vb \" Begin verbatim text
2.ft CW
3.nf
4.ne \\$1
5..
6.de Ve \" End verbatim text
7.ft R
8.fi
9..
10
11.TH i3lock 1 "JANUARY 2012" Linux "User Manuals"
12
13.SH NAME
14i3lock \- improved screen locker
15
16.SH SYNOPSIS
17.B i3lock
18.RB [\|\-v\|]
19.RB [\|\-n\|]
20.RB [\|\-b\|]
21.RB [\|\-i
22.IR image.png \|]
23.RB [\|\-c
24.IR color \|]
25.RB [\|\-t\|]
26.RB [\|\-p
27.IR pointer\|]
28.RB [\|\-u\|]
29.RB [\|\-e\|]
30.RB [\|\-f\|]
31
32.SH DESCRIPTION
33.B i3lock
34is a simple screen locker like slock. After starting it, you will see a white
35screen (you can configure the color/an image). You can return to your screen by
36entering your password.
37
38.SH IMPROVEMENTS
39
40.IP \[bu] 2
41i3lock 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)
42.IP \[bu]
43You can specify either a background color or a PNG image which will be displayed while your screen is locked.
44.IP \[bu]
45You can specify whether i3lock should bell upon a wrong password.
46.IP \[bu]
47i3lock uses PAM and therefore is compatible with LDAP, etc.
48
49
50.SH OPTIONS
51.TP
52.B \-v, \-\-version
53Display the version of your
54.B i3lock
55
56.TP
57.B \-n, \-\-nofork
58Don't fork after starting.
59
60.TP
61.B \-b, \-\-beep
62Enable beeping. Be sure to not do this when you are about to annoy other people,
63like when opening your laptop in a boring lecture.
64
65.TP
66.B \-u, \-\-no-unlock-indicator
67Disable the unlock indicator. i3lock will by default show an unlock indicator
68after pressing keys. This will give feedback for every keypress and it will
69show you the current PAM state (whether your password is currently being
70verified or whether it is wrong).
71
72.TP
73.BI \-i\ path \fR,\ \fB\-\-image= path
74Display the given PNG image instead of a blank screen.
75
76.TP
77.BI \fB\-\-raw= format
78Read the image given by \-\-image as a raw image instead of PNG. The argument is the image's format
79as <width>x<height>:<pixfmt>. The supported pixel formats are:
80\'native', 'rgb', 'xrgb', 'rgbx', 'bgr', 'xbgr', and 'bgrx'.
81The "native" pixel format expects a pixel as a 32-bit (4-byte) integer in
82the machine's native endianness, with the upper 8 bits unused. Red, green and blue are stored in
83the remaining bits, in that order.
84
85.BR Example:
86.Vb 6
87\& --raw=1920x1080:rgb
88.Ve
89
90.BR
91You can use ImageMagick’s
92.IR convert(1)
93program to feed raw images into i3lock:
94
95.BR
96.Vb 6
97\& convert wallpaper.jpg RGB:- | i3lock --raw 3840x2160:rgb --image /dev/stdin
98.Ve
99
100This allows you to load a variety of image formats without i3lock having to
101support each one explicitly.
102
103.TP
104.BI \-c\ rrggbb \fR,\ \fB\-\-color= rrggbb
105Turn the screen into the given color instead of white. Color must be given in 3-byte
106format: rrggbb (i.e. ff0000 is red).
107
108.TP
109.B \-t, \-\-tiling
110If an image is specified (via \-i) it will display the image tiled all over the screen
111(if it is a multi-monitor setup, the image is visible on all screens).
112
113.TP
114.BI \-p\ win|default \fR,\ \fB\-\-pointer= win|default
115If you specify "default",
116.B i3lock
117does not hide your mouse pointer. If you specify "win",
118.B i3lock
119displays a hardcoded Windows-Pointer (thus enabling you to mess with your
120friends by using a screenshot of a Windows desktop as a locking-screen).
121
122.TP
123.B \-e, \-\-ignore-empty-password
124When an empty password is provided by the user, do not validate
125it. Without this option, the empty password will be provided to PAM
126and, if invalid, the user will have to wait a few seconds before
127another try. This can be useful if the XF86ScreenSaver key is used to
128put a laptop to sleep and bounce on resume or if you happen to wake up
129your computer with the enter key.
130
131.TP
132.B \-f, \-\-show-failed-attempts
133Show the number of failed attempts, if any.
134
135.TP
136.B \-\-debug
137Enables debug logging.
138Note, that this will log the password used for authentication to stdout.
139
140.SH DPMS
141
142The \-d (\-\-dpms) option was removed from i3lock in version 2.8. There were
143plenty of use-cases that were not properly addressed, and plenty of bugs
144surrounding that feature. While features are not normally removed from i3 and
145its tools, we felt the need to make an exception in this case.
146
147Users who wish to explicitly enable DPMS only when their screen is locked can
148use a wrapper script around i3lock like the following:
149
150.Vb 6
151\& #!/bin/sh
152\& revert() {
153\& xset dpms 0 0 0
154\& }
155\& trap revert HUP INT TERM
156\& xset +dpms dpms 5 5 5
157\& i3lock -n
158\& revert
159.Ve
160
161The \-I (-\-inactivity-timeout=seconds) was removed because it only makes sense with DPMS.
162
163.SH SEE ALSO
164.IR xautolock(1)
165\- use i3lock as your screen saver
166
167.IR convert(1)
168\- feed a wide variety of image formats to i3lock
169
170.SH AUTHOR
171Michael Stapelberg <michael+i3lock at stapelberg dot de>
172
173Jan-Erik Rediger <badboy at archlinux.us>