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