mirror of
https://github.com/alsa-project/alsa-utils
synced 2024-11-14 05:35:42 +01:00
axfer: add a manual for entry point
This commit adds a manual for axfer(1). This command is an entry point to supported subcommand. I note that axfer(1) has renewed option system against aplay(1). The command get positional two options for subcommand and direction. In short: $ axfer transfer capture|playback [options for transfer subcommand] $ axfer list capture|playback [options for list subcommand] $ axfer version $ axfer help Manuals to subcommands are added later separately. Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp> Signed-off-by: Takashi Iwai <tiwai@suse.de>
This commit is contained in:
parent
bae5761d72
commit
c5b2beebfd
2 changed files with 97 additions and 0 deletions
|
@ -1,6 +1,9 @@
|
||||||
bin_PROGRAMS = \
|
bin_PROGRAMS = \
|
||||||
axfer
|
axfer
|
||||||
|
|
||||||
|
man_MANS = \
|
||||||
|
axfer.1
|
||||||
|
|
||||||
# To include headers for gettext and version.
|
# To include headers for gettext and version.
|
||||||
AM_CPPFLAGS = \
|
AM_CPPFLAGS = \
|
||||||
-I$(top_srcdir)/include
|
-I$(top_srcdir)/include
|
||||||
|
@ -60,3 +63,6 @@ if HAVE_FFADO
|
||||||
axfer_SOURCES += xfer-libffado.c
|
axfer_SOURCES += xfer-libffado.c
|
||||||
LDADD += -lffado
|
LDADD += -lffado
|
||||||
endif
|
endif
|
||||||
|
|
||||||
|
EXTRA_DIST = \
|
||||||
|
axfer.1
|
||||||
|
|
91
axfer/axfer.1
Normal file
91
axfer/axfer.1
Normal file
|
@ -0,0 +1,91 @@
|
||||||
|
.TH AXFER 1 "28 November 2018" "alsa\-utils"
|
||||||
|
|
||||||
|
.SH NAME
|
||||||
|
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).
|
||||||
|
|
||||||
|
.SH SYNOPSYS
|
||||||
|
|
||||||
|
.B axfer
|
||||||
|
.I subcommand direction options
|
||||||
|
|
||||||
|
subcommand =
|
||||||
|
.B transfer
|
||||||
|
|
|
||||||
|
.B list
|
||||||
|
|
|
||||||
|
.B version
|
||||||
|
|
|
||||||
|
.B help
|
||||||
|
|
||||||
|
direction =
|
||||||
|
.B capture
|
||||||
|
|
|
||||||
|
.B playback
|
||||||
|
|
||||||
|
options = ( depends on
|
||||||
|
.I subcommand
|
||||||
|
)
|
||||||
|
|
||||||
|
.SH DESCRIPTION
|
||||||
|
The
|
||||||
|
.B axfer
|
||||||
|
is a command\-line recorder and player to transfer audio data frame between H
|
||||||
|
sound devices/nodes and files/stdin/stdout.
|
||||||
|
|
||||||
|
.SH OPTIONS
|
||||||
|
|
||||||
|
.SS Subcommand
|
||||||
|
|
||||||
|
.TP
|
||||||
|
.B transfer
|
||||||
|
Performs transmission of audio data frame. Its detail is described in
|
||||||
|
.B axfer\-transfer(1)
|
||||||
|
manual.
|
||||||
|
|
||||||
|
.TP
|
||||||
|
.B list
|
||||||
|
Dumps lists of available sound devices and nodes. Its detail is described in
|
||||||
|
.B axfer\-list(1)
|
||||||
|
manual.
|
||||||
|
|
||||||
|
.TP
|
||||||
|
.B version
|
||||||
|
Prints version of this application (as the same version as alsa\-utils package).
|
||||||
|
|
||||||
|
.TP
|
||||||
|
.B help
|
||||||
|
Prints a short message about subcommands for users to enter this application.
|
||||||
|
|
||||||
|
.SS Direction
|
||||||
|
|
||||||
|
.TP
|
||||||
|
.B capture
|
||||||
|
Operates for capture transmission.
|
||||||
|
|
||||||
|
.TP
|
||||||
|
.B playback
|
||||||
|
Operates for playback transmission.
|
||||||
|
|
||||||
|
.SH EXIT STATUS
|
||||||
|
|
||||||
|
.I EXIT_SUCCESS
|
||||||
|
(0) if run time successfully finished, else
|
||||||
|
.I EXIT_FAILURE
|
||||||
|
(1).
|
||||||
|
|
||||||
|
.SH REPORTING BUGS
|
||||||
|
Report any bugs to mailing list of ALSA community
|
||||||
|
<alsa\-devel@alsa\-project.org> where the development and maintenance is
|
||||||
|
primarily done. Bug tracking service of alsa\-utils repository on github.com is
|
||||||
|
also available.
|
||||||
|
|
||||||
|
.SH SEE ALSO
|
||||||
|
.B axfer\-transfer(1),
|
||||||
|
.B axfer\-list(1),
|
||||||
|
.B alsamixer(1),
|
||||||
|
.B amixer(1)
|
||||||
|
|
||||||
|
.SH AUTHOR
|
||||||
|
Takashi Sakamoto <o\-takashi@sakamocchi.jp>
|
Loading…
Reference in a new issue