play: Convert com_ls() to lopsub.
[paraslash.git] / 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
17 [subcommand fg]
18 purpose = enter command mode
19 [description]
20 In this mode, file name and play time of the current audio file are
21 displayed. Hit CTRL+C or : to switch to input mode.
22 [/description]
23 [subcommand next]
24 purpose = load the next file of the playlist
25
26 [subcommand prev]
27 purpose = load the previous file of the playlist
28
29 [subcommand bg]
30 purpose = enter insert mode
31 [description]
32 Only useful if called in command mode via a key binding. The default
33 key bindings map the colon key to this command, so pressing : in
34 command mode activates insert mode.
35 [/description]
36
37 [subcommand jmp]
38 purpose = change playback position
39 non-opts-name = percent
40 [description]
41 The percent argument must be an integer between 0 and 100, inclusively.
42 [/description]
43
44 [subcommand ff]
45 purpose = set playback position relative to the current position
46 non-opts-name = seconds
47 [description]
48 Negative values mean to jump backwards the given amount of seconds.
49 [/description]
50
51 [subcommand ls]
52 purpose = list the playlist
53 [description]
54 This prints all paths of the playlist. The currently
55 active file is marked with an asterisk.
56 [/description]