Blame SOURCES/acpihelp.1

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