vss: Add documentation of MAP_POPULATE.
[paraslash.git] / m4 / lls / play.suite.m4
1 m4_define(PROGRAM, para_play)
2 m4_define(DEFAULT_HISTORY_FILE, ~/.paraslash/play.history)
3 m4_define(DEFAULT_CONFIG_FILE,~/.paraslash/play.conf)
4 [suite play]
5 version-string = GIT_VERSION()
6 [supercommand para_play]
7 purpose = command line audio player
8 non-opts-name = <audio_file>...
9 [description]
10 para_play operates either in command mode or in insert mode. In insert
11 mode it presents a prompt and allows the user to enter commands like
12 play, pause, quit, etc. In command mode the current audio file and the
13 playback position are shown instead of the prompt/command line, and
14 the program reads single key strokes from stdin. Keys may be mapped
15 to commands so that the configured command is executed whenever a
16 mapped key is pressed.
17 [/description]
18 m4_include(common-option-section.m4)
19 m4_include(help.m4)
20 m4_include(detailed-help.m4)
21 m4_include(version.m4)
22 m4_include(loglevel.m4)
23 m4_include(config-file.m4)
24 m4_include(history-file.m4)
25 m4_include(per-command-options-section.m4)
26 [option randomize]
27 short_opt = z
28 summary = randomize playlist at startup
29 [option key-map]
30 short_opt = k
31 summary = map a key to a command
32 arg_info = required_arg
33 arg_type = string
34 flag multiple
35 typestr = key:command [args]
36 [help]
37 This option may be given multiple times, one for each key
38 mapping. Example:
39
40 --key-map 5:jmp 50
41 [/help]