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
  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 (or colored in your favorite color) screen so you can see
  42 if your computer failed to resume from suspend or if your screen is just
  43 locked. Since version 1.1,
  44 .B i3lock
  45 can display images in XPM file format. Also, when entering a wrong password,
  46 .B i3lock
  47 does not call XBell(). This is important because
  48 .B i3lock/slock
  49 think you've entered a password when resuming from suspend, at least sometimes.
  50
  51 Since version 1.0, i3lock supports PAM.
  52
  53 .SH OPTIONS
  54 .TP
  55 .B \-v, \-\-version
  56 Display the version of your
  57 .B i3lock
  58
  59 .TP
  60 .B \-n, \-\-nofork
  61 Don't fork after starting.
  62
  63 .TP
  64 .B \-b, \-\-beep
  65 Enable beeping. Be sure to not do this when you are about to annoy other people,
  66 like when opening your laptop in a boring lecture.
  67
  68 .TP
  69 .B \-d, \-\-dpms
  70 Enable turning off your screen using DPMS. Note that, when you do not specify this
  71 option, DPMS will turn off your screen after 15 minutes of inactivity anyways (if
  72 you did not disable this in your X server).
  73
  74 .TP
  75 .B \-i, \-\-image
  76 Display the given XPM image instead of a blank screen. You can convert an image to
  77 XPM by using convert(1) from ImageMagick or GIMP for example.
  78
  79 .TP
  80 .B \-c, \-\-color
  81 Turns the screen into the given color instead of white. Color must be given in 6-byte
  82 format: rrggbb (i.e. ff0000 is red)
  83
  84 .TP
  85 .B \-t, \-\-tile
  86 If an image is specified (via -i) it will display the image tiled all over the screen
  87 (if it is a multi-monitor setup, the image is visible on all screens).
  88
  89 .SH AUTHOR
  90 Michael Stapelberg <michael+i3lock at stapelberg dot de>
  91
  92 Jan-Erik Rediger <badboy at archlinux.us>
  93
  94 forked from slock-0.9 by Anselm R Garbe <garbeam at gmail dot com>