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.

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