usr.sbin/acpi/acpihelp/acpihelp.8

   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 May 11, 2018
  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
  42 The following options are supported:
  43 .Bl -tag -width indent
  44 .It Fl a Op Ar name/prefix | *
  45 Display both ASL operator and AML opcode name(s).
  46 .It Fl d
  47 Display iASL Preprocessor directives.
  48 .It Fl e Op Ar hex_value
  49 Decode ACPICA exception code.
  50 .It Fl g Op Ar name/prefix | *
  51 Display AML grammar element(s).
  52 .It Fl h
  53 Display help.
  54 .It Fl i Op Ar name/prefix | *
  55 Display ACPI/PNP Hardware ID(s).
  56 .It Fl k Op Ar name/prefix | *
  57 Display ASL non-operator keyword(s).
  58 .It Fl m Op Ar name/prefix | *
  59 Display AML opcode name(s).
  60 .It Fl o Op Ar hex_value
  61 Decode hex AML opcode.
  62 .It Fl p Op Ar name/prefix | *
  63 Display ASL predefined method name(s).
  64 .It Fl s Op Ar name/prefix | *
  65 Display ASL operator name(s).
  66 .It Fl t
  67 Display supported ACPI tables.
  68 .It Fl u
  69 Display ACPI-related UUIDs.
  70 .It Fl v
  71 Display version information.
  72 .It Fl vd
  73 Display build date and time.
  74 .El
  75 .Pp
  76 If neither
  77 .Ar name/prefix
  78 nor
  79 .Ar hex_value
  80 are specified
  81 .Nm
  82 defaults to displaying all information available for the specified option.
  83 .Pp
  84 If a
  85 .Ar name/prefix
  86 but no options are specified
  87 .Nm
  88 defaults to finding ASL operator names if
  89 .Ar name/prefix
  90 does not start with an underscore, and to finding ASL predefined method
  91 names if
  92 .Ar name/prefix
  93 does start with an underscore.
  94 .Sh SEE ALSO
  95 .Xr acpi 4 ,
  96 .Xr acpibin 8 ,
  97 .Xr acpicall 8 ,
  98 .Xr acpiconf 8 ,
  99 .Xr acpidump 8 ,
 100 .Xr acpiexec 8 ,
 101 .Xr acpinames 8 ,
 102 .Xr acpixtract 8 ,
 103 .Xr iasl 8
 104 .Pp
 105 .Lk https://acpica.org/documentation/
 106 .Sh AUTHORS
 107 The
 108 .Nm
 109 utility is provided by
 110 .Tn Intel
 111 as part of their
 112 .Sy ACPICA
 113 distribution.
 114 .Pp
 115 This manual page was written by
 116 .An Sascha Wildner .