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
  31 .SH DESCRIPTION
  32 .B i3lock
  33 is a simple screen locker like slock. After starting it, you will see a white
  34 screen (you can configure the color/an image). You can return to your screen by
  35 entering your password.
  36
  37 .SH IMPROVEMENTS
  38
  39 .TP
  40 * 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)
  41
  42 .TP
  43 * You can specify either a background color or a PNG image which will be displayed while your screen is locked.
  44
  45 .TP
  46 * You can specify whether i3lock should bell upon a wrong password.
  47
  48 .TP
  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 \-u, \-\-no-unlock-indicator
  75 Disables the unlock indicator. i3lock will by default show an unlock indicator
  76 after pressing keys. This will give feedback for every keypress and it will
  77 show you the current PAM state (whether your password is currently being
  78 verified or whether it is wrong).
  79
  80 .TP
  81 .BI \-i\  path \fR,\ \fB\-\-image= path
  82 Display the given PNG image instead of a blank screen.
  83
  84 .TP
  85 .BI \-c\  rrggbb \fR,\ \fB\-\-color= rrggbb
  86 Turns the screen into the given color instead of white. Color must be given in 6-byte
  87 format: rrggbb (i.e. ff0000 is red)
  88
  89 .TP
  90 .B \-t, \-\-tiling
  91 If an image is specified (via \-i) it will display the image tiled all over the screen
  92 (if it is a multi-monitor setup, the image is visible on all screens).
  93
  94 .TP
  95 .BI \-p\  win|default \fR,\ \fB\-\-pointer= win|default
  96 If you specify "default",
  97 .B i3lock
  98 does not hide your Mousepointer. If you specify "win",
  99 .B i3lock
 100 displays a hardcoded Windows-Pointer (thus enabling you to fuck with your
 101 friends by using a Screenshot of a Windows-Desktop as a locking-screen).
 102
 103 .SH SEE ALSO
 104 .IR xautolock(1)
 105 \- use i3lock as your screen saver
 106
 107 .SH AUTHOR
 108 Michael Stapelberg <michael+i3lock at stapelberg dot de>
 109
 110 Jan-Erik Rediger <badboy at archlinux.us>