current/SOURCES/cpuspeed.8

.\" DO NOT MODIFY THIS FILE!  It was generated by help2man 1.36.
.TH CPUSPEED "8" "October 08, 2008" "cpuspeed v1.5.1" "Program Options"
.SH NAME
cpuspeed \- user-space cpu frequency scaling program, v1.5.1
.SH SYNOPSIS
.B cpuspeed
[\fIOptions\fR]
.SH DESCRIPTION
cpuspeed v1.5.1
.PP
This program monitors the system's idle percentage and reduces or raises the
CPUs' clock speeds and voltages accordingly to minimize power consumption
when idle and maximize performance when needed.  This is the default.
.PP
The program may also optionally be configured to reduce the CPUs' clock
speeds if the temperature gets too high, NOT minimize their speeds if the
computer's AC adapter is disconnected or maximize their speeds when the AC
adapter is connected.
.PP
By default this program will manage every CPU found in the system.
.IP
Options:
.HP
\fB\-d\fR
.IP
Tells the process to daemonize itself (run in background).
.HP
\fB\-i\fR <interval>
.IP
Sets the interval between idle percentage tests and possible speed
changes in tenths of a second (default is 20).
.HP
\fB\-p\fR <fast up> <threshold>
.IP
Sets the CPU core idle percentage thresholds. <fast up> is the idle
percentage below which a CPU core will be set to the highest possible
speed.  <threshold> is the idle percentage above which a CPU core's
speed will be decreased and below which a CPU core's speed will be
increased (defaults are 10 and 25).
.HP
\fB\-m\fR <minimum speed>
.IP
Sets the minimum speed in KHz below which a CPU core will not be set.
.HP
\fB\-M\fR <maximum speed>
.IP
Sets the maximum speed in KHz above which a CPU core will not be set.
.HP
\fB\-n\fR
.IP
Do not treat niced programs as idle time.
.HP
\fB\-w\fR
.IP
Do not treat time waiting for IO as idle time.
.HP
\fB\-t\fR <temp file> <maxtemp>
.IP
Sets the ACPI temperature file and the temperature at which CPUs
will be set to minimum speed.
.HP
\fB\-T\fR <interval>
.IP
Sets the interval at which the temperature will be polled in
tenths of a second (default is 10).
(Requires the '\-t' option above.)
.HP
\fB\-a\fR <AC file>
.IP
Sets the ACPI AC adapter state file and tells the program to set
the CPUs to minimum speed when the AC adapter is disconnected.
(This is the default but is changeable by the '\-D' option below).
.HP
\fB\-A\fR <interval>
.IP
Sets the interval at which the AC adapter state will be polled in
tenths  of a second (default is 50).
(Requires the '\-a' option above.)
.HP
\fB\-C\fR
.IP
Run at maximum speed when AC adapter is connected.
(Requires the '\-a' option above.)
.HP
\fB\-D\fR
.IP
Do NOT force minimum speed when AC adapter is disconnected.
(Requires the '\-a' option above.)
.HP
\fB\-r\fR
.IP
Restores previous speed on program exit.
.HP
\fB\-S\fR <CPU core 1> [[<CPU core 2>] ...]
.IP
Manage only a single group of CPU cores.  All of the specified
cores will controlled as a single group (locked to the same speed)
and are in the range 0 to n-1 where 'n' is the total number of CPU
cores in the system.  Note that when specifying multiple cores the
list must be enclosed in quotes.  Without this option the program
creates copies of itself to manage every core of every CPU in the
system and automatically determines core groups. If you are running
on an old kernel and get an error message about not being able to
open an "affected_cpus" file then you must run this program
separately for each group of cores that must be controlled together
(which probably means for each physical CPU) and use this option.
.SS "Notes:"
To have a CPU core stay at the highest clock speed to maximize performance send
the process controlling that CPU core the SIGUSR1 signal.
.PP
To have a CPU core stay at the lowest clock speed to maximize battery life send
the process controlling that CPU core the SIGUSR2 signal.
.PP
To resume having a CPU core's clock speed dynamically scaled send the process
controlling that CPU core the SIGHUP signal.
.PP
Many modern Linux systems support in-kernel cpu frequency scaling. The
cpuspeed daemon only works in conjunction with the 'userspace' frequency
scaling governor. Other governors, such as 'ondemand' and 'conservative',
rely on the Linux kernel to adjust cpu frequencies on the fly without the
need of any user-space assistance, such as that provided by cpuspeed.
.PP
Red Hat and Fedora distributions employ a unified configuration file
for both scenarios, as well as a cpuspeed init script that will configure
either cpuspeed or in-kernel cpu frequency scaling, as appropriate.
.SH "FILES"
.na
.nf
/etc/sysconfig/cpuspeed, configuration file
/etc/init.d/cpuspeed, initialzation script
/usr/sbin/cpuspeed, cpuspeed program
.SH "SEE ALSO"
.PP
The CPUSpeed web page:
  \fB http://carlthompson.net/Software/CPUSpeed\fR
.SH "LICENSE"
.PP
CPUSpeed is released under the GNU General Public License version 2 (or if
you wish any later version). This license allows you to use, copy,
distribute and modify the software with very few restrictions. The full
text of the license may be found here:
  \fBhttp://carlthompson.net/Software/CPUSpeed/License\fR
.SH "AUTHOR(S):"
.TP
CPUSpeed daemon, original init script and configuration file:
.na
.nf
Carl Thompson \- cet [at] carlthompson.net
    (copyright 2002 \- 2008)
.TP
Modernized init script, configuration file and man page:
.na
.nf
Dave Jones \- davej [at] redhat.com
Michal Jaegermann \- michal [at] harddata.com
Jarod Wilson \- jwilson [at] redhat.com
1	.\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.36.
2	.TH CPUSPEED "8" "October 08, 2008" "cpuspeed v1.5.1" "Program Options"
3	.SH NAME
4	cpuspeed \- user-space cpu frequency scaling program, v1.5.1
5	.SH SYNOPSIS
6	.B cpuspeed
7	[\fIOptions\fR]
8	.SH DESCRIPTION
9	cpuspeed v1.5.1
10	.PP
11	This program monitors the system's idle percentage and reduces or raises the
12	CPUs' clock speeds and voltages accordingly to minimize power consumption
13	when idle and maximize performance when needed. This is the default.
14	.PP
15	The program may also optionally be configured to reduce the CPUs' clock
16	speeds if the temperature gets too high, NOT minimize their speeds if the
17	computer's AC adapter is disconnected or maximize their speeds when the AC
18	adapter is connected.
19	.PP
20	By default this program will manage every CPU found in the system.
21	.IP
22	Options:
23	.HP
24	\fB\-d\fR
25	.IP
26	Tells the process to daemonize itself (run in background).
27	.HP
28	\fB\-i\fR <interval>
29	.IP
30	Sets the interval between idle percentage tests and possible speed
31	changes in tenths of a second (default is 20).
32	.HP
33	\fB\-p\fR <fast up> <threshold>
34	.IP
35	Sets the CPU core idle percentage thresholds. <fast up> is the idle
36	percentage below which a CPU core will be set to the highest possible
37	speed. <threshold> is the idle percentage above which a CPU core's
38	speed will be decreased and below which a CPU core's speed will be
39	increased (defaults are 10 and 25).
40	.HP
41	\fB\-m\fR <minimum speed>
42	.IP
43	Sets the minimum speed in KHz below which a CPU core will not be set.
44	.HP
45	\fB\-M\fR <maximum speed>
46	.IP
47	Sets the maximum speed in KHz above which a CPU core will not be set.
48	.HP
49	\fB\-n\fR
50	.IP
51	Do not treat niced programs as idle time.
52	.HP
53	\fB\-w\fR
54	.IP
55	Do not treat time waiting for IO as idle time.
56	.HP
57	\fB\-t\fR <temp file> <maxtemp>
58	.IP
59	Sets the ACPI temperature file and the temperature at which CPUs
60	will be set to minimum speed.
61	.HP
62	\fB\-T\fR <interval>
63	.IP
64	Sets the interval at which the temperature will be polled in
65	tenths of a second (default is 10).
66	(Requires the '\-t' option above.)
67	.HP
68	\fB\-a\fR <AC file>
69	.IP
70	Sets the ACPI AC adapter state file and tells the program to set
71	the CPUs to minimum speed when the AC adapter is disconnected.
72	(This is the default but is changeable by the '\-D' option below).
73	.HP
74	\fB\-A\fR <interval>
75	.IP
76	Sets the interval at which the AC adapter state will be polled in
77	tenths of a second (default is 50).
78	(Requires the '\-a' option above.)
79	.HP
80	\fB\-C\fR
81	.IP
82	Run at maximum speed when AC adapter is connected.
83	(Requires the '\-a' option above.)
84	.HP
85	\fB\-D\fR
86	.IP
87	Do NOT force minimum speed when AC adapter is disconnected.
88	(Requires the '\-a' option above.)
89	.HP
90	\fB\-r\fR
91	.IP
92	Restores previous speed on program exit.
93	.HP
94	\fB\-S\fR <CPU core 1> [[<CPU core 2>] ...]
95	.IP
96	Manage only a single group of CPU cores. All of the specified
97	cores will controlled as a single group (locked to the same speed)
98	and are in the range 0 to n-1 where 'n' is the total number of CPU
99	cores in the system. Note that when specifying multiple cores the
100	list must be enclosed in quotes. Without this option the program
101	creates copies of itself to manage every core of every CPU in the
102	system and automatically determines core groups. If you are running
103	on an old kernel and get an error message about not being able to
104	open an "affected_cpus" file then you must run this program
105	separately for each group of cores that must be controlled together
106	(which probably means for each physical CPU) and use this option.
107	.SS "Notes:"
108	To have a CPU core stay at the highest clock speed to maximize performance send
109	the process controlling that CPU core the SIGUSR1 signal.
110	.PP
111	To have a CPU core stay at the lowest clock speed to maximize battery life send
112	the process controlling that CPU core the SIGUSR2 signal.
113	.PP
114	To resume having a CPU core's clock speed dynamically scaled send the process
115	controlling that CPU core the SIGHUP signal.
116	.PP
117	Many modern Linux systems support in-kernel cpu frequency scaling. The
118	cpuspeed daemon only works in conjunction with the 'userspace' frequency
119	scaling governor. Other governors, such as 'ondemand' and 'conservative',
120	rely on the Linux kernel to adjust cpu frequencies on the fly without the
121	need of any user-space assistance, such as that provided by cpuspeed.
122	.PP
123	Red Hat and Fedora distributions employ a unified configuration file
124	for both scenarios, as well as a cpuspeed init script that will configure
125	either cpuspeed or in-kernel cpu frequency scaling, as appropriate.
126	.SH "FILES"
127	.na
128	.nf
129	/etc/sysconfig/cpuspeed, configuration file
130	/etc/init.d/cpuspeed, initialzation script
131	/usr/sbin/cpuspeed, cpuspeed program
132	.SH "SEE ALSO"
133	.PP
134	The CPUSpeed web page:
135	\fB http://carlthompson.net/Software/CPUSpeed\fR
136	.SH "LICENSE"
137	.PP
138	CPUSpeed is released under the GNU General Public License version 2 (or if
139	you wish any later version). This license allows you to use, copy,
140	distribute and modify the software with very few restrictions. The full
141	text of the license may be found here:
142	\fBhttp://carlthompson.net/Software/CPUSpeed/License\fR
143	.SH "AUTHOR(S):"
144	.TP
145	CPUSpeed daemon, original init script and configuration file:
146	.na
147	.nf
148	Carl Thompson \- cet [at] carlthompson.net
149	(copyright 2002 \- 2008)
150	.TP
151	Modernized init script, configuration file and man page:
152	.na
153	.nf
154	Dave Jones \- davej [at] redhat.com
155	Michal Jaegermann \- michal [at] harddata.com
156	Jarod Wilson \- jwilson [at] redhat.com