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
  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 .TP
  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
  43 .TP
  44 * You can specify either a background color or a PNG image which will be displayed while your screen is locked.
  45
  46 .TP
  47 * You can specify whether i3lock should bell upon a wrong password.
  48
  49 .TP
  50 * i3lock uses PAM and therefore is compatible with LDAP etc.
  51
  52
  53 .SH OPTIONS
  54 .TP
  55 .B \-v, \-\-version
  56 Display the version of your
  57 .B i3lock
  58
  59 .TP
  60 .B \-n, \-\-nofork
  61 Don't fork after starting.
  62
  63 .TP
  64 .B \-b, \-\-beep
  65 Enable beeping. Be sure to not do this when you are about to annoy other people,
  66 like when opening your laptop in a boring lecture.
  67
  68 .TP
  69 .B \-d, \-\-dpms
  70 Enable turning off your screen using DPMS. Note that, when you do not specify this
  71 option, DPMS will turn off your screen after 15 minutes of inactivity anyways (if
  72 you did not disable this in your X server).
  73
  74 .TP
  75 .B \-u, \-\-no-unlock-indicator
  76 Disables 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 Turns the screen into the given color instead of white. Color must be given in 6-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 Mousepointer. If you specify "win",
 100 .B i3lock
 101 displays a hardcoded Windows-Pointer (thus enabling you to fuck 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 .SH SEE ALSO
 114 .IR xautolock(1)
 115 \- use i3lock as your screen saver
 116
 117 .SH AUTHOR
 118 Michael Stapelberg <michael+i3lock at stapelberg dot de>
 119
 120 Jan-Erik Rediger <badboy at archlinux.us>