From http://www.jwz.org/xscreensaver/xscreensaver-5.24.tar.gz

[xscreensaver] / hacks / config / README

diff --git a/hacks/config/README b/hacks/config/README
index 8475692b567e9bacbb2535d06d381c67c41f6f40..afc457566741ecce1ff8db6883932068cb334881 100644 (file)
--- a/hacks/config/README
+++ b/hacks/config/README
@@ -4,8 +4,8 @@
             a screen saver and locker for the X window system
                             by Jamie Zawinski
 
-                              version 4.02
-                               18-Mar-2002
+                              version 5.24
+                               07-Dec-2013
 
                      http://www.jwz.org/xscreensaver/
 
@@ -60,11 +60,11 @@ The tags and parameters used here are:
         into the command line (that's what makes it the default.)
         For example:
 
-           <boolean "foo" arg_set="-foo">
+           <boolean _label="foo" arg-set="-foo" />
 
         or if "foo" is the default, and must be explicity turned off,
 
-           <boolean "foo" arg_unset="-no-foo">
+           <boolean _label="foo" arg-unset="-no-foo" />
 
 -----------------------------------------------------------------------
 
@@ -131,10 +131,22 @@ The tags and parameters used here are:
 
         This creates a selection popup menu.
 
-        Options should have _arg-set, and never _arg-unset.
+        Options should have arg-set (arg-unset is not used here.)
 
-        One of the menu items (the default) should have no
-        _arg-set.
+        One of the menu items (the default) should have no arg-set.
+
+        Each arg-set should begin with the same switch: that is,
+        all the args in a given menu should look like:
+
+           -mode one
+           -mode two
+           -mode three
+
+        and not
+
+           -this
+           -that
+           -the other
 
 -----------------------------------------------------------------------
 
@@ -143,7 +155,7 @@ The tags and parameters used here are:
            arg="-SWITCH %"
            />
 
-        This creates a text entry field.  Options should be obvious.
+        This creates a text entry field.
 
 -----------------------------------------------------------------------
 
@@ -155,6 +167,73 @@ The tags and parameters used here are:
         This creates a file entry field (a text field with a "Browse"
         button next to it.)
 
+-----------------------------------------------------------------------
+
+  <xscreensaver-text />
+
+        This indicates that this screen saver displays text via the
+        "xscreensaver-text" program.  
+
+        In the X11 version, this tag does nothing: the text-related
+        preferences are in the main Screen Saver Preferences window,
+        not in the per-display-mode preferences.
+
+        In the MacOS version, the text-related preferences appear
+        in this pane, and this tag emits those several controls.
+
+-----------------------------------------------------------------------
+
+  <xscreensaver-image />
+
+        This indicates that this screen saver displays images via the
+        "xscreensaver-getimage" program.  
+
+        In the X11 version, this tag does nothing: the image-loading
+        and screen-grabbing-related preferences are in the main
+        Screen Saver Preferences window, not in the per-display-mode
+        preferences.
+
+        In the MacOS version, the image-related preferences appear
+        in this pane, and this tag emits those several controls.
+
+-----------------------------------------------------------------------
+
+  <xscreensaver-updater />
+
+        Where to position the "Check for Updates" options.
+        This is used on MacOS and ignored on X11.
+
+-----------------------------------------------------------------------
+
+  <hgroup>
+    [ ... <boolean>s ... ]
+    [ ... <number>s ... ]
+    [ ... <select>s ... ]
+    [ ... <string>s ... ]
+    [ ... <file>s ... ]
+    [ ... <vgroup>s ... ]
+  </hgroup>
+
+        A horizontal group of widgets/groups.  No more than 4 widgets 
+        or groups should be used in a row.
+
+-----------------------------------------------------------------------
+
+  <vgroup>
+    [ ... <boolean>s ... ]
+    [ ... <number>s ... ]
+    [ ... <select>s ... ]
+    [ ... <string>s ... ]
+    [ ... <file>s ... ]
+    [ ... <hgroup>s ... ]
+  </vgroup>
+
+        A vertical group of widgets/groups.  No more than 10 widgets 
+        or groups should be used in a column.
+        
+        Since the default alignment of widgets is a column, the 
+        <vgroup> element is only of use inside an <hgroup> element.
+
 -----------------------------------------------------------------------
 
   <_description>
@@ -170,3 +249,8 @@ The tags and parameters used here are:
         entities are allowed; HTML (and other markup) is not.
 
 -----------------------------------------------------------------------
+
+If you are DTD-minded, you may also find the included files "xss.dtd"
+and "xss.xsd" useful.
+
+-----------------------------------------------------------------------