You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

94 lines
2.3 KiB

  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. .TH i3lock 1 "AUGUST 2009" Linux "User Manuals"
  11. .SH NAME
  12. i3lock \- slightly improved version of slock
  13. .SH SYNOPSIS
  14. .B i3lock
  15. .RB [\|\-v\|]
  16. .RB [\|\-n\|]
  17. .RB [\|\-b\|]
  18. .RB [\|\-d\|]
  19. .RB [\|\-i
  20. .IR image.xpm \|]
  21. .RB [\|\-c
  22. .IR color \|]
  23. .RB [\|\-t\|]
  24. .SH DESCRIPTION
  25. .B i3lock
  26. locks your screen by making it white (default). To quit
  27. .B i3lock
  28. just enter your password.
  29. .SH DIFFERENCES TO SLOCK
  30. .B i3lock
  31. improves slock by making it fork() and therefore combinable with
  32. commands to suspend your computer. Additionally, instead of turning off
  33. your screen via DPMS and/or displaying a black screen,
  34. .B i3lock
  35. displays a white (or colored in your favorite color) screen so you can see
  36. if your computer failed to resume from suspend or if your screen is just
  37. locked. Since version 1.1,
  38. .B i3lock
  39. can display images in XPM file format. Also, when entering a wrong password,
  40. .B i3lock
  41. does not call XBell(). This is important because
  42. .B i3lock/slock
  43. think you've entered a password when resuming from suspend, at least sometimes.
  44. Since version 1.0, i3lock supports PAM.
  45. .SH OPTIONS
  46. .TP
  47. .B \-v, \-\-version
  48. Display the version of your
  49. .B i3lock
  50. .TP
  51. .B \-n, \-\-nofork
  52. Don't fork after starting.
  53. .TP
  54. .B \-b, \-\-beep
  55. Enable beeping. Be sure to not do this when you are about to annoy other people,
  56. like when opening your laptop in a boring lecture.
  57. .TP
  58. .B \-d, \-\-dpms
  59. Enable turning off your screen using DPMS. Note that, when you do not specify this
  60. option, DPMS will turn off your screen after 15 minutes of inactivity anyways (if
  61. you did not disable this in your X server).
  62. .TP
  63. .B \-i, \-\-image
  64. Display the given XPM image instead of a blank screen. You can convert an image to
  65. XPM by using convert(1) from ImageMagick or GIMP for example.
  66. .TP
  67. .B \-c, \-\-color
  68. Turns the screen into the given color instead of white. Color must be given in 6-byte
  69. format: rrggbb (i.e. ff0000 is red)
  70. .TP
  71. .B \-t, \-\-tile
  72. If an image is specified (via -i) it will display the image tiled all over the screen
  73. (if it is a multi-monitor setup, the image is visible on all screens).
  74. .SH AUTHOR
  75. Michael Stapelberg <michael+i3lock at stapelberg dot de>
  76. Jan-Erik Rediger <badboy at archlinux.us>
  77. forked from slock-0.9 by Anselm R Garbe <garbeam at gmail dot com>