Blame SOURCES/acpihelp.1

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