Package: alsa-tools
Version: 1.0.27-2
Severity: normal

Dear Maintainer,

*** Reporter, please consider answering these questions, where appropriate ***

   * What led up to the situation?
   * What exactly did you do (or not do) that was effective (or
     ineffective)?
   * What was the outcome of this action?
   * What outcome did you expect instead?

*** End of the template - remove these template lines ***

Dear Maintainer,

i noticed that the "alsa-tools" package currently distributes 4 cmdline
utilities but only a single manpage.

the following utilities lack manpages:
  /usr/binhda-verb
  /usr/binsbiload
  /usr/binus428control

i've taken the liberty to create manpages for these utilities.
please find them attached (and forward them to upstream if applicable).

fgmasdr
IOhannes m zmölnig

-- System Information:
Debian Release: jessie/sid
  APT prefers unstable
  APT policy: (500, 'unstable'), (500, 'testing')
Architecture: amd64 (x86_64)

Kernel: Linux 3.12-1-amd64 (SMP w/4 CPU cores)
Locale: LANG=en_US.utf8, LC_CTYPE=en_US.utf8 (charmap=UTF-8)
Shell: /bin/sh linked to /bin/dash

Versions of packages alsa-tools depends on:
ii  libasound2  1.0.27.2-3
ii  libc6       2.17-97
ii  libgcc1     1:4.8.2-14
ii  libstdc++6  4.8.2-14

alsa-tools recommends no packages.

alsa-tools suggests no packages.

-- no debconf information
.TH "HDA-VERB" "1" "January 2014" ""

.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.SH "NAME"
hda-verb \- send HD-audio commands to Intel HDA devices

.SH "SYNOPSIS"

.B hda-verb
\fIhwdep\-device\fR \fInid\fR \fIverb\fR \fIparam\fR

.B hda-verb
[\fBoption\fR]


.SH DESCRIPTION
\fBhda-verb\fR is a tiny program that allows you to access the HD-audio
codec of an ALSA device directly (if your ALSA-device has one).
You can execute a raw HD-audio codec \fIverb\fR with this.

The \fBhda-verb\fR program takes four arguments:
the \fIhwdep device\fR file,
the widget \fINID\fR,
the \fIverb\fR,
and the \fIparameter\fR.

When you access to the codec on the slot 2 of the card 0,
pass \fB/dev/snd/hwC0D2\fR to the first argument, typically.
(However, the real path name depends on the system.)
The second parameter is the widget number-id to access.
The third parameter can be either a hex/digit number or a string
corresponding to a verb.
Similarly, the last parameter is the value to write, or can be a string
for the parameter type.


Although you can issue any verbs with this program,
the driver state won't always be updated.
For example, the volume values are usually cached in the driver,
and thus changing the widget amp value directly via \fBhda-verb\fR
won't change the mixer value.


\fBhda-verb\fR is mainly useful for debugging audio drivers.
Mere mortals most likely won't need it.

.SH "OPTIONS"
.HP
\fB-l\fR  \- List known verbs and parameters
.HP
\fB-L\fR  \- List known verbs and parameters (one per line)

.SH "EXAMPLES"

A simple low-level example:

.in +4n
.nf
% hda-verb /dev/snd/hwC0D0 0x12 0x701 2
nid = 0x12, verb = 0x701, param = 0x2
value = 0x0
.fi
.in

The verb argument can be a string like \fBPARAMETERS\fR.
Also the parameter argument can be a string like \fBVENDOR_ID\fR as well:

.in +4n
.nf
% hda-verb /dev/snd/hwC0D0 0x0 PARAMETERS VENDOR_ID
nid = 0x0, verb = 0xf00, param = 0x0
value = 0x10ec0262
.fi
.in

The string is case insensitive.
Also, it doesn't have to be the full string but only has to be unique.
E.g. \fBpar\fR is enough to mean \fBPARAMETER\fR,
and \fBset_a\fR is enough as \fBSET_AMP_GAIN_MUTE\fR:

.in +4n
.nf
% hda-verb /dev/snd/hwC0D0 2 set_a 0xb080
nid = 0x2, verb = 0x300, param = 0xb080
value = 0x0
.fi
.in

.SH "NOTES"
Use this program carefully.  Sending an invalid verb may screw up the
codec communication, which requires either a reboot or reloading of
the sound driver eventually.

.P
Usually you need to be \fBroot\fR to run this command.

.P
This program accesses the hwdep device, thus you need to enable the
kernel config \fBCONFIG_SND_HDA_HWDEP=y\fR beforehand.
Stock Debian kernels have this option enabled by default.

.SH "AUTHORS"
.PP
This manual page was written by IOhannes m zmölnig
<zmoel...@iem.at>
for the
Debian
system (but may be used by others), and is based on \fBhda-verb\fR's \fIREADME\fR.
Permission is granted to copy, distribute and/or modify this document under the terms of the
GNU
General Public License, Version 2 or any later version published by the Free Software Foundation.
.PP
On Debian systems, the complete text of the GNU General Public License can be found in /usr/share/common\-licenses/GPL.
.TH "SBILOAD" "1" "January 2014" ""

.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.SH "NAME"
sbiload \- OPL2/3 FM instrument loader for the ALSA sequencer
.SH "SYNOPSIS"

.B sbiload
[\fBoption\fR...] [\fIinstfile\fR [\fIdrumfile\fR]]

.B sbiload
[\fBoption\fR...] \fB-c\fR

.SH "DESCRIPTION"
.PP
This manual page documents briefly the
\fBsbiload\fR
command.
\fBsbiload\fR loads OPL2/3 FM instrument patches into hardware synth devices.


.SH "OPTIONS"
.HP
\fB\-D\fR, \fB\-\-device\fR=\fIname\fR     \- hwdep device string
.HP
\fB\-c\fR, \fB\-\-clear\fR           \- Clear patches and exit
.HP
\fB\-2\fR, \fB\-\-opl2\fR            \- two operators file type (OPL2)
.HP
\fB\-4\fR, \fB\-\-opl3\fR            \- four operators file type (OPL3)
.TP
\fB\-P\fR, \fB\-\-path\fR=\fIpath\fR       \- Specify the patch path
(default path: \fI/usr/share/sounds/opl3\fP)
.HP
\fB\-v\fR, \fB\-\-verbose\fR=\fIlevel\fR   \- Verbose level (default = 0)
.HP
\fB\-q\fR, \fB\-\-quiet\fR           \- Be quiet, no error/warning messages
.HP
\fB\-V\fR, \fB\-\-version\fR         \- Show version

.SH "USAGE"

Pass the instrument and drum file data as arguments:

.in +4n
.nf
% \fBsbiload\fR std.o3 drums.o3
.fi
.in

Without a file type option (\fB-2\fR or \fB-4\fR),
\fBsbiload\fR will guess the file type according to the \fBhwdep interface\fR type.
If it's not correct, pass \fB-2\fR or \fB-4\fR option explicitly.
Also, when the given file isn't found, \fBsbiload\fR tries to load a file
with an appropriate extension, \fI.sb\fR for OPL2 and \fI.o3\fR for OPL3.

You can omit the instrument and the drum file names, too.  In this
case, the default file name "\fBstd\fR" and "\fBdrums\fR" are chosen.

The option \fB-c\fR clears patches and exits without loading patches.

.SH "DEVICE NAMES"
When you have multiple sound cards and/or there are multiple OPL2/3
synth devices, you have to tell \fBsbiload\fR which one to use, and pass
its \fIhwdep\fR name via \fB-D\fR option.
Otherwise, \fBsbiload\fR will load the data onto the first found device.

To find out the hwdep name of the OPL devices, check
.I /proc/asound/hwdep
file first, as it has the list of \fIhwdep devices\fR
currently available on your system:

.in +4n
.nf
% cat /proc/asound/hwdep
00-00: Emux WaveTable
00-01: OPL3 FM
01-00: OPL3 FM
.fi
.in

In the example above, you have two \fIOPL3\fR devices.
To the first one (\fB00-01\fR),
which means the first card (\fB00-\fR) and the second device (\fB01\fR),
pass \fB-D hw:0,1\fR.
For the second \fIOPL3\fR device (\fB01-00\fR), pass \fB-D hw:1,0\fR instead.

For convenience, \fB-D\fR option accepts a string like \fI/dev/snd/hwC0D3\fR.
This is automatically parsed as \fBhw:0,3\fR.

.SH "AUTHORS"
.PP
This manual page was written by IOhannes m zmölnig
<zmoel...@iem.at>
for the
Debian
system (but may be used by others), and is based on \fBsbiload\fR's
\fIREADME\fR by Uros Bizja.
Permission is granted to copy, distribute and/or modify this document under the terms of the
GNU
General Public License, Version 2 or any later version published by the Free Software Foundation.
.PP
On Debian systems, the complete text of the GNU General Public License can be found in /usr/share/common\-licenses/GPL.
.TH "US428CONTROL" "1" "January 2014" ""

.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.SH "NAME"
us428control \- Controller utility for Tascam US-X2Y

.SH DESCRIPTION
\fBus428control\fR manages the physical controls on your Tascam US-224 and US-428.

You might have to run this program, in order to be able to hear anything
from the card,
because it is muted by default and there are no software mixers on the board.
The only way to raise the volume is through the knobs and faders,
and they are non functional until \fBus428control\fR is running.

.SH "OPTIONS"
.HP
\fB-v\fR \fIlevel\fR        \- verbosity level (\fB0\fR, \fB1\fR or \fB2\fR)
.HP
\fB-c\fR \fIcard\fR         \- sound card
.HP
\fB-D\fR \fIdevice\fR       \- device
.HP
\fB-u\fR \fIusb_device\fR   \- USB\-device
.HP
\fB-m\fR \fImode\fR         \- device mode (\fBus224\fR, \fBus428\fR or \fBmixxx\fR)

.SH "NOTES"

It's recommend to launch this program in the background,
so that it won't block your console while it is running:

.in +4n
.nf
% \fBus428control\fR &
.fi
.in



.SH "AUTHORS"
.PP
This manual page was written by IOhannes m zmölnig
<zmoel...@iem.at>
for the
Debian
system (but may be used by others).
Permission is granted to copy, distribute and/or modify this document under the terms of the
GNU
General Public License, Version 2 or any later version published by the Free Software Foundation.
.PP
On Debian systems, the complete text of the GNU General Public License can be found in /usr/share/common\-licenses/GPL.

Reply via email to