powerd: Set backlight to the specified value, if AC line is unplugged.
[dragonfly.git] / usr.sbin / powerd / powerd.8
1 .\" (c) Copyright 2010 by Matthew Dillon and Dima Ruban.  Permission to
2 .\"    use and distribute based on the DragonFly copyright.
3 .\"
4 .Dd August 16, 2015
5 .Dt POWERD 8
6 .Os
7 .Sh NAME
8 .Nm powerd
9 .Nd simple CPU performance control and battery life monitor
10 .Sh SYNOPSIS
11 .Nm
12 .Op Fl cdeftQ
13 .Op Fl b Ar backlight_percentage
14 .Op Fl h Ar highest_freq
15 .Op Fl l Ar lowest_freq
16 .Op Fl p Ar hysteresis
17 .Op Fl r Ar poll_time
18 .Op Fl u Ar trigger_up
19 .Op Fl B Ar minimum_battery_life
20 .Op Fl L Ar battery_life_linger
21 .Op Fl P Ar battery_poll_interval
22 .Op Fl T Ar sample_time
23 .Sh DESCRIPTION
24 The
25 .Nm
26 daemon monitors the CPU load and automatically adjusts the CPU
27 performance up or down accordingly.
28 .Pp
29 The
30 .Nm
31 also monitors battery life.
32 If the battery life is low
33 (less then or equal to 2% by default),
34 .Nm
35 will send audio alert immediately,
36 and shutdown the machine after lingering for a little while
37 (60 seconds by default).
38 .Pp
39 The options are as follows:
40 .Bl -tag -width ".Fl p Ar hysteresis"
41 .It Fl b Ar backlight_percentage
42 Set backlight to the specified percentage,
43 if AC line is not plugged in.
44 .It Fl c
45 Enable mwait C-state hint adjustment,
46 if it is available.
47 .It Fl d
48 Debug option.
49 Causes
50 .Nm
51 to not go to the background and prints some debug output to
52 .Va stdout .
53 .It Fl e
54 Enable Intel Performance and Energy Bias Hint adjustment,
55 if it is available.
56 .It Fl f
57 Disable CPU power domain frequency adjustment.
58 CPU power domain frequency adjustment does not reduce CPU power consumption
59 much
60 (if any)
61 on some of the modern Intel CPUs,
62 when the CPU is idle.
63 .It Fl h Ar highest_freq
64 If CPU power domain frequency adjustment is enabled,
65 then frequency of CPU power domains will not be set to a value higher
66 than the specified limit.
67 (unit: MHz)
68 .It Fl l Ar lowest_freq
69 If CPU power domain frequency adjustment is enabled,
70 then frequency of CPU power domains will not be set to a value lower
71 than the specified limit.
72 (unit: MHz)
73 .It Fl p Ar hysteresis
74 Percent of the upper limit to subtract as an hysteresis value to scale
75 down to the min performance.
76 The default is 10
77 (meaning 10%).
78 .It Fl r Ar poll_time
79 Polling time in seconds.
80 Default is 1.0.
81 Setting this value lower will poll for load changes faster.
82 For example,
83 a workstation might want to use 0.2 or 0.4.
84 .Nm can become unstable if you make this value too small.
85 .It Fl t
86 Turbo mode.
87 Disables switching to turbo mode as maximum frequency completely.
88 Switching to turbo mode as maximum frequency is enabled by default,
89 if the CPU supports it.
90 .It Fl u Ar trigger_up
91 Per CPU load limit in percent to force maximum performance.
92 The default is 25
93 (meaning an instantanious load of 0.25 on a single cpu).
94 The load is calculated over 3 polls.
95 It is suggested that this value not be made lower than around 7.
96 .It Fl B Ar minimum_battery_life
97 If battery life is less than or equal to the specified value,
98 the machine will start shutting down process.
99 Default is 2
100 (2% battery life left).
101 .It Fl L Ar battery_life_linger
102 If battery life is less than or equal to the configured value,
103 shutting down the machine will be delayed by the specified value.
104 During the delay,
105 alert message will be logged to the console,
106 and audio alert will be alarmed.
107 If AC line is plugged in during this delay,
108 shutting down process will be cancelled.
109 Default is 60 seconds.
110 .It Fl P Ar battery_poll_interval
111 Poll the battery life at the specified interval.
112 If 0 is specified,
113 battery life monitoring will be disabled.
114 Default is 5 seconds.
115 .It Fl Q
116 Don't alarm audio alert,
117 if the battery life is low.
118 .It Fl T Ar sample_time
119 Total sample interval in seconds.
120 Default is 8.0.
121 This effects how quickly powerd ratchets down the performance
122 and cpus on an idle machine.
123 Longer times will ratchet down more slowly.
124 For example,
125 a workstation might want to use a value of 30.0.
126 .El
127 .Sh EXAMPLES
128 The defaults work well for servers but a workstation user might want
129 to use something like the following in their
130 .Pa /etc/rc.conf
131 to ratchet up the machine more quickly in response to spike loads
132 (such as when you are browsing).
133 .Pp
134 .Li powerd_enable="YES"
135 .Pp
136 .Li powerd_flags="-u 7 -r 0.2 -T 60"
137 .Sh DIAGNOSTICS
138 The
139 .Nm
140 utility will exit with a non-zero code if the required sysctls are not
141 present.
142 .Sh SEE ALSO
143 .Xr acpi 4 ,
144 .Xr perfbias 4
145 .Sh HISTORY
146 The
147 .Nm
148 command first appeared in
149 .Dx 2.7 .
150 .Sh BUGS
151 I'm shocked I tell you,
152 shocked that there might be bugs in this program!