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