Merge branch 'maint'

[paraslash.git] / m4 / lls / play_cmd.suite.m4

diff --git a/m4/lls/play_cmd.suite.m4 b/m4/lls/play_cmd.suite.m4
index e62bb0000d736a87ff4bf2513e3ae53593716be3..195b47b967bb7685b03ed00230358b164c6fcace 100644 (file)
--- a/m4/lls/play_cmd.suite.m4
+++ b/m4/lls/play_cmd.suite.m4
@@ -22,3 +22,71 @@ caption = list of commands
        [/description]
 [subcommand next]
        purpose = load the next file of the playlist
+
+[subcommand prev]
+       purpose = load the previous file of the playlist
+
+[subcommand bg]
+       purpose = enter insert mode
+       [description]
+               Only useful if called in command mode via a key binding. The default
+               key bindings map the colon key to this command, so pressing : in
+               command mode activates insert mode.
+       [/description]
+
+[subcommand jmp]
+       purpose = change playback position
+       non-opts-name = percent
+       [description]
+               The percent argument must be an integer between 0 and 100, inclusively.
+       [/description]
+
+[subcommand ff]
+       purpose = set playback position relative to the current position
+       non-opts-name = seconds
+       [description]
+               Negative values mean to jump backwards the given amount of seconds.
+       [/description]
+
+[subcommand ls]
+       purpose = list the playlist
+       [description]
+               This prints all paths of the playlist. The currently
+               active file is marked with an asterisk.
+       [/description]
+
+[subcommand info]
+       purpose = print information about the current file
+       [description]
+               The output contains the playlist position, the path
+               and information provided by the audio format handler.
+       [/description]
+
+[subcommand play]
+       purpose = start or resume playback
+       non-opts-name = [num]
+       [description]
+               If no argument is given, playback starts at the current
+               position. Otherwise, the corresponding file is loaded
+               and playback is started at the beginning of the file.
+       [/description]
+
+[subcommand pause]
+       purpose = suspend playback
+       [description]
+               When paused, it is still possible to jump around in
+               the file via the jmp and ff commands.
+       [/description]
+
+[subcommand tasks]
+       purpose = print list of active tasks
+       [description]
+               Mainly useful for debugging.
+       [/description]
+
+[subcommand quit]
+       purpose = exit para_play
+       [description]
+               Pressing CTRL+D causes EOF on stdin which also exits
+               para_play.
+       [/description]