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