Blame iecset/iecset.1

Packit 229ac0
.TH iecset 1 "23 Oct 2003"
Packit 229ac0
.SH NAME
Packit 229ac0
iecset \- Set or dump IEC958 status bits
Packit 229ac0
Packit 229ac0
.SH SYNOPSIS
Packit 229ac0
\fBiecset\fP [\fIoptions\fP] [\fIcmd\fP \fIarg\fP...]
Packit 229ac0
Packit 229ac0
.SH DESCRIPTION
Packit 229ac0
\fBiecset\fP is a small utility to set or dump the IEC958 (or so-called
Packit 229ac0
"S/PDIF") status bits of the specified sound card via ALSA control API.
Packit 229ac0
Packit 229ac0
When \fBiecset\fP is started without arguments except for options,
Packit 229ac0
it will show the current IEC958 status in a human-readable form.
Packit 229ac0
When the commands are given in the arguments, they are parsed
Packit 229ac0
and the IEC958 status bits are updated.  The resultant status is
Packit 229ac0
shown as well.
Packit 229ac0
Packit 229ac0
The commands consist of the command directive and the argument.
Packit 229ac0
As the boolean argument, \fIyes\fP, \fIno\fP, \fItrue\fP, \fIfalse\fP,
Packit 229ac0
or a digit number is allowed.
Packit 229ac0
Packit 229ac0
.SH EXAMPLES
Packit 229ac0
.TP
Packit 229ac0
.BI iecset\ \-Dhw:1
Packit 229ac0
Displays the current IEC958 status bits on the second card.
Packit 229ac0
This is equivalent with \fI\-c 1\fP.
Packit 229ac0
.TP
Packit 229ac0
.BI iecset\ \-x
Packit 229ac0
Displays the current IEC958 status bits in a style of the arguments
Packit 229ac0
for the PCM stream.  The output string can be passed to the \fIiec958\fP
Packit 229ac0
(or \fIspdif\fP) PCM type as the optional argument.
Packit 229ac0
.TP
Packit 229ac0
.BI iecset\ pro\ off\ audio\ off
Packit 229ac0
Sets the current status to the consumer-mode and turns on the
Packit 229ac0
non-audio bit.  The modified status will be shown, too.
Packit 229ac0
Packit 229ac0
.SH OPTIONS
Packit 229ac0
.TP
Packit 229ac0
\fI\-D\fP device
Packit 229ac0
Specifies the device name of the control to open
Packit 229ac0
.TP
Packit 229ac0
\fI\-c\fP card
Packit 229ac0
Specifies the card index to open.  Equivalent with \fI\-Dhw:x\fP.
Packit 229ac0
.TP
Packit 229ac0
\fI\-n\fP index
Packit 229ac0
Specifies the IEC958 control element index, in case you have multiple
Packit 229ac0
IEC958 devices and need to choose one of them.
Packit 229ac0
.TP
Packit 229ac0
\fI\-x\fP
Packit 229ac0
Dumps the status in the form of AESx bytes.
Packit 229ac0
.TP
Packit 229ac0
\fI\-i\fP
Packit 229ac0
Reads the command sequences from stdin.
Packit 229ac0
Each line has single command.
Packit 229ac0
Packit 229ac0
.SH COMMANDS
Packit 229ac0
.TP
Packit 229ac0
\fIprofessional\fP <bool>
Packit 229ac0
The professional mode (true) or consumer mode (false).
Packit 229ac0
Packit 229ac0
.TP
Packit 229ac0
\fIaudio\fP <bool>
Packit 229ac0
The audio mode (true) or non-audio mode (false).
Packit 229ac0
Packit 229ac0
.TP
Packit 229ac0
\fIrate\fP <int>
Packit 229ac0
The sample rate in Hz.
Packit 229ac0
Packit 229ac0
.TP
Packit 229ac0
\fIemphasis\fP <int>
Packit 229ac0
The emphasis: 0 = none, 1 = 50/15us, 2 = CCITT.
Packit 229ac0
Packit 229ac0
.TP
Packit 229ac0
\fIlock\fP <bool>
Packit 229ac0
Rate lock: locked (true), unlocked (false).
Packit 229ac0
This command is for the professional mode only.
Packit 229ac0
Packit 229ac0
.TP
Packit 229ac0
\fIsbits\fP <int>
Packit 229ac0
Sample bits:  2 = 20bit, 4 = 24bit, 6 = undefined.
Packit 229ac0
This command is for the professional mode only.
Packit 229ac0
Packit 229ac0
.TP
Packit 229ac0
\fIwordlength\fP <int>
Packit 229ac0
Wordlength: 0 = No, 2 = 22-18 bit, 4 = 23-19 bit, 5 = 24-20 bit, 6 = 20-16 bit.
Packit 229ac0
This command is for the professional mode only.
Packit 229ac0
Packit 229ac0
.TP
Packit 229ac0
\fIcategory\fP <int>
Packit 229ac0
Category: the value is from 0 to 0x7f.
Packit 229ac0
This command is for the consumer mode only.
Packit 229ac0
Packit 229ac0
.TP
Packit 229ac0
\fIcopyright\fP <bool>
Packit 229ac0
Copyright: copyrighted (true), non-copyrighted (false).
Packit 229ac0
This command is for the consumer mode only.
Packit 229ac0
Packit 229ac0
.TP
Packit 229ac0
\fIoriginal\fP <boo>
Packit 229ac0
Original flag: original (true), 1st generation (false).
Packit 229ac0
This command is for the consumer mode only.
Packit 229ac0
Packit 229ac0
.SH AUTHOR
Packit 229ac0
Takashi Iwai <tiwai@suse.de>