Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
branch: master
Fetching contributors…

Cannot retrieve contributors at this time

287 lines (286 sloc) 10.023 kb
.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings. \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote. \*(C+ will
.\" give a nicer C++. Capital omega is used to do unbreakable dashes and
.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
. ds -- \(*W-
. ds PI pi
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
. ds L" ""
. ds R" ""
. ds C` ""
. ds C' ""
'br\}
.el\{\
. ds -- \|\(em\|
. ds PI \(*p
. ds L" ``
. ds R" ''
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD. Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.ie \nF \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. nr % 0
. rr F
.\}
.el \{\
. de IX
..
.\}
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff
.if n \{\
. ds #H 0
. ds #V .8m
. ds #F .3m
. ds #[ \f1
. ds #] \fP
.\}
.if t \{\
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
. ds #V .6m
. ds #F 0
. ds #[ \&
. ds #] \&
.\}
. \" simple accents for nroff and troff
.if n \{\
. ds ' \&
. ds ` \&
. ds ^ \&
. ds , \&
. ds ~ ~
. ds /
.\}
.if t \{\
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
. \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
. \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
. \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
. ds : e
. ds 8 ss
. ds o a
. ds d- d\h'-1'\(ga
. ds D- D\h'-1'\(hy
. ds th \o'bp'
. ds Th \o'LP'
. ds ae ae
. ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "lightum 1"
.TH lightum 1 "2012-05-01" "lightum v2.0" "User commands"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
lightum \- MacBook automatic light sensor daemon
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
lightum [\-m \fIvalue\fR] [\-n \fIvalue\fR] [\-M \fIvalue\fR] [\-N \fIvalue\fR] [\-p \fIvalue\fR] [\-i \fIvalue\fR] [\-I \fIvalue\fR] [\-w {1,2,3}] [\-x] [\-u] [\-l] [\-s] [\-f] [\-v] [\-d {1,2,3}]
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
lightum is a daemon to control the keyboard brightness and monitor backlight on
MacBook based laptops.
.PP
By default it will run in \*(L"auto\*(R" mode, this means it will read data from the
ambient light sensor (located on the iSight camera) and automatically:
.PP
.Vb 2
\& a) light up or dim the keyboard brightness
\& b) light up or dim the the video backlight
.Ve
.PP
It will also dim the keyboard brightness and screen backlight when the computer
is not used for a configurable amount of seconds (5 by default).
.PP
If you choose to run it in \*(L"manual\*(R" mode, it will not query the ambient light
sensor, but instead it will use the brightness and backlight values you set
manually using the function keys.
.PP
When first launched lightum will create a configuration file in the folder
~/.config/lightum/lightum.conf, inside the user's home directory with the
default configuration values. When launched without parameters, lightum will
read the configuration from this config file, but the configuration values can
be overwritten via the command line.
.SH "OPTIONS"
.IX Header "OPTIONS"
Usage: lightum [\s-1OPTION\s0]...
\fB\-m\fR \fI4..255\fR : maximum brightness value in auto mode (default=255)
\fB\-n\fR \fI0..3\fR : minimum brightness value in auto mode (default=0)
\fB\-M\fR \fI7..15\fR : maximum backlight value in auto mode (default=15)
\fB\-N\fR \fI1..6\fR : minimum backlight value in auto mode (default=1)
\fB\-p\fR \fInum\fR : number of milliseconds between light sensor polls (default=300)
\fB\-i\fR \fInum\fR : power off keyboard light on session idle seconds (0 to disable)
\fB\-I\fR \fInum\fR : turn down screen backlight on session idle seconds (0 to disable)
\fB\-w\fR \fInum\fR : 1 manage brightness, 2 manage backlight, 3 both (default:3)
\fB\-x\fR : manual mode (will honor the brightness value set with Fn keys)
\fB\-l\fR : fully dim the screen backlight when session is idle
\fB\-u\fR : do not ignore brightness changes happening outside lightum
\fB\-s\fR : power off keyboard light when screen saver is active
\fB\-f\fR : run in foreground (do not daemonize)
\fB\-v\fR : verbose mode, useful for debugging with \-f and \-d
\fB\-d\fR \fInum\fR : debug mode: 1 brightness, 2 backlight, 3 both
.SH "CONFIGURATION FILE"
.IX Header "CONFIGURATION FILE"
\&\fBGeneral options\fR:
.PP
.Vb 4
\& # manualmode
\& # 0 = automatically adjust keyboard brightness based on light sensor
\& # 1 = or control keyboard brightness manually using Fn+ F5/F6 keys
\& manualmode=0
\&
\& # ignoreuser: only has effect in auto\-mode (when manualmode=0)
\& # 0 = change maxbrightness value dinamically when user presses Fn+ F5/F6
\& # 1 = ignore brightness changess happening outside lightum and keep the
\& # maxbrightness value from the config file (fixes bug in ubuntu 12.04)
\& ignoreuser=1
\&
\& # workmode
\& # 1 = only manage keyboard brightness (ignore screen backlight)
\& # 2 = only manage screen backlight (ignore keyboard brightness)
\& # 3 = manage both keyboard brightness and screen backlight
\& workmode=3
\&
\& # poll time in milliseconds (used for light sensor and session idle time)
\& polltime=300
\&
\& # screensaver
\& # 1 = turn off keyboard brightness when screensaver is active
\& # 0 = do not monitor screensaver status
\& queryscreensaver=0
.Ve
.PP
\&\fBOptions to manage keyboard brightness\fR:
.PP
.Vb 2
\& # maximum keyboard brightness value (between 4 and 255)
\& maxbrightness=56
\&
\& # minimum keyboard brightness value (between 0 and 3)
\& minbrightness=2
\&
\& # turn off keyboard brightness if computer unused for X seconds (0 to disable)
\& idleoff=4
.Ve
.PP
\&\fBOptions to manage screen backlight\fR:
.PP
.Vb 2
\& # maximum screen backlight value (between 4 and 15)
\& maxbacklight=12
\&
\& # minimum screen backlight value (between 0 and 3)
\& minbacklight=2
\&
\& # turn off screen backlight if computer unused for X seconds (0 to disable)
\& screenidle=30
\&
\& # fully dim the backlight when screenidle seconds reached (default 0)
\& # 1 = when idle, backlight will be set to 1
\& # 0 = when idle, backlight will be set to minbacklight
\& fulldim=0
.Ve
.SH "EXAMPLES"
.IX Header "EXAMPLES"
1) Run lightum in auto mode, managing both screen backlight and keyboard brightness automatically, changing the maximum and minimum values for both options and also changing the idle times to dim them:
.PP
.Vb 1
\& lightum \-m 56 \-n 2 \-i 4 \-M 12 \-N 2 \-I 30
.Ve
.PP
The same command line example, but specified via config file:
.PP
.Vb 11
\& manualmode=0
\& ignoreuser=1
\& workmode=3
\& maxbrightness=56
\& minbrightness=2
\& polltime=300
\& idleoff=4
\& queryscreensaver=0
\& maxbacklight=12
\& minbacklight=2
\& screenidle=30
\& fulldim=0
.Ve
.PP
2) Run lightum in manual mode, used only to automatically turn off the keyboard brightness after 10 seconds of idle time
.PP
.Vb 1
\& lightum \-x \-w 1 \-i 10 \-n 0
.Ve
.SH "EXIT STATUS"
.IX Header "EXIT STATUS"
Lightum will return a non zero exit status in case of failure.
.SH "AUTHOR"
.IX Header "AUTHOR"
Written by Pau Oliva Fora
.SH "REPORTING BUGS"
.IX Header "REPORTING BUGS"
Please report bugs here:
https://github.com/poliva/lightum/issues
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright (c)2011\-2012 Pau Oliva Fora.
License GPLv2+: \s-1GNU\s0 \s-1GPL\s0 version 2 or later <http://gnu.org/licenses/gpl.html>
This is free software: you are free to change and redistribute it.
There is \s-1NO\s0 \s-1WARRANTY\s0, to the extent permitted by law.
Jump to Line
Something went wrong with that request. Please try again.