xref: /dragonfly/usr.sbin/acpi/acpihelp/acpihelp.8 (revision db299a73)
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 14, 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 a Op Ar name/prefix
45Find/Display both ASL operator and AML opcode name(s).
46.It Fl e Op Ar hex_value
47Decode ACPICA exception code.
48.It Fl h
49Display help.
50.It Fl i
51Display known ACPI Device IDs (_HID).
52.It Fl k Op Ar name/prefix
53Find/Display ASL non-operator keyword(s).
54.It Fl m Op Ar name/prefix
55Find/Display AML opcode name(s).
56.It Fl o Op Ar hex_value
57Decode hex AML opcode.
58.It Fl p Op Ar name/prefix
59Find/Display ASL predefined method name(s).
60.It Fl s Op Ar name/prefix
61Find/Display ASL operator name(s).
62.It Fl v
63Display version information.
64.El
65.Pp
66If neither
67.Ar name/prefix
68nor
69.Ar hex_value
70are specified
71.Nm
72defaults to displaying all information available for the specified option.
73.Pp
74If a
75.Ar name/prefix
76but no options are specified
77.Nm
78defaults to finding ASL operator names if
79.Ar name/prefix
80does not start with an underscore, and to finding ASL predefined method
81names if
82.Ar name/prefix
83does start with an underscore.
84.Sh SEE ALSO
85.Xr acpi 4 ,
86.Xr acpibin 8 ,
87.Xr acpiconf 8 ,
88.Xr acpidump 8 ,
89.Xr acpiexec 8 ,
90.Xr acpinames 8 ,
91.Xr acpixtract 8 ,
92.Xr iasl 8
93.Pp
94.Lk https://acpica.org/documentation/
95.Sh AUTHORS
96The
97.Nm
98utility is provided by
99.Tn Intel
100as part of their
101.Sy ACPICA
102distribution.
103.Pp
104This manual page was written by
105.An Sascha Wildner .
106