command.c: Document return value of handle_connect().
[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
11 insert mode it presents a prompt and allows to enter commands like
12 stop, play, pause etc. In command mode the current audio file and the
13 playback position are shown and the program reads single key strokes
14 from stdin. Keys may be mapped to commands so that the configured
15 command is executed when a mapped key is pressed.
16 [/description]
17 m4_include(common-option-section.m4)
18 m4_include(help.m4)
19 m4_include(detailed-help.m4)
20 m4_include(version.m4)
21 m4_include(loglevel.m4)
22 m4_include(config-file.m4)
23 m4_include(history-file.m4)
24 m4_include(per-command-options-section.m4)
25 [option randomize]
26 short_opt = z
27 summary = randomize playlist at startup
28 [option key-map]
29 short_opt = k
30 summary = map a key to a command
31 arg_info = required_arg
32 arg_type = string
33 flag multiple
34 typestr = key:command [args]
35 [help]
36 This option may be given multiple times, one for each key
37 mapping. Example:
38
39 --key-map 5:jmp 50
40 [/help]