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