Provide "purpose" texts.
[paraslash.git] / m4 / gengetopt / gui.m4
1 args "--conf-parser --no-handle-version"
2
3 purpose "Show para_audiod status in a curses window."
4
5 include(header.m4)
6 define(CURRENT_PROGRAM,para_gui)
7 define(DEFAULT_CONFIG_FILE,~/.paraslash/gui.conf)
8
9 <qu>
10 #########################
11 section "General options"
12 #########################
13 </qu>
14
15 include(config_file.m4)
16 include(loglevel.m4)
17
18 <qu>
19 option "timeout" t
20 #~~~~~~~~~~~~~~~~~
21 "set timeout"
22 int typestr = "milliseconds"
23 default = "30"
24 optional
25
26 option "theme" T
27 #~~~~~~~~~~~~~~~
28 "select startup theme"
29 string typestr = "name"
30 optional
31 details = "
32 If this option is not given the default theme is used.
33 If the given name is not a valid theme name, the list of
34 available themes is printed and the program terminates.
35 "
36
37 option "stat_cmd" s
38 #~~~~~~~~~~~~~~~~~~
39 "command to read status items from"
40 string typestr = "command"
41 default = "para_audioc -- stat -p"
42 optional
43 details = "
44 In order to run para_gui on a host on which no para_audiod
45 is running (hence the default command does not work), the
46 command
47
48 para_client -- stat -p
49
50 may be used. This command prints less information though.
51 In particular, no timing information about the current audio
52 file is printed.
53 "
54
55 #---------------------------------
56 section "Mapping keys to commands"
57 #---------------------------------
58
59 option "key_map" k
60 #~~~~~~~~~~~~~~~~~
61 "Map key k to command c using mode m."
62
63 string typestr = "k:m:c"
64 optional
65 multiple
66 details = "
67 Mode may be d, x or p for display, external and paraslash
68 commands, respectively. Of course, this option may be given
69 multiple times, one for each key mapping.
70 "
71 </qu>