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.

99 lines
2.4 KiB

15 years ago
15 years ago
15 years ago
15 years ago
15 years ago
15 years ago
  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 "JULY 2010" Linux "User Manuals"
  11. .SH NAME
  12. i3lock \- improved screen locker
  13. .SH SYNOPSIS
  14. .B i3lock
  15. .RB [\|\-v\|]
  16. .RB [\|\-n\|]
  17. .RB [\|\-b\|]
  18. .RB [\|\-d\|]
  19. .RB [\|\-i
  20. .IR image.png \|]
  21. .RB [\|\-c
  22. .IR color \|]
  23. .RB [\|\-t\|]
  24. .RB [\|\-p
  25. .IR pointer\|]
  26. .SH DESCRIPTION
  27. .B i3lock
  28. is a simple screen locker like slock. After starting it, you will see a white
  29. screen (you can configure the color/an image). You can return to your screen by
  30. entering your passwords.
  31. .SH IMPROVEMENTS
  32. .TP
  33. * i3lock forks, so you can combine it with an alias to suspend to RAM (run "i3lock && echo mem > /sys/power/state" to get a locked screen after waking up your computer from suspend to RAM)
  34. .TP
  35. * You can either a background color or a PNG image which will be displayed while your screen is locked.
  36. .TP
  37. * You can specify whether i3lock should bell upon a wrong password.
  38. .TP
  39. * i3lock uses PAM and therefore is compatible with LDAP etc.
  40. .SH OPTIONS
  41. .TP
  42. .B \-v, \-\-version
  43. Display the version of your
  44. .B i3lock
  45. .TP
  46. .B \-n, \-\-nofork
  47. Don't fork after starting.
  48. .TP
  49. .B \-b, \-\-beep
  50. Enable beeping. Be sure to not do this when you are about to annoy other people,
  51. like when opening your laptop in a boring lecture.
  52. .TP
  53. .B \-d, \-\-dpms
  54. Enable turning off your screen using DPMS. Note that, when you do not specify this
  55. option, DPMS will turn off your screen after 15 minutes of inactivity anyways (if
  56. you did not disable this in your X server).
  57. .TP
  58. .B \-i, \-\-image
  59. Display the given XPM image instead of a blank screen. You can convert an image to
  60. XPM by using convert(1) from ImageMagick or GIMP for example.
  61. .TP
  62. .B \-c, \-\-color
  63. Turns the screen into the given color instead of white. Color must be given in 6-byte
  64. format: rrggbb (i.e. ff0000 is red)
  65. .TP
  66. .B \-t, \-\-tile
  67. If an image is specified (via -i) it will display the image tiled all over the screen
  68. (if it is a multi-monitor setup, the image is visible on all screens).
  69. .TP
  70. .B \-p, \-\-pointer
  71. If you specify "default",
  72. .B i3lock
  73. does not hide your Mousepointer. If you specify "win",
  74. .B i3lock
  75. displays a hardcoded Windows-Pointer (thus enabling you to fuck with your
  76. friends by using a Screenshot of a Windows-Desktop as a locking-screen).
  77. .SH AUTHOR
  78. Michael Stapelberg <michael+i3lock at stapelberg dot de>
  79. Jan-Erik Rediger <badboy at archlinux.us>