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