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