diff --git a/axfer/Makefile.am b/axfer/Makefile.am index 39f414c..deb9c8a 100644 --- a/axfer/Makefile.am +++ b/axfer/Makefile.am @@ -1,6 +1,9 @@ bin_PROGRAMS = \ axfer +man_MANS = \ + axfer.1 + # To include headers for gettext and version. AM_CPPFLAGS = \ -I$(top_srcdir)/include @@ -60,3 +63,6 @@ if HAVE_FFADO axfer_SOURCES += xfer-libffado.c LDADD += -lffado endif + +EXTRA_DIST = \ + axfer.1 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 + 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