Blame SOURCES/acpihelp.1

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