m4/lls/play_cmd.suite.m4

   1 [suite play_cmd]
   2 caption = list of commands
   3 [subcommand help]
   4         purpose = list commands or keybindings, or print command-specific help
   5         non-opts-name = [command]
   6         [description]
   7
   8                 This command acts differently depending on whether it is executed in
   9                 command mode or in insert mode.
  10
  11                 In command mode, the help command prints the list of defined
  12                 keybindings. In insert mode, if no argument is given, it prints the
  13                 list of available commands. When called with the name of a command
  14                 as first argument, it prints the description of this command.
  15         [/description]
  16         m4_include(`long-help.m4')
  17
  18 [subcommand fg]
  19         purpose = enter command mode
  20         [description]
  21                 In this mode, file name and play time of the current audio file are
  22                 displayed. Hit CTRL+C or : to switch to input mode.
  23         [/description]
  24 [subcommand next]
  25         purpose = load the next file of the playlist
  26
  27 [subcommand prev]
  28         purpose = load the previous file of the playlist
  29
  30 [subcommand bg]
  31         purpose = enter insert mode
  32         [description]
  33                 Only useful if called in command mode via a key binding. The default
  34                 key bindings map the colon key to this command, so pressing : in
  35                 command mode activates insert mode.
  36         [/description]
  37
  38 [subcommand jmp]
  39         purpose = change playback position
  40         non-opts-name = percent
  41         [description]
  42                 The percent argument must be an integer between 0 and 100, inclusively.
  43         [/description]
  44
  45 [subcommand ff]
  46         purpose = set playback position relative to the current position
  47         non-opts-name = seconds
  48         [description]
  49                 Negative values mean to jump backwards the given amount of seconds.
  50         [/description]
  51
  52 [subcommand ls]
  53         purpose = list the playlist
  54         [description]
  55                 This prints all paths of the playlist. The currently
  56                 active file is marked with an asterisk.
  57         [/description]
  58
  59 [subcommand info]
  60         purpose = print information about the current file
  61         [description]
  62                 The output contains the playlist position, the path
  63                 and information provided by the audio format handler.
  64         [/description]
  65
  66 [subcommand play]
  67         purpose = start or resume playback
  68         non-opts-name = [num]
  69         [description]
  70                 If no argument is given, playback starts at the current
  71                 position. Otherwise, the corresponding file is loaded
  72                 and playback is started at the beginning of the file.
  73         [/description]
  74
  75 [subcommand pause]
  76         purpose = suspend playback
  77         [description]
  78                 When paused, it is still possible to jump around in
  79                 the file via the jmp and ff commands.
  80         [/description]
  81
  82 [subcommand tasks]
  83         purpose = print list of active tasks
  84         [description]
  85                 Mainly useful for debugging.
  86         [/description]
  87
  88 [subcommand quit]
  89         purpose = exit para_play
  90         [description]
  91                 Pressing CTRL+D causes EOF on stdin which also exits
  92                 para_play.
  93         [/description]