aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorSami Kerola <kerolasa@iki.fi>2014-09-07 22:27:17 +0100
committerAlexandra Yates <alexandra.yates@linux.intel.com>2014-09-29 11:31:28 -0700
commitbe2a125e87b489dcc641cddac22ebdff4b55428f (patch)
treedc0c330461c59d3f096f0644919a024b34be7767 /doc
parentc28e6ef10a59ffbe57dba521eb15919b5b1d29e9 (diff)
add --auto-tune and --workload to manual page
Options in manual page are now in same order as in usage output, and they include short options when aplicable. Signed-off-by: Sami Kerola <kerolasa@iki.fi>
Diffstat (limited to 'doc')
-rw-r--r--doc/powertop.830
1 files changed, 19 insertions, 11 deletions
diff --git a/doc/powertop.8 b/doc/powertop.8
index 31e7e6d..60e3c73 100644
--- a/doc/powertop.8
+++ b/doc/powertop.8
@@ -12,7 +12,10 @@ experiment with various power management settings. When invoking
powertop without arguments powertop starts in interactive mode.
.SH OPTIONS
.TP
-.B \-\-calibrate
+.B \-\-auto\-tune
+Set all tunable options to their good setting without interaction.
+.TP
+.BR \-c ", " \-\-calibrate
Runs powertop in calibration mode. When running on battery, powertop can
track power consumption as well as system activity. When there are
enough measurements, powertop can start to report power estimates. One
@@ -20,7 +23,7 @@ can get more accurate estimates by using this option to enable a
calibration cycle. This will cycle through various display levels and
USB device activities and workloads.
.TP
-\fB\-\-csv\fR[=\fIfilename\fR]
+\fB\-C\fR, \fB\-\-csv\fR[=\fIfilename\fR]
Generate a CSV report. If a
.I filename
is not specified then the default name
@@ -28,7 +31,7 @@ is not specified then the default name
is used. The CSV report can be used for reporting and data analysis.
.TP
.B \-\-debug
-Run in "debug" mode.
+Run in debug mode.
.TP
\fB\-\-extech\fR=\fIdevnode\fR
Use the Extech Power Analyzer for measurements. This allows one to
@@ -36,10 +39,7 @@ specify the serial device node of the serial to USB adaptor connecting to
the Extech Power Analyzer, for example
.IR /dev/ttyUSB0 .
.TP
-.B \-\-help
-Show the help message.
-.TP
-\fB\-\-html\fR[=\fIfilename\fR]
+\fB\-r\fR, \fB\-\-html\fR[=\fIfilename\fR]
Generate an HTML report. If a
.I filename
is not specified then the default name
@@ -47,18 +47,26 @@ is not specified then the default name
is used. The HTML report can be sent to others to help diagnose power
issues.
.TP
-\fB\-\-iteration\fR[=\fIiterations\fR]
+\fB\-i\fR, \fB\-\-iteration\fR[=\fIiterations\fR]
Number of times to run each test.
.TP
-.B \-\-quiet
+.BR \-q ", " \-\-quiet
Suppress stderr output.
.TP
-\fB\-\-time\fR[=\fIseconds\fR]
+\fB\-t\fR, \fB\-\-time\fR[=\fIseconds\fR]
Generate a report for a specified number of
.IR seconds .
.TP
-.B \-\-version
+\fB\-w\fR, \fB\-\-workload\fR[=\fIworkload\fR]
+Execute
+.I workload
+file as a part of calibration before making a report.
+.TP
+.BR \-V ", " \-\-version
Print version information and exit.
+.TP
+.BR \-h ", " \-\-help
+Show the help message and exit.
.SH COMMANDS
In interactive mode, the following key bindings are available:
.IP