gui: Help text improvements.
authorAndre Noll <maan@systemlinux.org>
Mon, 17 Jan 2011 22:19:50 +0000 (23:19 +0100)
committerAndre Noll <maan@systemlinux.org>
Fri, 11 Feb 2011 10:25:07 +0000 (11:25 +0100)
- Fix default config file name
- Reformat ggo file
- Add detailed help fpr --stat_cmd
- Move description of key_map to --detailed-help output.

ggo/gui.m4

index 3a59807..895229b 100644 (file)
@@ -1,9 +1,10 @@
 include(header.m4)
 define(CURRENT_PROGRAM,para_gui)
 include(header.m4)
 define(CURRENT_PROGRAM,para_gui)
+define(DEFAULT_CONFIG_FILE,~/.paraslash/gui.conf)
 
 <qu>
 #########################
 
 <qu>
 #########################
-section "general options"
+section "General options"
 #########################
 </qu>
 
 #########################
 </qu>
 
@@ -14,17 +15,16 @@ include(loglevel.m4)
 option "timeout" t
 #~~~~~~~~~~~~~~~~~
 "set timeout"
 option "timeout" t
 #~~~~~~~~~~~~~~~~~
 "set timeout"
-
-       int typestr="milliseconds"
-       default="30"
-       optional
+int typestr = "milliseconds"
+default = "30"
+optional
 
 option "theme" T
 #~~~~~~~~~~~~~~~
 "select startup theme"
 
 option "theme" T
 #~~~~~~~~~~~~~~~
 "select startup theme"
-       string typestr = "name"
-       optional
-       details = "
+string typestr = "name"
+optional
+details = "
        If this option is not given the default theme is used.
        If the given name is not a valid theme name, the list of
        available themes is printed and the program terminates.
        If this option is not given the default theme is used.
        If the given name is not a valid theme name, the list of
        available themes is printed and the program terminates.
@@ -32,27 +32,36 @@ option "theme" T
 
 option "stat_cmd" s
 #~~~~~~~~~~~~~~~~~~
 
 option "stat_cmd" s
 #~~~~~~~~~~~~~~~~~~
-"command to read server and audiod status
-data from"
+"command to read status items from"
+string typestr = "command"
+default = "para_audioc -- stat -p"
+optional
+details = "
+       In order to run para_gui on a host on which no para_audiod
+       is running (hence the default command does not work), the
+       command
+
+               para_client -- stat -p
 
 
-       string typestr="command"
-       default="para_audioc -- stat -p"
-       optional
+       may be used. This command prints less information though.
+       In particular, no timing information about the current audio
+       file is printed.
+"
 
 #---------------------------------
 
 #---------------------------------
-section "mapping keys to commands"
+section "Mapping keys to commands"
 #---------------------------------
 
 option "key_map" k
 #~~~~~~~~~~~~~~~~~
 #---------------------------------
 
 option "key_map" k
 #~~~~~~~~~~~~~~~~~
+"Map key k to command c using mode m."
 
 
-"Map key k to command c using mode m. Mode
-may be d, x or p for display, external and
-paraslash commands, respectively. Of course,
-this option may be given multiple times, one
-for each key mapping."
-
-       string typestr="k:m:c"
-       optional
-       multiple
+string typestr = "k:m:c"
+optional
+multiple
+details = "
+       Mode may be d, x or p for display, external and paraslash
+       commands, respectively. Of course, this option may be given
+       multiple times, one for each key mapping.
+"
 </qu>
 </qu>