12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394
  1. .\" -*- nroff -*-
  2. .Dd August 4, 2018
  3. .Os GNU/Linux
  4. .Dt LIGHT 1 URM
  5. .Sh NAME
  6. .Nm light
  7. .Nd a program to control backlight controllers
  8. .Sh SYNOPSIS
  9. .Nm light
  10. .Op Ar OPTIONS
  11. .Op Ar VALUE
  12. .Sh DESCRIPTION
  13. .Nm
  14. is a program to control backlight display and keyboard controllers under
  15. GNU/Linux.
  16. .Pp
  17. .Bl -bullet -compact
  18. .It
  19. Operates independently of X (X-Window)
  20. .It
  21. Can automatically figure out the best controller to use, making full use
  22. of the underlying hardware
  23. .It
  24. Supports a minimum cap on the brightness value, as some controllers set
  25. the display to be pitch black at a vaĺue of 0 (or higher)
  26. .El
  27. .Sh COMMANDS
  28. The following unique commands are supported:
  29. .Pp
  30. .Bl -tag -width Ds
  31. .It Fl H , Fl h
  32. Show help text and exit
  33. .It Fl V
  34. Show program version and exit
  35. .It Fl L
  36. List available devices
  37. .It Fl A
  38. Increase brightness by value
  39. .It Fl U
  40. Decrease brightness by value
  41. .It Fl T
  42. Multiply brightness by value (can be a non-whole number, ignores raw mode)
  43. .It Fl S
  44. Set brightness to value
  45. .It Fl G
  46. Get brightness, default
  47. .It Fl N
  48. Set minimum brightness to value
  49. .It Fl P
  50. Get minimum brightness
  51. .It Fl O
  52. Save current brightness
  53. .It Fl I
  54. Restore previously saved brightness
  55. .El
  56. .Sh OPTIONS
  57. The behavior of the above commands can be modified using these options:
  58. .Pp
  59. .Bl -tag -width Ds
  60. .It Fl r
  61. Interpret input and output values in raw mode
  62. .It Fl s Ar PATH
  63. Specify device target path. Use
  64. .Fl L
  65. to list available devices
  66. .It Fl v Ar LEVEL
  67. Set verbosity level, by default
  68. .Nm
  69. only outputs read values:
  70. .Pp
  71. .Bl -tag -width 0: -compact
  72. .It 0:
  73. Read values
  74. .It 1:
  75. Read values, Errors
  76. .It 2:
  77. Read values, Errors, Warnings
  78. .It 3:
  79. Read values, Errors, Warnings, Notices
  80. .El
  81. .El
  82. .Sh FILES
  83. When run in its classic SUID root mode
  84. .Nm
  85. caches settings and current brightness in
  86. .Pa /etc/light .
  87. In its non-privileged mode of operation the
  88. .Pa ~/.cache/light
  89. directory is used instead.
  90. .Sh AUTHORS
  91. Copyright \(co 2012-2018 Fredrik Haikarainen
  92. .Pp
  93. This is free software, see the source for copying conditions. There is NO
  94. warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE