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.

110 lines
2.7 KiB

15 years ago
15 years ago
15 years ago
15 years ago
15 years ago
15 years ago
13 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 "JANUARY 2012" 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. .RB [\|\-u\|]
  27. .SH DESCRIPTION
  28. .B i3lock
  29. is a simple screen locker like slock. After starting it, you will see a white
  30. screen (you can configure the color/an image). You can return to your screen by
  31. entering your password.
  32. .SH IMPROVEMENTS
  33. .TP
  34. * 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)
  35. .TP
  36. * You can specify either a background color or a PNG image which will be displayed while your screen is locked.
  37. .TP
  38. * You can specify whether i3lock should bell upon a wrong password.
  39. .TP
  40. * i3lock uses PAM and therefore is compatible with LDAP etc.
  41. .SH OPTIONS
  42. .TP
  43. .B \-v, \-\-version
  44. Display the version of your
  45. .B i3lock
  46. .TP
  47. .B \-n, \-\-nofork
  48. Don't fork after starting.
  49. .TP
  50. .B \-b, \-\-beep
  51. Enable beeping. Be sure to not do this when you are about to annoy other people,
  52. like when opening your laptop in a boring lecture.
  53. .TP
  54. .B \-d, \-\-dpms
  55. Enable turning off your screen using DPMS. Note that, when you do not specify this
  56. option, DPMS will turn off your screen after 15 minutes of inactivity anyways (if
  57. you did not disable this in your X server).
  58. .TP
  59. .B \-u, \-\-no-unlock-indicator
  60. Disables the unlock indicator. i3lock will by default show an unlock indicator
  61. after pressing keys. This will give feedback for every keypress and it will
  62. show you the current PAM state (whether your password is currently being
  63. verified or whether it is wrong).
  64. .TP
  65. .BI \-i\ path \fR,\ \fB\-\-image= path
  66. Display the given PNG image instead of a blank screen.
  67. .TP
  68. .BI \-c\ rrggbb \fR,\ \fB\-\-color= rrggbb
  69. Turns the screen into the given color instead of white. Color must be given in 6-byte
  70. format: rrggbb (i.e. ff0000 is red)
  71. .TP
  72. .B \-t, \-\-tiling
  73. If an image is specified (via \-i) it will display the image tiled all over the screen
  74. (if it is a multi-monitor setup, the image is visible on all screens).
  75. .TP
  76. .BI \-p\ win|default \fR,\ \fB\-\-pointer= win|default
  77. If you specify "default",
  78. .B i3lock
  79. does not hide your Mousepointer. If you specify "win",
  80. .B i3lock
  81. displays a hardcoded Windows-Pointer (thus enabling you to fuck with your
  82. friends by using a Screenshot of a Windows-Desktop as a locking-screen).
  83. .SH SEE ALSO
  84. .IR xautolock(1)
  85. \- use i3lock as your screen saver
  86. .SH AUTHOR
  87. Michael Stapelberg <michael+i3lock at stapelberg dot de>
  88. Jan-Erik Rediger <badboy at archlinux.us>