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