1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192
  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 S
  42. Set brightness to value
  43. .It Fl G
  44. Get brightness, default
  45. .It Fl N
  46. Set minimum brightness to value
  47. .It Fl P
  48. Get minimum brightness
  49. .It Fl I
  50. Save current brightness
  51. .It Fl O
  52. Restore previously saved brightness
  53. .El
  54. .Sh OPTIONS
  55. The behavior of the above commands can be modified using these options:
  56. .Pp
  57. .Bl -tag -width Ds
  58. .It Fl r
  59. Interpret input and output values in raw mode
  60. .It Fl s Ar PATH
  61. Specify device target path. Use
  62. .Fl L
  63. to list available devices
  64. .It Fl v Ar LEVEL
  65. Set verbosity level, by default
  66. .Nm
  67. only outputs read values:
  68. .Pp
  69. .Bl -tag -width 0: -compact
  70. .It 0:
  71. Read values
  72. .It 1:
  73. Read values, Errors
  74. .It 2:
  75. Read values, Errors, Warnings
  76. .It 3:
  77. Read values, Errors, Warnings, Notices
  78. .El
  79. .El
  80. .Sh FILES
  81. When run in its classic SUID root mode
  82. .Nm
  83. caches settings and current brightness in
  84. .Pa /etc/light .
  85. In its non-priviliged mode of operation the
  86. .Pa ~/.cache/light
  87. directory is used instead.
  88. .Sh AUTHORS
  89. Copyright \(co 2012-2018 Fredrik Haikarainen
  90. .Pp
  91. This is free software, see the source for copying conditions. There is NO
  92. warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE