usr.sbin/hdaudioctl/hdaudioctl.8

   1 .\"     $NetBSD: hdaudioctl.8,v 1.1 2009/10/11 08:57:54 sborrill Exp $
   2 .\"
   3 .\" Copyright (c) 2009 Precedence Technologies Ltd <support@precedence.co.uk>
   4 .\" All rights reserved.
   5 .\"
   6 .\" This code is derived from software contributed to The NetBSD Foundation
   7 .\" by Precedence Technologies Ltd
   8 .\"
   9 .\" Redistribution and use in source and binary forms, with or without
  10 .\" modification, are permitted provided that the following conditions
  11 .\" are met:
  12 .\" 1. Redistributions of source code must retain the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer.
  14 .\" 2. Redistributions in binary form must reproduce the above copyright
  15 .\"    notice, this list of conditions and the following disclaimer in the
  16 .\"    documentation and/or other materials provided with the distribution.
  17 .\"
  18 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  19 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  20 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  21 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  22 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  23 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  24 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  25 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  26 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  27 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  28 .\" POSSIBILITY OF SUCH DAMAGE.
  29 .\"
  30 .Dd October 6, 2009
  31 .Dt HDAUDIOCTL 8
  32 .Os
  33 .Sh NAME
  34 .Nm hdaudioctl
  35 .Nd program to manipulate
  36 .Xr hdaudio 4
  37 devices.
  38 .Sh SYNOPSIS
  39 .Nm hdaudioctl
  40 .Op Ar -f device
  41 .Ar command
  42 .Op Ar arguments
  43 .Sh DESCRIPTION
  44 The
  45 .Nm
  46 command can be used to inspect and reconfigure High Definition Audio devices
  47 and their child codecs.
  48 .Pp
  49 The mandatory
  50 .Ar command
  51 argument specifies the action to take.
  52 Valid commands are:
  53 .Bl -tag -width XgetXcodecidXnidX
  54 .It list
  55 For each child codec of the chosen
  56 .Xr hdaudio 4
  57 device, display the nid, vendor, product, subsystem and device IDs.
  58 .It get Ar codecid Ar nid
  59 Retrieve and display the current codec configuration as a
  60 .Xr proplib 3
  61 XML plist.
  62 .It set Ar codecid Ar nid Op Ar plist
  63 Detach the specified
  64 .Xr hdafg 4
  65 codec and then re-attach with its widgets explicitly configured according to
  66 the specified plist.
  67 If no plist is given, the in-built widget parsing rules based on the High
  68 Definition Audio specification will be used.
  69 .It graph Ar codecid Ar nid
  70 Output a DOT file suitable processing by graphviz.
  71 The resulting image will graphically show the structure and interconnections
  72 of the widgets that form the chosen
  73 .Xr hdafg 4
  74 codec.
  75 .El
  76 .Sh FILES
  77 .Bl -tag -width /dev/hdaudioX -compact
  78 .It Pa /dev/hdaudioX
  79 control devices
  80 .El
  81 .Sh SEE ALSO
  82 .Xr audio 4 ,
  83 .Xr hdaudio 4 ,
  84 .Pa pkgsrc/graphics/graphviz
  85 .Sh HISTORY
  86 The
  87 .Nm
  88 command first appeared in
  89 .Nx 5.1 .
  90 .Sh AUTHORS
  91 .Nm
  92 is based on two separate programs written by
  93 .An Jared McNeill Aq jmcneill@NetBSD.org
  94 under contract by
  95 .An Precedence Technologies Ltd Aq http://www.precedence.co.uk/ .
  96 Integration into one program and writing this manual page was done by
  97 .An Stephen Borrill Aq sborrill@NetBSD.org .
  98 .Sh CAVEATS
  99 When a plist is loaded and the
 100 .Xr hdafg 4
 101 codec reattaches, all mixer controls will be returned to their default values.