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 "JUNE 2009" Linux "User Manuals"
  12
  13 .SH NAME
  14 i3lock \- slightly improved version of slock
  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.xpm \|]
  24 .RB [\|\-c
  25 .IR color \|]
  26
  27 .SH DESCRIPTION
  28 .B i3lock
  29 locks your screen by making it white (default). To quit
  30 .B i3lock
  31 just enter your password.
  32
  33 .SH DIFFERENCES TO SLOCK
  34
  35 .B i3lock
  36 improves slock by making it fork() and therefore combinable with
  37 commands to suspend your computer. Additionally, instead of turning off
  38 your screen via DPMS and/or displaying a black screen,
  39 .B i3lock
  40 displays a white screen so you can see if your computer failed to resume
  41 from suspend or if your screen is just locked. Also, when entering a wrong
  42 password,
  43 .B i3lock
  44 does not call XBell(). This is important because
  45 .B i3lock/slock
  46 think you've entered a password when resuming from suspend, at least sometimes.
  47
  48 Since version 1.0, i3lock supports PAM.
  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 \-i, \-\-image
  73 Display the given XPM image instead of a blank screen. You can convert an image to
  74 XPM by using convert(1) from ImageMagick or GIMP for example.
  75
  76 .TP
  77 .B \-c, \-\-color
  78 Turns the screen into the given color instead of white. Color must be given in 6-byte format: rrggbb (i.e. ff0000 is red)
  79
  80 .SH AUTHOR
  81 Michael Stapelberg <michael+i3lock at stapelberg dot de>
  82
  83 forked from slock-0.9 by Anselm R Garbe <garbeam at gmail dot com>