git.sur5r.net Git - i3/i3lock/blob - 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 "JANUARY 2012" Linux "User Manuals"
  12
  13 .SH NAME
  14 i3lock \- 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 [\|\-I
  31 .IR timeout\|]
  32 .RB [\|\-f\|]
  33
  34 .SH DESCRIPTION
  35 .B i3lock
  36 is a simple screen locker like slock. After starting it, you will see a white
  37 screen (you can configure the color/an image). You can return to your screen by
  38 entering your password.
  39
  40 .SH IMPROVEMENTS
  41
  42 .IP \[bu] 2
  43 i3lock 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)
  44 .IP \[bu]
  45 You can specify either a background color or a PNG image which will be displayed while your screen is locked.
  46 .IP \[bu]
  47 You can specify whether i3lock should bell upon a wrong password.
  48 .IP \[bu]
  49 i3lock uses PAM and therefore is compatible with LDAP, etc.
  50
  51
  52 .SH OPTIONS
  53 .TP
  54 .B \-v, \-\-version
  55 Display the version of your
  56 .B i3lock
  57
  58 .TP
  59 .B \-n, \-\-nofork
  60 Don't fork after starting.
  61
  62 .TP
  63 .B \-b, \-\-beep
  64 Enable beeping. Be sure to not do this when you are about to annoy other people,
  65 like when opening your laptop in a boring lecture.
  66
  67 .TP
  68 .BI \-I\  seconds \fR,\ \fB\-\-inactivity-timeout= seconds
  69 Specifies the number of seconds i3lock will wait for another password before
  70 turning off the monitors, in case you entered a wrong password or canceled by
  71 pressing Escape. Only makes sense together with \-d. If omitted, the default is
  72 30 seconds.
  73
  74 .TP
  75 .B \-u, \-\-no-unlock-indicator
  76 Disable the unlock indicator. i3lock will by default show an unlock indicator
  77 after pressing keys. This will give feedback for every keypress and it will
  78 show you the current PAM state (whether your password is currently being
  79 verified or whether it is wrong).
  80
  81 .TP
  82 .BI \-i\  path \fR,\ \fB\-\-image= path
  83 Display the given PNG image instead of a blank screen.
  84
  85 .TP
  86 .BI \-c\  rrggbb \fR,\ \fB\-\-color= rrggbb
  87 Turn the screen into the given color instead of white. Color must be given in 3-byte
  88 format: rrggbb (i.e. ff0000 is red).
  89
  90 .TP
  91 .B \-t, \-\-tiling
  92 If an image is specified (via \-i) it will display the image tiled all over the screen
  93 (if it is a multi-monitor setup, the image is visible on all screens).
  94
  95 .TP
  96 .BI \-p\  win|default \fR,\ \fB\-\-pointer= win|default
  97 If you specify "default",
  98 .B i3lock
  99 does not hide your mouse pointer. If you specify "win",
 100 .B i3lock
 101 displays a hardcoded Windows-Pointer (thus enabling you to mess with your
 102 friends by using a screenshot of a Windows desktop as a locking-screen).
 103
 104 .TP
 105 .B \-e, \-\-ignore-empty-password
 106 When an empty password is provided by the user, do not validate
 107 it. Without this option, the empty password will be provided to PAM
 108 and, if invalid, the user will have to wait a few seconds before
 109 another try. This can be useful if the XF86ScreenSaver key is used to
 110 put a laptop to sleep and bounce on resume or if you happen to wake up
 111 your computer with the enter key.
 112
 113 .TP
 114 .B \-f, \-\-show-failed-attempts
 115 Show the number of failed attempts, if any.
 116
 117 .TP
 118 .B \-\-debug
 119 Enables debug logging.
 120 Note, that this will log the password used for authentication to stdout.
 121
 122 .SH DPMS
 123
 124 The \-d (\-\-dpms) option was removed from i3lock in version 2.8. There were
 125 plenty of use-cases that were not properly addressed, and plenty of bugs
 126 surrounding that feature. While features are not normally removed from i3 and
 127 its tools, we felt the need to make an exception in this case.
 128
 129 Users who wish to explicitly enable DPMS only when their screen is locked can
 130 use a wrapper script around i3lock like the following:
 131
 132 .Vb 6
 133 \&      #!/bin/sh
 134 \&      revert() {
 135 \&        xset dpms 0 0 0
 136 \&      }
 137 \&      trap revert SIGHUP SIGINT SIGTERM
 138 \&      xset +dpms dpms 5 5 5
 139 \&      i3lock -n
 140 \&      revert
 141 .Ve
 142
 143 .SH SEE ALSO
 144 .IR xautolock(1)
 145 \- use i3lock as your screen saver
 146
 147 .SH AUTHOR
 148 Michael Stapelberg <michael+i3lock at stapelberg dot de>
 149
 150 Jan-Erik Rediger <badboy at archlinux.us>