8c2ae8
.\" First parameter, NAME, should be all caps
8c2ae8
.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
8c2ae8
.\" other parameters are allowed: see man(7), man(1)
8c2ae8
.TH ACPIHELP 1 "January 23, 2013"
8c2ae8
.\" Please adjust this date whenever revising the manpage.
8c2ae8
.\"
8c2ae8
.\" Some roff macros, for reference:
8c2ae8
.\" .nh        disable hyphenation
8c2ae8
.\" .hy        enable hyphenation
8c2ae8
.\" .ad l      left justify
8c2ae8
.\" .ad b      justify to both left and right margins
8c2ae8
.\" .nf        disable filling
8c2ae8
.\" .fi        enable filling
8c2ae8
.\" .br        insert line break
8c2ae8
.\" .sp <n>    insert n+1 empty lines
8c2ae8
.\" for manpage-specific macros, see man(7)
8c2ae8
.SH NAME
8c2ae8
acpihelp \- ACPI help utility
8c2ae8
.SH SYNOPSIS
8c2ae8
.B acpihelp
8c2ae8
.RI <option> ...
8c2ae8
.RI [<name-prefix>|<hex-value>]
8c2ae8
8c2ae8
.SH DESCRIPTION
8c2ae8
This manual page briefly documents the
8c2ae8
.B acpihelp
8c2ae8
command. The option list is taken from the acpihelp interactive help.
8c2ae8
.PP
8c2ae8
.\" TeX users may be more comfortable with the \fB<whatever>\fP and
8c2ae8
.\" \fI<whatever>\fP escape sequences to invode bold face and italics, 
8c2ae8
.\" respectively.
8c2ae8
.B acpihelp
8c2ae8
provides descriptive text for AML and ASL keywords, methods, and opcodes.
8c2ae8
.PP
8c2ae8
Much more detailed documentation may be found at
8c2ae8
http://www.acpica.org/documentation/.
8c2ae8
.PP
8c2ae8
If neither a <name-prefix> or a <hex-value> is provided,
8c2ae8
.B acpihelp
8c2ae8
will do the logical equivalent of a "display all."
8c2ae8
.PP
8c2ae8
A default search (that is, a search with no options) and a <name-prefix>
8c2ae8
can mean two different things: (1) if <name-prefix> does not start with
8c2ae8
an underscore, find ASL operator names, or (2) if <name-prefix> does start
8c2ae8
with an underscore, find ASL predefined method names.
8c2ae8
8c2ae8
.SH OPTIONS
8c2ae8
8c2ae8
.PP
8c2ae8
.SS ACPI Names and Symbols
8c2ae8
.TP
8c2ae8
.B \-k [<name-prefix>]
8c2ae8
Find/Display ASL non-operator keyword(s)
8c2ae8
.TP
8c2ae8
.B \-m [<name-prefix>]
8c2ae8
Find/Display AML opcode name(s)
8c2ae8
.TP
8c2ae8
.B \-p [<name-prefix>]
8c2ae8
Find/Display ASL predefined method name(s)
8c2ae8
.TP
8c2ae8
.B \-s [<name-prefix>]
8c2ae8
Find/Display ASL operator name(s)
8c2ae8
8c2ae8
.PP
8c2ae8
.SS ACPI Values
8c2ae8
.TP
8c2ae8
.B \-e [<hex-value>]
8c2ae8
Decode ACPICA exception code
8c2ae8
.TP
8c2ae8
.B \-i
8c2ae8
Display known ACPI Device IDs (_HID)
8c2ae8
.TP
8c2ae8
.B \-i [<hex-value>]
8c2ae8
Decode hex AML opcode
8c2ae8
8c2ae8
.SH AUTHOR
8c2ae8
acpihelp was written by Robert Moore <robert.moore@intel.com>.
8c2ae8
.PP
8c2ae8
This manual page was written by Al Stone <ahs3@redhat.com> for the
8c2ae8
Fedora project (but may be used by others).