Merge branch 'vendor/OPENSSL'
[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 October 28, 2014
5 .Dt POWERD 8
6 .Os
7 .Sh NAME
8 .Nm powerd
9 .Nd simple ACPI based CPU/power control
10 .Sh SYNOPSIS
11 .Nm
12 .Op Fl dt
13 .Op Fl p Ar hysteresis
14 .Op Fl u Ar trigger_up
15 .Op Fl r Ar poll_time
16 .Op Fl T Ar sample_time
17 .Sh DESCRIPTION
18 The
19 .Nm
20 daemon monitors the CPU load and automatically adjusts the CPU
21 frequency up or down.
22 .Pp
23 All CPUs will be set to their maximum frequency when the 1 second
24 machine load exceeds 25% of one CPU.
25 All CPUs will be set to their
26 minimum frequency when the 10 second machine load drops below 12% of
27 one CPU.
28 .Pp
29 The options are as follows:
30 .Bl -tag -width ".Fl p Ar hysteresis"
31 .It Fl d
32 Debug option.
33 Causes
34 .Nm
35 to not go to the background and prints some debug output to
36 .Va stdout .
37 .It Fl p Ar hysteresis
38 Percent of the upper limit to subtract as an hysteresis value to scale
39 down to the min frequency.
40 The default is 10 (meaning 10%).
41 .It Fl t
42 Turbo mode.
43 Disables switching to turbo mode as maximum frequency completely.
44 Switching to turbo mode as maximum frequency is enabled by default,
45 if the CPU supports it.
46 .It Fl u Ar trigger_up
47 Per CPU load limit in percent to force maximum frequency.
48 The default is 25 (meaning an instantanious load of 0.25 on a
49 single cpu).  The load is calculated over 3 polls.
50 It is suggested that this value not be made lower than
51 around 7.
52 .It Fl r Ar poll_time
53 Polling time in seconds.  Default is 1.0.
54 Setting this value lower will poll for load changes faster.
55 For example, a workstation might want to use 0.2 or 0.4.
56 .Nm can become unstable if you make this value too small.
57 .It Fl T Ar sample_time
58 Total sample interval in seconds.  Default is 8.0.
59 This effects how quickly powerd ratchets down the frequency
60 and cpus on an idle machine.  Longer times will ratchet down
61 more slowly.
62 For example, a workstation might want to use a value of 30.0.
63 .It Fl B Ar minimum_battery_life
64 If battery life is less than or equal to the specified value,
65 the machine will be powered off immediately.
66 Default is 2 (2% battery life left).
67 .It Fl L Ar battery_life_linger
68 If battery life is less than or equal to the configured value,
69 and
70 .Nm
71 just started,
72 shutting down the machine will be delayed by the specified value.
73 Default is 60 seconds.
74 .It Fl P Ar battery_poll_interval
75 Poll the battery life at the specified interval.
76 Default is 5 seconds.
77 .El
78 .Sh EXAMPLES
79 The defaults work well for servers but a workstation user might want
80 to use something like the following in their
81 .Pa /etc/rc.conf
82 to ratchet up the machine more quickly in response to spike loads
83 (such as when you are browsing).
84 .Pp
85 .Li powerd_enable="YES"
86 .Pp
87 .Li powerd_flags="-u 7 -r 0.2 -T 60"
88 .Sh DIAGNOSTICS
89 The
90 .Nm
91 utility will exit with a non-zero code if the required sysctls are not
92 present.
93 .Sh SEE ALSO
94 .Xr acpi 4 ,
95 .Xr est 4 ,
96 .Xr powernow 4
97 .Sh HISTORY
98 The
99 .Nm
100 command first appeared in
101 .Dx 2.7 .
102 .Sh BUGS
103 I'm shocked I tell you, shocked that there might be bugs in this program!