Blame iecset/iecset.1

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