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 [\|\-d\|]
  22 .RB [\|\-i
  23 .IR image.png \|]
  24 .RB [\|\-c
  25 .IR color \|]
  26 .RB [\|\-t\|]
  27 .RB [\|\-p
  28 .IR pointer\|]
  29 .RB [\|\-u\|]
  30 .RB [\|\-e\|]
  31 .RB [\|\-I\|]
  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 .B \-d, \-\-dpms
  69 Enable turning off your screen using DPMS. Note that, when you do not specify this
  70 option, DPMS will turn off your screen after 15 minutes of inactivity anyways (if
  71 you did not disable this in your X server).
  72
  73 .TP
  74 .B \-I, \-\-inactivity-timeout
  75 Specifies the number of seconds i3lock will wait for another password before
  76 turning off the monitors, in case you entered a wrong password or canceled by
  77 pressing Escape. Only makes sense together with \-d. If omitted, the default is
  78 30 seconds.
  79
  80 .TP
  81 .B \-u, \-\-no-unlock-indicator
  82 Disable the unlock indicator. i3lock will by default show an unlock indicator
  83 after pressing keys. This will give feedback for every keypress and it will
  84 show you the current PAM state (whether your password is currently being
  85 verified or whether it is wrong).
  86
  87 .TP
  88 .BI \-i\  path \fR,\ \fB\-\-image= path
  89 Display the given PNG image instead of a blank screen.
  90
  91 .TP
  92 .BI \-c\  rrggbb \fR,\ \fB\-\-color= rrggbb
  93 Turn the screen into the given color instead of white. Color must be given in 3-byte
  94 format: rrggbb (i.e. ff0000 is red).
  95
  96 .TP
  97 .B \-t, \-\-tiling
  98 If an image is specified (via \-i) it will display the image tiled all over the screen
  99 (if it is a multi-monitor setup, the image is visible on all screens).
 100
 101 .TP
 102 .BI \-p\  win|default \fR,\ \fB\-\-pointer= win|default
 103 If you specify "default",
 104 .B i3lock
 105 does not hide your mouse pointer. If you specify "win",
 106 .B i3lock
 107 displays a hardcoded Windows-Pointer (thus enabling you to mess with your
 108 friends by using a screenshot of a Windows desktop as a locking-screen).
 109
 110 .TP
 111 .B \-e, \-\-ignore-empty-password
 112 When an empty password is provided by the user, do not validate
 113 it. Without this option, the empty password will be provided to PAM
 114 and, if invalid, the user will have to wait a few seconds before
 115 another try. This can be useful if the XF86ScreenSaver key is used to
 116 put a laptop to sleep and bounce on resume or if you happen to wake up
 117 your computer with the enter key.
 118
 119 .TP
 120 .B \-f, \-\-show-failed-attempts
 121 Show the number of failed attempts, if any.
 122
 123 .TP
 124 .B \-\-debug
 125 Enables debug logging.
 126 Note, that this will log the password used for authentication to stdout.
 127
 128 .SH SEE ALSO
 129 .IR xautolock(1)
 130 \- use i3lock as your screen saver
 131
 132 .SH AUTHOR
 133 Michael Stapelberg <michael+i3lock at stapelberg dot de>
 134
 135 Jan-Erik Rediger <badboy at archlinux.us>