usr.sbin/powerd/powerd.8

   1 .\" Copyright (c) 2005 Nate Lawson
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .\" $FreeBSD$
  26 .\"
  27 .Dd January 13, 2019
  28 .Dt POWERD 8
  29 .Os
  30 .Sh NAME
  31 .Nm powerd
  32 .Nd "system power control utility"
  33 .Sh SYNOPSIS
  34 .Nm
  35 .Op Fl a Ar mode
  36 .Op Fl b Ar mode
  37 .Op Fl i Ar percent
  38 .Op Fl m Ar freq
  39 .Op Fl M Ar freq
  40 .Op Fl n Ar mode
  41 .Op Fl p Ar ival
  42 .Op Fl P Ar pidfile
  43 .Op Fl r Ar percent
  44 .Op Fl s Ar source
  45 .Op Fl v
  46 .Sh DESCRIPTION
  47 The
  48 .Nm
  49 utility monitors the system state and sets various power control options
  50 accordingly.
  51 It offers power-saving modes that can be
  52 individually selected for operation on AC power or batteries.
  53 .Bl -tag -width ".Ar hiadaptive"
  54 .It Ar maximum
  55 Choose the highest performance values.
  56 May be abbreviated as
  57 .Ar max .
  58 .It Ar minimum
  59 Choose the lowest performance values to get the most power savings.
  60 May be abbreviated as
  61 .Ar min .
  62 .It Ar adaptive
  63 Attempt to strike a balance by degrading performance when the system
  64 appears idle and increasing it when the system is busy.
  65 It offers a good balance between a small performance loss for greatly
  66 increased power savings.
  67 May be abbreviated as
  68 .Ar adp .
  69 .It Ar hiadaptive
  70 Like
  71 .Ar adaptive
  72 mode, but tuned for systems where performance and interactivity are
  73 more important than power consumption.
  74 It increases frequency faster, reduces frequency less aggressively, and
  75 will maintain full frequency for longer.
  76 May be abbreviated as
  77 .Ar hadp .
  78 .El
  79 .Pp
  80 The default mode is
  81 .Ar adaptive
  82 for battery power and
  83 .Ar hiadaptive
  84 for the rest.
  85 .Pp
  86 .Nm
  87 recognizes these runtime options:
  88 .Bl -tag -width ".Fl r Ar percent"
  89 .It Fl a Ar mode
  90 Selects the
  91 .Ar mode
  92 to use while on AC power.
  93 .It Fl b Ar mode
  94 Selects the
  95 .Ar mode
  96 to use while on battery power.
  97 .It Fl i Ar percent
  98 Specifies the CPU load percent level when adaptive
  99 mode should begin to degrade performance to save power.
 100 The default is 50% or lower.
 101 .It Fl m Ar freq
 102 Specifies the minimum frequency to throttle down to.
 103 .It Fl M Ar freq
 104 Specifies the maximum frequency to throttle up to.
 105 .It Fl n Ar mode
 106 Selects the
 107 .Ar mode
 108 to use normally when the AC line state is unknown.
 109 .It Fl p Ar ival
 110 Specifies a different polling interval (in milliseconds) for AC line state
 111 and system idle levels.
 112 The default is 250 ms.
 113 .It Fl P Ar pidfile
 114 Specifies an alternative file in which the process ID should be stored.
 115 The default is
 116 .Pa /var/run/powerd.pid .
 117 .It Fl r Ar percent
 118 Specifies the CPU load percent level where adaptive
 119 mode should consider the CPU running and increase performance.
 120 The default is 75% or higher.
 121 .It Fl s Ar source
 122 Enforces method for AC line state refresh; by default, it is chosen
 123 automatically.
 124 The set of valid methods is
 125 .Cm sysctl , devd
 126 and
 127 .Cm apm
 128 (i386 only).
 129 .It Fl v
 130 Verbose mode.
 131 Messages about power changes will be printed to stdout and
 132 .Nm
 133 will operate in the foreground.
 134 .El
 135 .Sh SEE ALSO
 136 .Xr acpi 4 ,
 137 .Xr apm 4 ,
 138 .Xr cpufreq 4
 139 .Sh HISTORY
 140 The
 141 .Nm
 142 utility first appeared in
 143 .Fx 6.0 .
 144 .Sh AUTHORS
 145 .An -nosplit
 146 .An Colin Percival
 147 first wrote
 148 .Nm estctrl ,
 149 the utility that
 150 .Nm
 151 is based on.
 152 .An Nate Lawson
 153 then updated it for
 154 .Xr cpufreq 4 ,
 155 added features, and wrote this manual page.
 156 .Sh BUGS
 157 The
 158 .Nm
 159 utility should also power down idle disks and other components besides the CPU.
 160 .Pp
 161 If
 162 .Nm
 163 is used with
 164 .Pa power_profile ,
 165 they may override each other.
 166 .Pp
 167 The
 168 .Nm
 169 utility
 170 should probably use the
 171 .Xr devctl 4
 172 interface instead of polling for AC line state.