xref: /dragonfly/usr.sbin/acpi/acpihelp/acpihelp.8 (revision 61c0377f)
1.\"
2.\" Copyright (c) 2014 The DragonFly Project.  All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\"
8.\" 1. Redistributions of source code must retain the above copyright
9.\"    notice, this list of conditions and the following disclaimer.
10.\" 2. Redistributions in binary form must reproduce the above copyright
11.\"    notice, this list of conditions and the following disclaimer in
12.\"    the documentation and/or other materials provided with the
13.\"    distribution.
14.\" 3. Neither the name of The DragonFly Project nor the names of its
15.\"    contributors may be used to endorse or promote products derived
16.\"    from this software without specific, prior written permission.
17.\"
18.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20.\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
21.\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE
22.\" COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
23.\" INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
24.\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
25.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
26.\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
27.\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
28.\" OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29.\" SUCH DAMAGE.
30.\"
31.Dd April 10, 2014
32.Dt ACPIHELP 8
33.Os
34.Sh NAME
35.Nm acpihelp
36.Nd help utility for ASL operators, AML opcodes, and ACPI predefined names
37.Sh SYNOPSIS
38.Nm
39.Op Ar option ...
40.Op Ar name_prefix | hex_value
41.Sh DESCRIPTION
42The following options are supported:
43.Bl -tag -width indent
44.It Fl e Op Ar hex_value
45Decode ACPICA exception code.
46.It Fl h
47Display help.
48.It Fl i
49Display known ACPI Device IDs (_HID).
50.It Fl k Op Ar name_prefix
51Find/Display ASL non-operator keyword(s).
52.It Fl m Op Ar name_prefix
53Find/Display AML opcode name(s).
54.It Fl o Op Ar hex_value
55Decode hex AML opcode.
56.It Fl p Op Ar name_prefix
57Find/Display ASL predefined method name(s).
58.It Fl s Op Ar name_prefix
59Find/Display ASL operator name(s).
60.It Fl v
61Display version information.
62.El
63.Pp
64If neither
65.Ar name_prefix
66nor
67.Ar hex_value
68are specified
69.Nm
70defaults to displaying all information available for the specified option.
71.Pp
72If a
73.Ar name_prefix
74but no options are specified
75.Nm
76defaults to finding ASL operator names if
77.Ar name_prefix
78does not start with an underscore, and to finding ASL predefined method
79names if
80.Ar name_prefix
81does start with an underscore.
82.Sh SEE ALSO
83.Xr acpi 4 ,
84.Xr acpibin 8 ,
85.Xr acpiconf 8 ,
86.Xr acpidump 8 ,
87.Xr acpiexec 8 ,
88.Xr acpinames 8 ,
89.Xr acpixtract 8 ,
90.Xr iasl 8
91.Pp
92.Lk https://acpica.org/documentation/
93.Sh AUTHORS
94The
95.Nm
96utility is provided by
97.Tn Intel
98as part of their
99.Sy ACPICA
100distribution.
101.Pp
102This manual page was written by
103.An Sascha Wildner .
104