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