cpupower: use man(1) when calling "cpupower help subcommand"
[linux-2.6.git] / tools / power / cpupower / man / cpupower.1
1 .TH CPUPOWER "1" "07/03/2011" "" "cpupower Manual"
2 .SH NAME
3 cpupower \- Shows and sets processor power related values
4 .SH SYNOPSIS
5 .ft B
6 .B cpupower [ \-c cpulist ] <command> [ARGS]
7
8 .B cpupower \-v|\-\-version
9
10 .B cpupower \-h|\-\-help
11
12 .SH DESCRIPTION
13 \fBcpupower \fP is a collection of tools to examine and tune power saving
14 related features of your processor.
15
16 The manpages of the commands (cpupower\-<command>(1)) provide detailed
17 descriptions of supported features. Run \fBcpupower help\fP to get an overview
18 of supported commands.
19
20 .SH Options
21 .PP
22 \-\-help, \-h
23 .RS 4
24 Shows supported commands and general usage.
25 .RE
26 .PP
27 \-\-cpu cpulist,  \-c cpulist
28 .RS 4
29 Only show or set values for specific cores.
30 This option is not supported by all commands, details can be found in the
31 manpages of the commands.
32
33 Some commands access all cores (typically the *\-set commands), some only
34 the first core (typically the *\-info commands) by default.
35
36 The syntax for <cpulist> is based on how the kernel exports CPU bitmasks via
37 sysfs files. Some examples:
38 .RS 4
39 .TP 16
40 Input
41 Equivalent to
42 .TP
43 all
44 all cores
45 .TP
46 0\-3
47 0,1,2,3
48 .TP
49 0\-7:2
50 0,2,4,6
51 .TP
52 1,3,5-7
53 1,3,5,6,7
54 .TP
55 0\-3:2,8\-15:4
56 0,2,8,12        
57 .RE
58 .RE
59 .PP
60 \-\-version,  \-v
61 .RS 4
62 Print the package name and version number.
63
64 .SH "SEE ALSO"
65 cpupower-set(1), cpupower-info(1), cpupower-idle(1),
66 cpupower-frequency-set(1), cpupower-frequency-info(1), cpupower-monitor(1),
67 powertop(1)
68 .PP
69 .SH AUTHORS
70 .nf
71 \-\-perf\-bias parts written by Len Brown <len.brown@intel.com>
72 Thomas Renninger <trenn@suse.de>