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 "AUGUST 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 .RB [\|\-t\|]
  27 .RP [\|\-p
  28 .IR pointer\|]
  29
  30 .SH DESCRIPTION
  31 .B i3lock
  32 locks your screen by making it white (default). To quit
  33 .B i3lock
  34 just enter your password.
  35
  36 .SH DIFFERENCES TO SLOCK
  37
  38 .B i3lock
  39 improves slock by making it fork() and therefore combinable with
  40 commands to suspend your computer. Additionally, instead of turning off
  41 your screen via DPMS and/or displaying a black screen,
  42 .B i3lock
  43 displays a white (or colored in your favorite color) screen so you can see
  44 if your computer failed to resume from suspend or if your screen is just
  45 locked. Since version 1.1,
  46 .B i3lock
  47 can display images in XPM file format. Also, when entering a wrong password,
  48 .B i3lock
  49 does not call XBell(). This is important because
  50 .B i3lock/slock
  51 think you've entered a password when resuming from suspend, at least sometimes.
  52
  53 Since version 1.0, i3lock supports PAM.
  54
  55 .SH OPTIONS
  56 .TP
  57 .B \-v, \-\-version
  58 Display the version of your
  59 .B i3lock
  60
  61 .TP
  62 .B \-n, \-\-nofork
  63 Don't fork after starting.
  64
  65 .TP
  66 .B \-b, \-\-beep
  67 Enable beeping. Be sure to not do this when you are about to annoy other people,
  68 like when opening your laptop in a boring lecture.
  69
  70 .TP
  71 .B \-d, \-\-dpms
  72 Enable turning off your screen using DPMS. Note that, when you do not specify this
  73 option, DPMS will turn off your screen after 15 minutes of inactivity anyways (if
  74 you did not disable this in your X server).
  75
  76 .TP
  77 .B \-i, \-\-image
  78 Display the given XPM image instead of a blank screen. You can convert an image to
  79 XPM by using convert(1) from ImageMagick or GIMP for example.
  80
  81 .TP
  82 .B \-c, \-\-color
  83 Turns the screen into the given color instead of white. Color must be given in 6-byte
  84 format: rrggbb (i.e. ff0000 is red)
  85
  86 .TP
  87 .B \-t, \-\-tile
  88 If an image is specified (via -i) it will display the image tiled all over the screen
  89 (if it is a multi-monitor setup, the image is visible on all screens).
  90
  91 .TP
  92 .B \-p, \-\-pointer
  93 If you specify "default",
  94 .B i3lock
  95 does not hide your Mousepointer.\n  If you specify "win",
  96 .B i3lock
  97 displays a hardcoded Windows-Pointer (thus enabling you to fuck with your
  98 friends by using a Screenshot of a Windows-Desktop as a locking-screen).
  99
 100 .SH AUTHOR
 101 Michael Stapelberg <michael+i3lock at stapelberg dot de>
 102
 103 Jan-Erik Rediger <badboy at archlinux.us>
 104
 105 forked from slock-0.9 by Anselm R Garbe <garbeam at gmail dot com>