projects / packages / acpica.git / blame
| Commit | Line | Data |
|---|---|---|
| 77760c90 JB |
1 | .\" First parameter, NAME, should be all caps |
| 2 | .\" Second parameter, SECTION, should be 1-8, maybe w/ subsection | |
| 3 | .\" other parameters are allowed: see man(7), man(1) | |
| 4 | .TH ACPIHELP 1 "January 23, 2013" | |
| 5 | .\" Please adjust this date whenever revising the manpage. | |
| 6 | .\" | |
| 7 | .\" Some roff macros, for reference: | |
| 8 | .\" .nh disable hyphenation | |
| 9 | .\" .hy enable hyphenation | |
| 10 | .\" .ad l left justify | |
| 11 | .\" .ad b justify to both left and right margins | |
| 12 | .\" .nf disable filling | |
| 13 | .\" .fi enable filling | |
| 14 | .\" .br insert line break | |
| 15 | .\" .sp <n> insert n+1 empty lines | |
| 16 | .\" for manpage-specific macros, see man(7) | |
| 17 | .SH NAME | |
| 18 | acpihelp \- ACPI help utility | |
| 19 | .SH SYNOPSIS | |
| 20 | .B acpihelp | |
| 21 | .RI <option> ... | |
| 22 | .RI [<name-prefix>|<hex-value>] | |
| 23 | ||
| 24 | .SH DESCRIPTION | |
| 25 | This manual page briefly documents the | |
| 26 | .B acpihelp | |
| 27 | command. The option list is taken from the acpihelp interactive help. | |
| 28 | .PP | |
| 29 | .\" TeX users may be more comfortable with the \fB<whatever>\fP and | |
| 30 | .\" \fI<whatever>\fP escape sequences to invode bold face and italics, | |
| 31 | .\" respectively. | |
| 32 | .B acpihelp | |
| 33 | provides descriptive text for AML and ASL keywords, methods, and opcodes. | |
| 34 | .PP | |
| 35 | Much more detailed documentation may be found at | |
| 36 | http://www.acpica.org/documentation/. | |
| 37 | .PP | |
| 38 | If neither a <name-prefix> or a <hex-value> is provided, | |
| 39 | .B acpihelp | |
| 40 | will do the logical equivalent of a "display all." | |
| 41 | .PP | |
| 42 | A default search (that is, a search with no options) and a <name-prefix> | |
| 43 | can mean two different things: (1) if <name-prefix> does not start with | |
| 44 | an underscore, find ASL operator names, or (2) if <name-prefix> does start | |
| 45 | with an underscore, find ASL predefined method names. | |
| 46 | ||
| 47 | .SH OPTIONS | |
| 48 | ||
| 49 | .PP | |
| 50 | .SS ACPI Names and Symbols | |
| 51 | .TP | |
| 52 | .B \-k [<name-prefix>] | |
| 53 | Find/Display ASL non-operator keyword(s) | |
| 54 | .TP | |
| 55 | .B \-m [<name-prefix>] | |
| 56 | Find/Display AML opcode name(s) | |
| 57 | .TP | |
| 58 | .B \-p [<name-prefix>] | |
| 59 | Find/Display ASL predefined method name(s) | |
| 60 | .TP | |
| 61 | .B \-s [<name-prefix>] | |
| 62 | Find/Display ASL operator name(s) | |
| 63 | ||
| 64 | .PP | |
| 65 | .SS ACPI Values | |
| 66 | .TP | |
| 67 | .B \-e [<hex-value>] | |
| 68 | Decode ACPICA exception code | |
| 69 | .TP | |
| 70 | .B \-i | |
| 71 | Display known ACPI Device IDs (_HID) | |
| 72 | .TP | |
| 73 | .B \-i [<hex-value>] | |
| 74 | Decode hex AML opcode | |
| 75 | ||
| 76 | .SH AUTHOR | |
| 77 | acpihelp was written by Robert Moore <robert.moore@intel.com>. | |
| 78 | .PP | |
| 79 | This manual page was written by Al Stone <ahs3@redhat.com> for the | |
| 80 | Fedora project (but may be used by others). |