diff options
author | Takashi Sakamoto <o-takashi@sakamocchi.jp> | 2018-12-06 06:31:46 +0900 |
---|---|---|
committer | Takashi Iwai <tiwai@suse.de> | 2018-12-07 10:54:36 +0100 |
commit | c5b2beebfdc2fad03386f05ae9b984da265b9e5c (patch) | |
tree | bfc709699e22d93e9dd163514217c780fc0e8497 /axfer/axfer.1 | |
parent | bae5761d72f5488616c45fe4f6b32df42c8f5797 (diff) | |
download | alsa-utils-c5b2beebfdc2fad03386f05ae9b984da265b9e5c.tar.gz |
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>
Diffstat (limited to 'axfer/axfer.1')
-rw-r--r-- | axfer/axfer.1 | 91 |
1 files changed, 91 insertions, 0 deletions
diff --git a/axfer/axfer.1 b/axfer/axfer.1 new file mode 100644 index 0000000..753364d --- /dev/null +++ b/axfer/axfer.1 @@ -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> |