]> git.sur5r.net Git - i3/i3lock/blob - i3lock.1
Document the new option in the manpage
[i3/i3lock] / i3lock.1
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 "JUNE 2009" Linux "User Manuals"
12
13 .SH NAME
14 i3lock \- slightly improved version of slock
15
16 .SH SYNOPSIS
17 .B i3lock
18 .RB [\|\-v\|]
19 .RB [\|\-n\|]
20 .RB [\|\-b\|]
21 .RB [\|\-d\|]
22 .RB [\|\-i
23 .IR image.xpm \|]
24
25 .SH DESCRIPTION
26 .B i3lock
27 locks your screen by making it white. To quit
28 .B i3lock
29 just enter your password.
30
31 .SH DIFFERENCES TO SLOCK
32
33 .B i3lock
34 improves slock by making it fork() and therefore combinable with
35 commands to suspend your computer. Additionally, instead of turning off
36 your screen via DPMS and/or displaying a black screen,
37 .B i3lock
38 displays a white screen so you can see if your computer failed to resume
39 from suspend or if your screen is just locked. Also, when entering a wrong
40 password,
41 .B i3lock
42 does not call XBell(). This is important because
43 .B i3lock/slock
44 think you've entered a password when resuming from suspend, at least sometimes.
45
46 Since version 1.0, i3lock supports PAM.
47
48 .SH OPTIONS
49 .TP
50 .B \-v, \-\-version
51 Display the version of your
52 .B i3lock
53
54 .TP
55 .B \-n, \-\-nofork
56 Don't fork after starting.
57
58 .TP
59 .B \-b, \-\-beep
60 Enable beeping. Be sure to not do this when you are about to annoy other people,
61 like when opening your laptop in a boring lecture.
62
63 .TP
64 .B \-d, \-\-dpms
65 Enable turning off your screen using DPMS. Note that, when you do not specify this
66 option, DPMS will turn off your screen after 15 minutes of inactivity anyways (if
67 you did not disable this in your X server).
68
69 .TP
70 .B \-i, \-\-image
71 Display the given XPM image instead of a blank screen. You can convert an image to
72 XPM by using convert(1) from ImageMagick or GIMP for example.
73
74 .SH AUTHOR
75 Michael Stapelberg <michael+i3lock at stapelberg dot de>
76
77 forked from slock-0.9 by Anselm R Garbe <garbeam at gmail dot com>