axfer: add a manual for list subcommand

This commit adds a manual for list subcommand of axfer(1). At present,
this subcommand prints helpful information to transfer subcommand in
libasound backend.

Signed-off-by: Takashi Sakamoto <o-takashi@sakamocchi.jp>
Signed-off-by: Takashi Iwai <tiwai@suse.de>

diff --git a/axfer/Makefile.am b/axfer/Makefile.am
index deb9c8a76cbaee86db732594ac9027c2e1b6e3c0..3b4026c33eb4cd4995bb4edff43b16cc508d561c 100644 (file)
--- a/axfer/Makefile.am
+++ b/axfer/Makefile.am
@@ -2,7 +2,8 @@ bin_PROGRAMS = \
        axfer
 
 man_MANS = \
-       axfer.1
+       axfer.1 \
+       axfer-list.1
 
 # To include headers for gettext and version.
 AM_CPPFLAGS = \
@@ -65,4 +66,5 @@ LDADD += -lffado
 endif
 
 EXTRA_DIST = \
-       axfer.1
+       axfer.1 \
+       axfer-list.1

diff --git a/axfer/axfer-list.1 b/axfer/axfer-list.1
new file mode 100644 (file)
index 0000000..25ca286
--- /dev/null
+++ b/axfer/axfer-list.1
@@ -0,0 +1,70 @@
+.TH AXFER\-LIST 1 "28 November 2018" "alsa\-utils"
+
+.SH NAME
+axfer\-list \- dump lists of available sound devices and nodes to transfer audio
+data frame.
+
+.SH SYNOPSIS
+
+.B axfer list
+.I direction target
+
+direction =
+.B capture
+|
+.B playback
+
+target =
+.B device
+|
+.B pcm
+
+.SH DESCRIPTION
+The
+.B list
+subcommand of
+.B axfer
+dumps lists of available nodes to
+transfer audio data frame. At present, the subcommand is helpful just for
+libasound backend of
+.B transfer
+subcommand.
+
+.SH OPTIONS
+
+.SS Direction
+
+.TP
+.B capture
+Operates for capture transmission.
+
+.TP
+.B playback
+Operates for playback transmission.
+
+.SS Target
+
+.TP
+.B device
+Dumps a list of all soundcards and digital audio devices available in
+.I libasound
+backend for
+.I tranfer
+subcommand.
+
+.TP
+.B pcm
+Dumps a list of all PCM nodes available in alsa\-lib configuration space in
+.I libasound
+backend for
+.I transfer
+subcommand.
+
+.SH SEE ALSO
+.B axfer(1),
+.B axfer\-transfer(1),
+.B alsamixer(1),
+.B amixer(1)
+
+.SH AUTHOR
+Takashi Sakamoto <o\-takashi@sakamocchi.jp>