1. NAME
  2. auplayer – a CLI for playing audio files
  4. auplayer [-lprsv] [-F file-descriptor] [-I file-descriptor]
  5. [-b buffer-size] [-c command] [-d device] [-f file-list]
  6. [-g file-list] [-h history-size] [-i input-file] arg ...
  8. auplayer provides a simple command-line interface for playing audio
  9. files.
  10. The arguments are as follows:
  11. -F file-descriptor
  12. Add lines read from file-descriptor to the playlist as below,
  13. removing leading & trailing white-space.
  14. -I file-descriptor
  15. Read commands from file-descriptor instead of the standard input.
  16. -b buffer-size
  17. Specify the buffer size for auopen(1).
  18. Additionally, append "-b buffer-size" to the end of the shell
  19. command string.
  20. -c command
  21. Specify the shell command to execute when playing audio.
  22. If command is empty then auplayer does not try to play files,
  23. does not look-up files when using the a command, and does not
  24. exit if there are no more entries available.
  25. This is to aid in testing.
  26. -d device
  27. Append "-d device" to the end of the shell command string.
  28. -f file-list
  29. Add each line of file-list to the playlist as below, removing
  30. leading & trailing white-space. If file-list is "-" then the
  31. standard input is read instead.
  32. -g file-list
  33. glob(3) each line of file-list, after removing the leading &
  34. trailing white-space, adding the results to the playlist as
  35. below. If file-list is "-" then the standard input is read
  36. instead.
  37. -h history-size
  38. Specify the number of elements to keep in history.
  39. -l After playing the last file loop back to the beginning instead of
  40. exiting, reshuffling if -s is specified. This option has no
  41. effect if -r is specified.
  42. -i input
  43. Read commands from input instead of the standard input.
  44. -p Have auplayer behave in a manner suitable for being controlled by
  45. another program.
  46. auplayer will print information in a parse friendly format:
  47. : time / [total]
  48. The current position and total length of the current
  49. file. For example: ": 0:12:34.56/1:23:45.67".
  50. ! string
  51. Information about the internal state. For example
  52. "!pause" and "!unpause".
  53. @ path The path of the currently playing entry.
  54. + path The specified path was appended to the playlist.
  55. - path The specified path was removed from the playlist.
  56. This option supersedes -v.
  57. -r Play the audio files in a random order.
  58. -s Shuffle the list of audio files.
  59. -v Enable verbose output.
  60. ( Begin an ordered sub-group.
  61. (r Begin a random sub-group. Random sub-groups play one random
  62. entry each time it is selected. Trailing characters are ignored.
  63. (s Begin a shuffled sub-group. Trailing characters are ignored.
  64. ) End a sub-group list.
  65. file Append file to the list of files. If it is a directory, non-
  66. recursively append its, sorted, entries to the list of files.
  67. If no input is selected, and the standard input was specified by -f, then
  68. the input will be read from "/dev/tty". However, the -p option will
  69. cause an error to be produced instead.
  71. Commands have the following global syntax:
  72. [count] c [argument]
  73. Where c is the command character.
  74. The available commands are as follows:
  75. ( Begins a sub-group as above. count is ignored.
  76. ) Ends a sub-group as above. Both count and argument are ignored.
  77. + Seek forwards by argument. count is ignored.
  78. - Seek backwards by argument. count is ignored.
  79. = Seek to the time specified by argument. If argument is negative
  80. the seek is relative to the end of the file. count is ignored.
  81. ? Print the current file, the position in it, and its length. Both
  82. count and argument are ignored.
  83. / Search forward for argument and move to the matching entry, if
  84. any. count is ignored.
  85. L Toggle looping. Both count and argument are ignored.
  86. V Toggle verbosity. Both count and argument are ignored.
  87. a Append files matched by argument to the file list. count is
  88. ignored.
  89. d If an argument is given, remove any entries that match argument,
  90. otherwise remove the current entry. count is ignored.
  91. h Go back count entries. argument is ignored.
  92. i A synonym for ?.
  93. j A synonym for h.
  94. k Go forward count entries. argument is ignored.
  95. l A synonym for k.
  96. p Toggle the pause state. Both count and argument are ignored.
  97. q Exit auplayer. Both count and argument are ignored.
  98. r Replay the current entry. Both count and argument are ignored.
  100. The auplayer utility exits 0 on success, and >0 if an error occurs.
  101. SEE ALSO
  102. auopen(1) au2dev(1) glob(3)