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