Blame axfer/axfer.1

Packit Service a9274b
.TH AXFER 1 "28 November 2018" "alsa\-utils"
Packit Service a9274b
Packit Service a9274b
.SH NAME
Packit Service a9274b
axfer \- command\-line sound recorder and player for sound devices and nodes
Packit Service a9274b
supported by Linux sound subsystem (Advanced Linux Sound Architecture, also
Packit Service a9274b
known as ALSA).
Packit Service a9274b
Packit Service a9274b
.SH SYNOPSYS
Packit Service a9274b
Packit Service a9274b
.B axfer
Packit Service a9274b
.I subcommand direction options
Packit Service a9274b
Packit Service a9274b
subcommand =
Packit Service a9274b
.B transfer
Packit Service a9274b
|
Packit Service a9274b
.B list
Packit Service a9274b
|
Packit Service a9274b
.B version
Packit Service a9274b
|
Packit Service a9274b
.B help
Packit Service a9274b
Packit Service a9274b
direction =
Packit Service a9274b
.B capture
Packit Service a9274b
|
Packit Service a9274b
.B playback
Packit Service a9274b
Packit Service a9274b
options = ( depends on
Packit Service a9274b
.I subcommand
Packit Service a9274b
)
Packit Service a9274b
Packit Service a9274b
.SH DESCRIPTION
Packit Service a9274b
The
Packit Service a9274b
.B axfer
Packit Service a9274b
is a command\-line recorder and player to transfer audio data frame between
Packit Service a9274b
sound devices/nodes and files/stdin/stdout.
Packit Service a9274b
Packit Service a9274b
.SH OPTIONS
Packit Service a9274b
Packit Service a9274b
.SS Subcommand
Packit Service a9274b
Packit Service a9274b
.TP
Packit Service a9274b
.B transfer
Packit Service a9274b
Performs transmission of audio data frame. Its detail is described in
Packit Service a9274b
.B axfer\-transfer(1)
Packit Service a9274b
manual.
Packit Service a9274b
Packit Service a9274b
.TP
Packit Service a9274b
.B list
Packit Service a9274b
Dumps lists of available sound devices and nodes. Its detail is described in
Packit Service a9274b
.B axfer\-list(1)
Packit Service a9274b
manual.
Packit Service a9274b
Packit Service a9274b
.TP
Packit Service a9274b
.B version
Packit Service a9274b
Prints version of this application (as the same version as alsa\-utils package).
Packit Service a9274b
Packit Service a9274b
.TP
Packit Service a9274b
.B help
Packit Service a9274b
Prints a short message about subcommands for users to enter this application.
Packit Service a9274b
Packit Service a9274b
.SS Direction
Packit Service a9274b
Packit Service a9274b
.TP
Packit Service a9274b
.B capture
Packit Service a9274b
Operates for capture transmission.
Packit Service a9274b
Packit Service a9274b
.TP
Packit Service a9274b
.B playback
Packit Service a9274b
Operates for playback transmission.
Packit Service a9274b
Packit Service a9274b
.SH EXIT STATUS
Packit Service a9274b
Packit Service a9274b
.I EXIT_SUCCESS
Packit Service a9274b
(0) if run time successfully finished, else
Packit Service a9274b
.I EXIT_FAILURE
Packit Service a9274b
(1).
Packit Service a9274b
Packit Service a9274b
.SH UNIT TEST
Packit Service a9274b
Packit Service a9274b
This program has unit tests for internal implementation. Please refer to the
Packit Service a9274b
manual of
Packit Service a9274b
.I axfer-transfer
Packit Service a9274b
for details.
Packit Service a9274b
Packit Service a9274b
.SH COMPATIBILITY TO APLAY
Packit Service a9274b
Packit Service a9274b
The
Packit Service a9274b
.I axfer
Packit Service a9274b
is designed to be compatible to aplay(1) as much as possible. In command line,
Packit Service a9274b
executions of aplay/arecord files under $PATH runs axfer with compatibility
Packit Service a9274b
mode if filesystem has symbolic link from the aplay/arecord to axfer.
Packit Service a9274b
Packit Service a9274b
.PP
Packit Service a9274b
.in +4n
Packit Service a9274b
.EX
Packit Service a9274b
$ ln \-s aplay axfer
Packit Service a9274b
$ ln \-s arecord axfer
Packit Service a9274b
.EE
Packit Service a9274b
.in
Packit Service a9274b
.PP
Packit Service a9274b
Packit Service a9274b
.SS A string to which arg[0] points
Packit Service a9274b
When args[0] in run time points to string ended with \(aqaplay\(aq, it has the
Packit Service a9274b
same meaning of
Packit Service a9274b
.I playback
Packit Service a9274b
direction. When it points to string ended with \(aqarecord\(aq, it has the same
Packit Service a9274b
meaning of
Packit Service a9274b
.I capture
Packit Service a9274b
direction.
Packit Service a9274b
Packit Service a9274b
.SS Options acknowledged as list subcommand
Packit Service a9274b
Options of
Packit Service a9274b
.I \-l
Packit Service a9274b
,
Packit Service a9274b
.I \-\-list\-devices
Packit Service a9274b
,
Packit Service a9274b
.I \-L
Packit Service a9274b
,
Packit Service a9274b
.I \-\-list\-pcms
Packit Service a9274b
are acknowledged as
Packit Service a9274b
.I list
Packit Service a9274b
subcommand. Without them, the run time performs
Packit Service a9274b
.I transfer
Packit Service a9274b
subcommand.
Packit Service a9274b
Packit Service a9274b
.SH REPORTING BUGS
Packit Service a9274b
Report any bugs to mailing list of ALSA community
Packit Service a9274b
<alsa\-devel@alsa\-project.org> where the development and maintenance is
Packit Service a9274b
primarily done. Bug tracking service of alsa\-utils repository on github.com is
Packit Service a9274b
also available.
Packit Service a9274b
Packit Service a9274b
.SH SEE ALSO
Packit Service a9274b
.B axfer\-transfer(1),
Packit Service a9274b
.B axfer\-list(1),
Packit Service a9274b
.B alsamixer(1),
Packit Service a9274b
.B amixer(1)
Packit Service a9274b
Packit Service a9274b
.SH AUTHOR
Packit Service a9274b
Takashi Sakamoto <o\-takashi@sakamocchi.jp>