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