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 December 21, 2009
  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 v
  45 .Sh DESCRIPTION
  46 The
  47 .Nm
  48 utility monitors the system state and sets various power control options
  49 accordingly.
  50 It offers four modes (maximum, minimum, adaptive and hiadaptive) that can be
  51 individually selected while on AC power or batteries.
  52 The modes maximum, minimum, adaptive and hiadaptive may be abbreviated
  53 max, min, adp, hadp.
  54 .Pp
  55 Maximum mode chooses the highest performance values.
  56 Minimum mode selects the lowest performance values to get the most power
  57 savings.
  58 Adaptive mode attempts to strike a balance by degrading performance when
  59 the system appears idle and increasing it when the system is busy.
  60 It offers a good balance between a small performance loss for greatly
  61 increased power savings.
  62 Hiadaptive mode is like adaptive mode, but tuned for systems where
  63 performance and interactivity are more important than power consumption.
  64 It increases frequency faster, reduces the frequency less aggressively and
  65 will maintain full frequency for longer.
  66 The default mode is adaptive for battery power and hiadaptive for the rest.
  67 .Pp
  68 The
  69 .Nm
  70 utility recognizes the following runtime options:
  71 .Bl -tag -width ".Fl r Ar percent"
  72 .It Fl a Ar mode
  73 Selects the
  74 .Ar mode
  75 to use while on AC power.
  76 .It Fl b Ar mode
  77 Selects the
  78 .Ar mode
  79 to use while on battery power.
  80 .It Fl i Ar percent
  81 Specifies the CPU load percent level when adaptive
  82 mode should begin to degrade performance to save power.
  83 The default is 50% or lower.
  84 .It Fl m Ar freq
  85 Specifies the minimum frequency to throttle down to.
  86 .It Fl M Ar freq
  87 Specifies the maximum frequency to throttle up to.
  88 .It Fl n Ar mode
  89 Selects the
  90 .Ar mode
  91 to use normally when the AC line state is unknown.
  92 .It Fl p Ar ival
  93 Specifies a different polling interval (in milliseconds) for AC line state
  94 and system idle levels.
  95 The default is 250 ms.
  96 .It Fl P Ar pidfile
  97 Specifies an alternative file in which the process ID should be stored.
  98 The default is
  99 .Pa /var/run/powerd.pid .
 100 .It Fl r Ar percent
 101 Specifies the CPU load percent level where adaptive
 102 mode should consider the CPU running and increase performance.
 103 The default is 75% or higher.
 104 .It Fl v
 105 Verbose mode.
 106 Messages about power changes will be printed to stdout and
 107 .Nm
 108 will operate in the foreground.
 109 .El
 110 .Sh SEE ALSO
 111 .Xr acpi 4 ,
 112 .Xr apm 4 ,
 113 .Xr cpufreq 4
 114 .Sh HISTORY
 115 The
 116 .Nm
 117 utility first appeared in
 118 .Fx 6.0 .
 119 .Sh AUTHORS
 120 .An -nosplit
 121 .An Colin Percival
 122 first wrote
 123 .Nm estctrl ,
 124 the utility that
 125 .Nm
 126 is based on.
 127 .An Nate Lawson
 128 then updated it for
 129 .Xr cpufreq 4 ,
 130 added features, and wrote this manual page.
 131 .Sh BUGS
 132 The
 133 .Nm
 134 utility should also power down idle disks and other components besides the CPU.
 135 .Pp
 136 If
 137 .Nm
 138 is used with
 139 .Pa power_profile ,
 140 they may override each other.
 141 .Pp
 142 The
 143 .Nm
 144 utility
 145 should probably use the
 146 .Xr devctl 4
 147 interface instead of polling for AC line state.