X-Git-Url: http://git.hungrycats.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=hacks%2Fconfig%2FREADME;h=a9dd1a14cc596cc8dbd812680441b8d946db2799;hb=4361b69d3178d7fc98d0388f9a223af6c2651aba;hp=9071263320ed4fb5887116267fd4781d9546d5fd;hpb=447db08c956099b3b183886729108bf5b364c4b8;p=xscreensaver

diff --git a/hacks/config/README b/hacks/config/README
index 90712633..a9dd1a14 100644
--- a/hacks/config/README
+++ b/hacks/config/README
@@ -4,10 +4,10 @@
             a screen saver and locker for the X window system
                             by Jamie Zawinski
 
-                              version 4.21
-                               20-Mar-2005
+                              version 5.37
+                               05-Jul-2017
 
-                     http://www.jwz.org/xscreensaver/
+                     https://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,9 +131,22 @@ The tags and parameters used here are:
 
         This creates a selection popup menu.
 
-        Options should have _arg-set (_arg-unset is not used here.)
+        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
 
 -----------------------------------------------------------------------
 
@@ -154,6 +167,79 @@ 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.
+
+-----------------------------------------------------------------------
+
+  <video href="URL" />
+
+        A link to a Youtube preview of this screen saver.
+
+-----------------------------------------------------------------------
+
+  <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>
@@ -169,3 +255,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.
+
+-----------------------------------------------------------------------