Blame SOURCES/acpihelp.1

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