| Amit Arora | 39f2954 | 2010-09-14 12:03:22 +0530 | [diff] [blame] | 1 | .\" Hey, EMACS: -*- nroff -*- |
| 2 | .\" First parameter, NAME, should be all caps |
| 3 | .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection |
| 4 | .\" other parameters are allowed: see man(7), man(1) |
| 5 | .TH POWERDEBUG 8 "September 3, 2010" "Linux" "PowerDebug Manual" |
| 6 | .\" Please adjust this date whenever revising the manpage. |
| 7 | .\" |
| 8 | .\" Some roff macros, for reference: |
| 9 | .\" .nh disable hyphenation |
| 10 | .\" .hy enable hyphenation |
| 11 | .\" .ad l left justify |
| 12 | .\" .ad b justify to both left and right margins |
| 13 | .\" .nf disable filling |
| 14 | .\" .fi enable filling |
| 15 | .\" .br insert line break |
| 16 | .\" .sp <n> insert n+1 empty lines |
| 17 | .\" for manpage-specific macros, see man(7) |
| 18 | .SH NAME |
| 19 | powerdebug \- A tool to display regulator and sensor information |
| 20 | .SH SYNOPSIS |
| 21 | .B powerdebug |
| Amit Arora | 728e0c9 | 2010-09-14 12:06:09 +0530 | [diff] [blame] | 22 | .RB [[-r|-s|-c] [-v] [-d] [-t <ticktime>]] |
| Amit Arora | 39f2954 | 2010-09-14 12:03:22 +0530 | [diff] [blame] | 23 | .RB [-V] |
| 24 | .RB [-h] |
| 25 | .br |
| 26 | .SH DESCRIPTION |
| Amit Arora | 728e0c9 | 2010-09-14 12:06:09 +0530 | [diff] [blame] | 27 | This tool can be used to display regulator, sensor and clock tree |
| 28 | related information. |
| Amit Arora | 39f2954 | 2010-09-14 12:03:22 +0530 | [diff] [blame] | 29 | .PP |
| 30 | .\" TeX users may be more comfortable with the \fB<whatever>\fP and |
| 31 | .\" \fI<whatever>\fP escape sequences to invode bold face and italics, |
| 32 | .\" respectively. |
| 33 | \fBpowerdebug\fP is a tool that provides users extra information |
| 34 | about how the power is being managed in the system. |
| 35 | .SH OPTIONS |
| 36 | These programs follow the usual GNU command line syntax, with long |
| 37 | options starting with two dashes (`-'). |
| 38 | A summary of options is included below. |
| 39 | For a complete description, see the Info files. |
| 40 | .TP |
| 41 | \fB\-r\fR, \fB\-\-regulator |
| 42 | print regulator information. |
| 43 | .TP |
| 44 | \fB\-s\fR, \fB\-\-sensor |
| 45 | print sensor information. |
| 46 | .TP |
| Amit Arora | 728e0c9 | 2010-09-14 12:06:09 +0530 | [diff] [blame] | 47 | \fB\-c\fR, \fB\-\-clock |
| 48 | print clock tree related information. |
| 49 | .TP |
| 50 | \fB\-t\fR, \fB\-\-time |
| 51 | set the ticktime to specified value. |
| 52 | .TP |
| Amit Arora | 39f2954 | 2010-09-14 12:03:22 +0530 | [diff] [blame] | 53 | \fB\-v\fR, \fB\-\-verbose |
| 54 | show detailed information. |
| 55 | .TP |
| 56 | \fB\-d\fR, \fB\-\-dump |
| 57 | read and list information only once. |
| 58 | .TP |
| 59 | \fB\-V\fR, \fB\-\-version |
| 60 | show version information and exit. |
| 61 | .TP |
| 62 | \fB\-h\fR, \fB\-\-help |
| 63 | show usage details. |
| 64 | Show version of program. |
| 65 | .SH SEE ALSO |
| 66 | .BR powertop (8) |
| 67 | .br |
| 68 | .SH AUTHOR |
| 69 | powerdebug was written by Amit Arora <amit.arora@linaro.org>. |
| 70 | .PP |
| 71 | This manual page was written by Amit Arora <amit.arora@linaro.org>, |
| 72 | for the Debian project (and may be used by others). |