Merge branch 'maint'
[paraslash.git] / m4 / lls / gui.suite.m4
1 m4_define(PROGRAM, para_gui)
2 m4_define(DEFAULT_CONFIG_FILE, ~/.paraslash/gui.conf)
3 [suite gui]
4 version-string = GIT_VERSION()
5 [supercommand para_gui]
6         purpose = show para_audiod status in a curses window
7         [description]
8                 para_gui is a curses program which displays status information
9                 about para_server and para_audiod in a terminal. Keys may be
10                 mapped to user-defined commands which are executed when the key is
11                 pressed. Command output is shown in a simple pager.
12         [/description]
13         m4_include(common-option-section.m4)
14         m4_include(help.m4)
15         m4_include(detailed-help.m4)
16         m4_include(version.m4)
17         m4_include(config-file.m4)
18         m4_include(loglevel.m4)
19         m4_include(per-command-options-section.m4)
20         [option theme]
21                 short_opt = T
22                 summary = select startup theme
23                 arg_info = required_arg
24                 arg_type = string
25                 typestr = name
26                 [help]
27                         If this option is not given the default theme is used. If the given
28                         name is not a valid theme name, the list of available themes is
29                         printed and the program terminates.
30                 [/help]
31         [option stat-cmd]
32                 short_opt = s
33                 summary = command to read status items from
34                 arg_info = required_arg
35                 arg_type = string
36                 typestr = command
37                 default_val = para_audioc -- stat -p
38                 [help]
39                         On a host on which the para_audiod service is not is running, the
40                         default command will fail. An alternative is
41
42                                 para_client -- stat -p
43
44                         This command connects para_server instead of para_audiod. However,
45                         no timing information about the current audio file is printed.
46                 [/help]
47         [option key-map]
48                 short_opt = k
49                 summary = map a key to a command using one of three possible modes
50                 arg_info = required_arg
51                 arg_type = string
52                 typestr = k:m:c
53                 flag multiple
54                 [help]
55                         Mode may be d, x or p for display, external and paraslash commands,
56                         respectively. Of course, this option may be given multiple times,
57                         one for each key mapping. See the manual for more information.
58                 [/help]