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 .RB [\|\-t\|]
  27
  28 .SH DESCRIPTION
  29 .B i3lock
  30 locks your screen by making it white (default). To quit
  31 .B i3lock
  32 just enter your password.
  33
  34 .SH DIFFERENCES TO SLOCK
  35
  36 .B i3lock
  37 improves slock by making it fork() and therefore combinable with
  38 commands to suspend your computer. Additionally, instead of turning off
  39 your screen via DPMS and/or displaying a black screen,
  40 .B i3lock
  41 displays a white screen so you can see if your computer failed to resume
  42 from suspend or if your screen is just locked. Also, when entering a wrong
  43 password,
  44 .B i3lock
  45 does not call XBell(). This is important because
  46 .B i3lock/slock
  47 think you've entered a password when resuming from suspend, at least sometimes.
  48
  49 Since version 1.0, i3lock supports PAM.
  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 \-i, \-\-image
  74 Display the given XPM image instead of a blank screen. You can convert an image to
  75 XPM by using convert(1) from ImageMagick or GIMP for example.
  76
  77 .TP
  78 .B \-c, \-\-color
  79 Turns the screen into the given color instead of white. Color must be given in 6-byte format: rrggbb (i.e. ff0000 is red)
  80
  81 .TP
  82 .B \-t, \-\-tiling
  83 If an image is specified (via -i) it will display the image tiled all over the screen (if it is a multi-monitor setup, the image is visible on all screens)
  84 >>>>>>> adding option to enable tiling of images:i3lock.1
  85
  86 .SH AUTHOR
  87 Michael Stapelberg <michael+i3lock at stapelberg dot de>
  88
  89 forked from slock-0.9 by Anselm R Garbe <garbeam at gmail dot com>