man-pages/man1/axfer.1.html
2021-03-31 01:06:50 +01:00

246 lines
4.8 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML><HEAD><TITLE>Man page of AXFER</TITLE>
</HEAD><BODY>
<H1>AXFER</H1>
Section: User Commands (1)<BR>Updated: 28 November 2018<BR><A HREF="#index">Index</A>
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
<P>
<A NAME="lbAB">&nbsp;</A>
<H2>NAME</H2>
axfer - command-line sound recorder and player for sound devices and nodes
supported by Linux sound subsystem (Advanced Linux Sound Architecture, also
known as ALSA).
<P>
<A NAME="lbAC">&nbsp;</A>
<H2>SYNOPSYS</H2>
<P>
<B>axfer</B>
<I>subcommand direction options</I>
<P>
subcommand =
<B>transfer</B>
|
<B>list</B>
|
<B>version</B>
|
<B>help</B>
<P>
direction =
<B>capture</B>
|
<B>playback</B>
<P>
options = ( depends on
<I>subcommand</I>
)
<P>
<A NAME="lbAD">&nbsp;</A>
<H2>DESCRIPTION</H2>
The
<B>axfer</B>
is a command-line recorder and player to transfer audio data frame between
sound devices/nodes and files/stdin/stdout.
<P>
<A NAME="lbAE">&nbsp;</A>
<H2>OPTIONS</H2>
<P>
<A NAME="lbAF">&nbsp;</A>
<H3>Subcommand</H3>
<P>
<DL COMPACT>
<DT id="1"><B>transfer</B>
<DD>
Performs transmission of audio data frame. Its detail is described in
<B><A HREF="/cgi-bin/man/man2html?1+axfer-transfer">axfer-transfer</A>(1)</B>
manual.
<P>
<DT id="2"><B>list</B>
<DD>
Dumps lists of available sound devices and nodes. Its detail is described in
<B><A HREF="/cgi-bin/man/man2html?1+axfer-list">axfer-list</A>(1)</B>
manual.
<P>
<DT id="3"><B>version</B>
<DD>
Prints version of this application (as the same version as alsa-utils package).
<P>
<DT id="4"><B>help</B>
<DD>
Prints a short message about subcommands for users to enter this application.
<P>
</DL>
<A NAME="lbAG">&nbsp;</A>
<H3>Direction</H3>
<P>
<DL COMPACT>
<DT id="5"><B>capture</B>
<DD>
Operates for capture transmission.
<P>
<DT id="6"><B>playback</B>
<DD>
Operates for playback transmission.
<P>
</DL>
<A NAME="lbAH">&nbsp;</A>
<H2>EXIT STATUS</H2>
<P>
<I>EXIT_SUCCESS</I>
(0) if run time successfully finished, else
<I>EXIT_FAILURE</I>
(1).
<P>
<A NAME="lbAI">&nbsp;</A>
<H2>UNIT TEST</H2>
<P>
This program has unit tests for internal implementation. Please refer to the
manual of
<I>axfer-transfer</I>
for details.
<P>
<A NAME="lbAJ">&nbsp;</A>
<H2>COMPATIBILITY TO APLAY</H2>
<P>
The
<I>axfer</I>
is designed to be compatible to <A HREF="/cgi-bin/man/man2html?1+aplay">aplay</A>(1) as much as possible. In command line,
executions of aplay/arecord files under $PATH runs axfer with compatibility
mode if filesystem has symbolic link from the aplay/arecord to axfer.
<P>
<P>
$ ln -s aplay axfer
$ ln -s arecord axfer
<P>
<P>
<A NAME="lbAK">&nbsp;</A>
<H3>A string to which arg[0] points</H3>
When args[0] in run time points to string ended with 'aplay', it has the
same meaning of
<I>playback</I>
direction. When it points to string ended with 'arecord', it has the same
meaning of
<I>capture</I>
direction.
<P>
<A NAME="lbAL">&nbsp;</A>
<H3>Options acknowledged as list subcommand</H3>
Options of
<I>-l</I>
,
<I>--list-devices</I>
,
<I>-L</I>
,
<I>--list-pcms</I>
are acknowledged as
<I>list</I>
subcommand. Without them, the run time performs
<I>transfer</I>
subcommand.
<P>
<A NAME="lbAM">&nbsp;</A>
<H2>REPORTING BUGS</H2>
Report any bugs to mailing list of ALSA community
&lt;<A HREF="mailto:alsa-devel@alsa-project.org">alsa-devel@alsa-project.org</A>&gt; where the development and maintenance is
primarily done. Bug tracking service of alsa-utils repository on github.com is
also available.
<P>
<A NAME="lbAN">&nbsp;</A>
<H2>SEE ALSO</H2>
<B><A HREF="/cgi-bin/man/man2html?1+axfer-transfer">axfer-transfer</A>(1),</B>
<B><A HREF="/cgi-bin/man/man2html?1+axfer-list">axfer-list</A>(1),</B>
<B><A HREF="/cgi-bin/man/man2html?1+alsamixer">alsamixer</A>(1),</B>
<B><A HREF="/cgi-bin/man/man2html?1+amixer">amixer</A>(1)</B>
<P>
<A NAME="lbAO">&nbsp;</A>
<H2>AUTHOR</H2>
Takashi Sakamoto &lt;<A HREF="mailto:o-takashi@sakamocchi.jp">o-takashi@sakamocchi.jp</A>&gt;
<P>
<HR>
<A NAME="index">&nbsp;</A><H2>Index</H2>
<DL>
<DT id="7"><A HREF="#lbAB">NAME</A><DD>
<DT id="8"><A HREF="#lbAC">SYNOPSYS</A><DD>
<DT id="9"><A HREF="#lbAD">DESCRIPTION</A><DD>
<DT id="10"><A HREF="#lbAE">OPTIONS</A><DD>
<DL>
<DT id="11"><A HREF="#lbAF">Subcommand</A><DD>
<DT id="12"><A HREF="#lbAG">Direction</A><DD>
</DL>
<DT id="13"><A HREF="#lbAH">EXIT STATUS</A><DD>
<DT id="14"><A HREF="#lbAI">UNIT TEST</A><DD>
<DT id="15"><A HREF="#lbAJ">COMPATIBILITY TO APLAY</A><DD>
<DL>
<DT id="16"><A HREF="#lbAK">A string to which arg[0] points</A><DD>
<DT id="17"><A HREF="#lbAL">Options acknowledged as list subcommand</A><DD>
</DL>
<DT id="18"><A HREF="#lbAM">REPORTING BUGS</A><DD>
<DT id="19"><A HREF="#lbAN">SEE ALSO</A><DD>
<DT id="20"><A HREF="#lbAO">AUTHOR</A><DD>
</DL>
<HR>
This document was created by
<A HREF="/cgi-bin/man/man2html">man2html</A>,
using the manual pages.<BR>
Time: 00:05:07 GMT, March 31, 2021
</BODY>
</HTML>