Skip to content

Commit

Permalink
update man page
Browse files Browse the repository at this point in the history
  • Loading branch information
poliva committed May 16, 2012
1 parent f8c814e commit f8da4b4
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 2 deletions.
8 changes: 7 additions & 1 deletion lightum.1
Expand Up @@ -133,7 +133,7 @@
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] [\-s] [\-f] [\-v] [\-d {1,2,3}]
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
Expand Down Expand Up @@ -232,6 +232,11 @@ Usage: lightum [\s-1OPTION\s0]...
\&
\& # 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"
Expand All @@ -255,6 +260,7 @@ The same command line example, but specified via config file:
\& 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
Expand Down
8 changes: 7 additions & 1 deletion lightum.pod
Expand Up @@ -4,7 +4,7 @@ lightum - MacBook automatic light sensor daemon

=head1 SYNOPSIS

lightum [-m I<value>] [-n I<value>] [-M I<value>] [-N I<value>] [-p I<value>] [-i I<value>] [-I I<value>] [-w {1,2,3}] [-x] [-u] [-s] [-f] [-v] [-d {1,2,3}]
lightum [-m I<value>] [-n I<value>] [-M I<value>] [-N I<value>] [-p I<value>] [-i I<value>] [-I I<value>] [-w {1,2,3}] [-x] [-u] [-l] [-s] [-f] [-v] [-d {1,2,3}]

=head1 DESCRIPTION

Expand Down Expand Up @@ -101,6 +101,11 @@ B<Options to manage screen backlight>:
# 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

=head1 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:
Expand All @@ -120,6 +125,7 @@ The same command line example, but specified via config file:
maxbacklight=12
minbacklight=2
screenidle=30
fulldim=0

2) Run lightum in manual mode, used only to automatically turn off the keyboard brightness after 10 seconds of idle time

Expand Down

0 comments on commit f8da4b4

Please sign in to comment.