Merge branch 't/distcc'
[paraslash.git] / ggo / gui.m4
index 3f31dc1a202ee0eb61d5b8373531b6a80234a6a6..895229b22f8ef68cf7fa143c525eb90310c75a79 100644 (file)
@@ -1,9 +1,10 @@
 include(header.m4)
 define(CURRENT_PROGRAM,para_gui)
+define(DEFAULT_CONFIG_FILE,~/.paraslash/gui.conf)
 
 <qu>
 #########################
-section "general options"
+section "General options"
 #########################
 </qu>
 
@@ -14,34 +15,53 @@ include(loglevel.m4)
 option "timeout" t
 #~~~~~~~~~~~~~~~~~
 "set timeout"
+int typestr = "milliseconds"
+default = "30"
+optional
 
-       int typestr="milliseconds"
-       default="30"
-       optional
+option "theme" T
+#~~~~~~~~~~~~~~~
+"select startup theme"
+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.
+"
 
 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
 
-       string typestr="command"
-       default="para_audioc -- stat -p"
-       optional
+               para_client -- stat -p
+
+       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
 #~~~~~~~~~~~~~~~~~
+"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>