axfer/axfer.1

   1 .TH AXFER 1 "28 November 2018" "alsa\-utils"
   2
   3 .SH NAME
   4 axfer \- command\-line sound recorder and player for sound devices and nodes
   5 supported by Linux sound subsystem (Advanced Linux Sound Architecture, also
   6 known as ALSA).
   7
   8 .SH SYNOPSYS
   9
  10 .B axfer
  11 .I subcommand direction options
  12
  13 subcommand =
  14 .B transfer
  15 |
  16 .B list
  17 |
  18 .B version
  19 |
  20 .B help
  21
  22 direction =
  23 .B capture
  24 |
  25 .B playback
  26
  27 options = ( depends on
  28 .I subcommand
  29 )
  30
  31 .SH DESCRIPTION
  32 The
  33 .B axfer
  34 is a command\-line recorder and player to transfer audio data frame between
  35 sound devices/nodes and files/stdin/stdout.
  36
  37 .SH OPTIONS
  38
  39 .SS Subcommand
  40
  41 .TP
  42 .B transfer
  43 Performs transmission of audio data frame. Its detail is described in
  44 .B axfer\-transfer(1)
  45 manual.
  46
  47 .TP
  48 .B list
  49 Dumps lists of available sound devices and nodes. Its detail is described in
  50 .B axfer\-list(1)
  51 manual.
  52
  53 .TP
  54 .B version
  55 Prints version of this application (as the same version as alsa\-utils package).
  56
  57 .TP
  58 .B help
  59 Prints a short message about subcommands for users to enter this application.
  60
  61 .SS Direction
  62
  63 .TP
  64 .B capture
  65 Operates for capture transmission.
  66
  67 .TP
  68 .B playback
  69 Operates for playback transmission.
  70
  71 .SH EXIT STATUS
  72
  73 .I EXIT_SUCCESS
  74 (0) if run time successfully finished, else
  75 .I EXIT_FAILURE
  76 (1).
  77
  78 .SH UNIT TEST
  79
  80 This program has unit tests for internal implementation. Please refer to the
  81 manual of
  82 .I axfer-transfer
  83 for details.
  84
  85 .SH COMPATIBILITY TO APLAY
  86
  87 The
  88 .I axfer
  89 is designed to be compatible to aplay(1) as much as possible. In command line,
  90 executions of aplay/arecord files under $PATH runs axfer with compatibility
  91 mode if filesystem has symbolic link from the aplay/arecord to axfer.
  92
  93 .PP
  94 .in +4n
  95 .EX
  96 $ ln \-s aplay axfer
  97 $ ln \-s arecord axfer
  98 .EE
  99 .in
 100 .PP
 101
 102 .SS A string to which arg[0] points
 103 When args[0] in run time points to string ended with \(aqaplay\(aq, it has the
 104 same meaning of
 105 .I playback
 106 direction. When it points to string ended with \(aqarecord\(aq, it has the same
 107 meaning of
 108 .I capture
 109 direction.
 110
 111 .SS Options acknowledged as list subcommand
 112 Options of
 113 .I \-l
 114 ,
 115 .I \-\-list\-devices
 116 ,
 117 .I \-L
 118 ,
 119 .I \-\-list\-pcms
 120 are acknowledged as
 121 .I list
 122 subcommand. Without them, the run time performs
 123 .I transfer
 124 subcommand.
 125
 126 .SH REPORTING BUGS
 127 Report any bugs to mailing list of ALSA community
 128 <alsa\-devel@alsa\-project.org> where the development and maintenance is
 129 primarily done. Bug tracking service of alsa\-utils repository on github.com is
 130 also available.
 131
 132 .SH SEE ALSO
 133 .B axfer\-transfer(1),
 134 .B axfer\-list(1),
 135 .B alsamixer(1),
 136 .B amixer(1)
 137
 138 .SH AUTHOR
 139 Takashi Sakamoto <o\-takashi@sakamocchi.jp>