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

[xscreensaver] / driver / xscreensaver-demo.man

diff --git a/driver/xscreensaver-demo.man b/driver/xscreensaver-demo.man
index 6355e385f3532011906eefc45f55d616f3a798db..07104be6fce7d087df9787f87b616b2c1976fcf5 100644 (file)
--- a/driver/xscreensaver-demo.man
+++ b/driver/xscreensaver-demo.man
@@ -11,12 +11,14 @@
 .if n .sp 1
 .if t .sp .5
 ..
 .if n .sp 1
 .if t .sp .5
 ..

-.TH XScreenSaver 1 "02-Feb-2001 (3.28)" "X Version 11"
+.TH XScreenSaver 1 "09-Nov-2013 (5.23)" "X Version 11"

 .SH NAME
 xscreensaver-demo - interactively control the background xscreensaver daemon
 .SH SYNOPSIS
 .B xscreensaver\-demo
 .SH NAME
 xscreensaver-demo - interactively control the background xscreensaver daemon
 .SH SYNOPSIS
 .B xscreensaver\-demo

-[\-display \fIhost:display.screen\fP] [\-prefs] [\-xrm \fIresources\fP]
+[\-display \fIhost:display.screen\fP]
+[\-prefs]
+[--debug]

 .SH DESCRIPTION
 The \fIxscreensaver\-demo\fP program is a graphical front-end for 
 setting the parameters used by the background
 .SH DESCRIPTION
 The \fIxscreensaver\-demo\fP program is a graphical front-end for 
 setting the parameters used by the background


@@ -74,25 +76,51 @@ can find online copies of the
 and
 .BR xscreensaver\-command (1)
 manuals.
 and
 .BR xscreensaver\-command (1)
 manuals.

-.SH GRAPHICS DEMOS TAB
-On the left is a list of the names of the various display modes, and
-on the right are some fields that let you edit their behavior.
+.SH DISPLAY MODES TAB
+This page contains a list of the names of the various display modes, a
+preview area, and some fields that let you configure screen saver behavior.
+.TP 4
+.B Mode
+This option menu controls the activation behavior of the screen saver.
+The options are:
+.RS 4
+.TP 4
+.B Disable Screen Saver
+Don't ever blank the screen, and don't ever allow the monitor to power down.
+.TP 4
+.B Blank Screen Only
+When blanking the screen, just go black: don't run any graphics.
+.TP 4
+.B Only One Screen Saver
+When blanking the screen, only ever use one particular display mode (the
+one selected in the list.)
+.TP 4
+.B Random Screen Saver
+When blanking the screen, select a random display mode from among those
+that are enabled and applicable.  If there are multiple monitors
+connected, run a different display mode on each one.  This is the default.
+.TP 4
+.B Random Same Saver
+This is just like \fBRandom Screen Saver\fP, except that the \fIsame\fP
+randomly-chosen display mode will be run on all monitors, instead of
+different ones on each.
+.RE

 .TP 4
 .B Demo List
 Double-clicking in the list on the left will let you try out the indicated
 demo.  The screen will go black, and the program will run in full-screen
 mode, just as it would if the \fIxscreensaver\fP daemon had launched it.
 .TP 4
 .B Demo List
 Double-clicking in the list on the left will let you try out the indicated
 demo.  The screen will go black, and the program will run in full-screen
 mode, just as it would if the \fIxscreensaver\fP daemon had launched it.

-Clicking the mouse again will stop the demo and un-blank the screen, making
-the dialog box visible again.
+Clicking the mouse again will stop the demo and un-blank the screen.

 
 

-Single-clicking in the list will populate the fields on the right side of
-the window.
+Single-clicking in the list will run it in the small preview pane on the
+right.  (But beware: many of the display modes behave somewhat differently
+when running in full-screen mode, so the scaled-down view might not give
+an accurate impression.)

 
 

-Each name in the list has a checkbox next to it: this is a duplicate of
-the \fIEnabled\fP checkbox, and indicates (and controls) whether
-xscreensaver will  use this display mode at all.  If the box is not
-checked, then this demo will not be run automatically (though you can
-run it explicitly by double-clicking on its name.)
+When \fBMode\fP is set to \fBRandom Screen Saver\fP, each name in the list
+has a checkbox next to it: this controls whether this display mode is
+enabled.  If it is unchecked, then that mode will not be chosen.  (Though
+you can still run it explicitly by double-clicking on its name.)

 .TP 4
 .B Arrow Buttons
 Beneath the list are a pair of up and down arrows. Clicking on the down 
 .TP 4
 .B Arrow Buttons
 Beneath the list are a pair of up and down arrows. Clicking on the down 


@@ -100,42 +128,6 @@ arrow will select the next item in the list, and then run it in full-screen
 mode, just as if you had double-clicked on it.  The up arrow goes the other
 way.  This is just a shortcut for trying out all of the display modes in turn.
 .TP 4
 mode, just as if you had double-clicked on it.  The up arrow goes the other
 way.  This is just a shortcut for trying out all of the display modes in turn.
 .TP 4

-.B Program Description
-At the top will be a brief description of the program.  Below that is a
-text field where you can edit the arguments to the program as xscreensaver
-will invoke it.  (Note that most of these programs have their own man pages
-that describe the command-line options they take.)
-.TP 4
-.B Enabled
-The \fIEnabled\fP checkbox controls whether xscreensaver will use this
-display mode at all.  This way, all the modes can remain available, but
-you can choose which ones will be automatically run.
-.TP 4
-.B Visual
-The \fIVisual\fP field is where you can select the X visual type that this
-demo will require.  If you specify one (other than \fIAny\fP) then the
-program will only be run on that kind of visual.  For example, you can
-specify that a particular program should only be run if color is available,
-and another should only be run in monochrome.  See the discussion of the
-\fIprograms\fP parameter in the \fIConfiguration\fP section of the
-.BR xscreensaver (1)
-manual.
-
-This is a combo-box, so you can either select an item from the popup menu,
-or type in a specific visual's hexadecimal ID.
-.TP 4
-.B Demo
-This button runs the demo in full-screen mode so that you can try it out.
-Click the mouse to dismiss it.
-.TP 4
-.B Documentation
-Since each of the display modes is actually a separate program, they each
-may have their own manual.  This opens a window viewing the man page of
-this program, if it has one.
-.SH SCREENSAVER OPTIONS TAB
-This tab lets you change various settings used by the xscreensaver daemon
-itself, rather than its sub-programs.
-.TP 4

 .B Blank After
 After the user has been idle this long, the \fIxscreensaver\fP daemon
 will blank the screen.
 .B Blank After
 After the user has been idle this long, the \fIxscreensaver\fP daemon
 will blank the screen.


@@ -147,37 +139,127 @@ If this is 0, then the graphics demo will never be changed:
 only one demo will run until the screensaver is deactivated by user 
 activity.
 .TP 4
 only one demo will run until the screensaver is deactivated by user 
 activity.
 .TP 4

-.B Require Password
-Whether the screen saver should lock the screen when it activates.
-.TP 4
-.B Lock After
-If \fIRequire Password\fP is selected, this controls the length of 
-the ``grace period'' between when the screensaver activates, and when the
-screen becomes locked.  For example, if this is 0:05:00, 
-and \fIBlank After\fP is 0:10:00, then after 10 minutes, the screen 
-would blank.  If there was user  activity at 12 minutes, no password
-would be required to un-blank the screen.  But, if there was user activity
-at 15 minutes or later (that is, \fILock After\fP minutes after 
-activation) then a password would be required.  The default is 0, meaning
-that if locking is enabled, then a password will be required as soon as the 
-screen blanks.
-.TP 4
-.B Verbose Diagnostics
-Whether to print lots of debugging information.
-.TP 4
-.B Display Subprocess Errors
-If this is set, then if one of the graphics demos prints something to
-stdout or stderr, it will show up on the screen immediately (instead of
-being lost in a hidden terminal or file that you can't see.)
+.B Lock Screen
+When this is checked, the screen will be locked when it activates.
+.TP 4
+.B Lock Screen After
+This controls the length of the ``grace period'' between when the
+screensaver activates, and when the screen becomes locked.  For
+example, if this is 5 minutes, and \fIBlank After\fP is 10 minutes,
+then after 10 minutes, the screen would blank.  If there was user
+activity at 12 minutes, no password would be required to un-blank the
+screen.  But, if there was user activity at 15 minutes or later (that
+is, \fILock Screen After\fP minutes after activation) then a password
+would be required.  The default is 0, meaning that if locking is
+enabled, then a password will be required as soon as the screen blanks.
+.TP 4
+.B Preview
+This button, below the small preview window, runs the demo in full-screen
+mode so that you can try it out.  This is the same thing that happens when
+you double-click an element in the list.  Click the mouse to dismiss the
+full-screen preview.
+.TP 4
+.B Settings
+This button will pop up a dialog where you can configure settings specific
+to the display mode selected in the list.
+.SH SETTINGS DIALOG
+When you click on the \fISettings\fP button on the \fIDisplay Modes\fP
+tab, a configuration dialog will pop up that lets you customize settings
+of the selected display mode.  Each display mode has its own custom
+configuration controls on the left side.
+
+On the right side is a paragraph or two describing the display mode.
+Below that is a \fBDocumentation\fP button that will display the display
+mode's manual page, if it has one, in a new window (since each of the
+display modes is actually a separate program, they each have their
+own manual.)
+
+The \fBAdvanced\fP button reconfigures the dialog box so that you can
+edit the display mode's command line directly, instead of using the 
+graphical controls.
+.SH ADVANCED TAB
+This tab lets you change various settings used by the xscreensaver daemon
+itself, as well as some global options shared by all of the display modes.
+
+.B Image Manipulation
+
+Some of the graphics hacks manipulate images.  These settings control
+where those source images come from.
+(All of these options work by invoking the
+.BR xscreensaver\-getimage (1)
+program, which is what actually does the work.)
+.RS 4
+.TP 4
+.B Grab Desktop Images
+If this option is selected, then they are allowed to manipulate the
+desktop image, that is, a display mode might draw a picture of your
+desktop melting, or being distorted in some way.  The
+security-paranoid might want to disable this option, because if it is
+set, it means that the windows on your desktop will occasionally be
+visible while your screen is locked.  Others will not be able to
+\fIdo\fP anything, but they may be able to \fIsee\fP whatever you left
+on your screen.
+.TP 4
+.B Grab Video Frames
+If your system has a video capture card, selecting this option will allow
+the image-manipulating modes to capture a frame of video to operate on.
+.TP 4
+.B Choose Random Image
+If this option is set, then the image-manipulating modes will select a
+random image file to operate on, from the specified source.  That
+source may be a local directory, which will be recursively searched
+for images.  Or, it may be the URL of an RSS or Atom feed (e.g., a
+Flickr gallery), in which case a random image from that feed will be
+selected instead.  The contents of the feed will be cached locally and
+refreshed periodically as needed.
+.PP
+If more than one of the above image-related options are selected, then
+one will be chosen at random.  If none of them are selected, then an
+image of video colorbars will be used instead.
+.RE
+.PP
+.B Text Manipulation

 
 

-If you change this option, it will only take effect the next time the
-xscreensaver daemon is restarted.  (All other settings take effect
-immediately.)
+Some of the display modes display and manipulate text.  The following
+options control how that text is generated.  (These parameters control
+the behavior of the
+.BR xscreensaver\-text (1)
+program, which is what actually does the work.)
+.RS 4
+.TP 4
+.B Host Name and Time
+If this checkbox is selected, then the text used by the screen savers
+will be the local host name, OS version, date, time, and system load.

 .TP 4
 .TP 4

-.B Display Splash Screen at Startup
-Normally when xscreensaver starts up, it briefly displays a splash dialog
-showing the version number, a \fIHelp\fP button, etc.  If this option is
-turned off, the splash screen will not be shown at all.
+.B Text
+If this checkbox is selected, then the literal text typed in the 
+field to its right will be used.  If it contains % escape sequences,
+they will be expanded as per
+.BR strftime (2).
+.TP 4
+.B Text File
+If this checkbox is selected, then the contents of the corresponding
+file will be displayed.
+.TP 4
+.B Program
+If this checkbox is selected, then the given program will be run,
+repeatedly, and its output will be displayed.
+.TP 4
+.B URL
+If this checkbox is selected, then the given HTTP URL will be downloaded
+and displayed repeatedly.  If the document contains HTML, RSS, or Atom,
+it will be converted to plain-text first.
+
+Note: this re-downloads the document every time the screen saver
+runs out of text, so it will probably be hitting that web server multiple
+times a minute.  Be careful that the owner of that server doesn't
+consider that to be abusive.
+.RE
+.PP
+.B Power Management Settings
+
+These settings control whether, and when, your monitor powers down.
+.RS 4

 .TP 4
 .B Power Management Enabled
 Whether the monitor should be powered down after a period of inactivity.
 .TP 4
 .B Power Management Enabled
 Whether the monitor should be powered down after a period of inactivity.


@@ -206,30 +288,44 @@ If \fIPower Management Enabled\fP is selected, the monitor will fully
 power down after this much idle time.  This duration should be greater
 than or equal to \fISuspend\fP.
 .TP 4
 power down after this much idle time.  This duration should be greater
 than or equal to \fISuspend\fP.
 .TP 4

-.B Install Colormap
-Whether to install a private colormap while the screensaver is active, so
-that the graphics hacks can get as many colors as possible.  (This only
-applies when the screen's default visual is being used, since non-default
-visuals get their own colormaps automatically.)  This can also be overridden
-on a per-demo basis.
+.B Quick Power-off in "Blank Only" Mode
+If the display mode is set to \fIBlank Screen Only\fP and this is
+checked, then the monitor will be powered off immediately upon
+blanking, regardless of the other power-management settings.  In this
+way, the power management idle-timers can be completely disabled, but
+the screen will be powered off when black.  (This might be preferable
+on laptops.)
+.RE
+.PP
+.B Fading and Colormaps
+
+These options control how the screen fades to or from black when
+a screen saver begins or ends.
+.RS 4

 .TP 4
 .B Fade To Black When Blanking
 If selected, then when the screensaver activates, the current contents
 .TP 4
 .B Fade To Black When Blanking
 If selected, then when the screensaver activates, the current contents

-of the screen will fade to black instead of simply winking out.  This only
-works on displays with writable colormaps, that is, if the screen's default
-visual is a PseudoColor visual.  A fade will also be done when
+of the screen will fade to black instead of simply winking out.  (Note:
+this doesn't work with all X servers.)  A fade will also be done when

 switching graphics hacks (when the \fICycle After\fP expires.)
 .TP 4
 .B Unfade From Black When Unblanking
 The complement to \fIFade Colormap\fP: if selected, then when the screensaver
 deactivates, the original contents of the screen will fade in from black
 switching graphics hacks (when the \fICycle After\fP expires.)
 .TP 4
 .B Unfade From Black When Unblanking
 The complement to \fIFade Colormap\fP: if selected, then when the screensaver
 deactivates, the original contents of the screen will fade in from black

-instead of appearing immediately.  This only works on displays with writable
-colormaps, and when \fIFade Colormap\fP is also selected.
+instead of appearing immediately.  This is only done if \fIFade Colormap\fP
+is also selected.

 .TP 4
 .B Fade Duration
 When fading or unfading are selected, this controls how long the fade will
 take.
 .TP 4
 .B Fade Duration
 When fading or unfading are selected, this controls how long the fade will
 take.

+.TP 4
+.B Install Colormap
+On 8-bit screens, whether to install a private colormap while the
+screensaver is active, so that the graphics hacks can get as many
+colors as possible.  This does nothing if you are running in 16-bit
+or better.

 .PP
 .PP

+.RE

 There are more settings than these available, but these are the most 
 commonly used ones; see the manual for
 .BR xscreensaver (1)
 There are more settings than these available, but these are the most 
 commonly used ones; see the manual for
 .BR xscreensaver (1)


@@ -245,8 +341,11 @@ window on that display, and also control the \fIxscreensaver\fP daemon that
 is managing that same display.
 .TP 8
 .B \-prefs
 is managing that same display.
 .TP 8
 .B \-prefs

-Start up with the \fBScreensaver Options\fP tab selected by default
-instead of the \fBGraphics Demos\fP tab.
+Start up with the \fBAdvanced\fP tab selected by default
+instead of the \fBDisplay Modes\fP tab.
+.TP 8
+.B \-debug
+Causes lots of diagnostics to be printed on stderr.

 .P
 It is important that the \fIxscreensaver\fP and \fIxscreensaver\-demo\fP
 processes be running on the same machine, or at least, on two machines
 .P
 It is important that the \fIxscreensaver\fP and \fIxscreensaver\-demo\fP
 processes be running on the same machine, or at least, on two machines


@@ -264,7 +363,7 @@ to get the default host and display number.
 to find the sub-programs to run.  However, note that the sub-programs 
 are actually launched by the \fIxscreensaver\fP daemon, not 
 by \fIxscreensaver-demo\fP itself.  So, what matters is what \fB$PATH\fP
 to find the sub-programs to run.  However, note that the sub-programs 
 are actually launched by the \fIxscreensaver\fP daemon, not 
 by \fIxscreensaver-demo\fP itself.  So, what matters is what \fB$PATH\fP

-the \fIxscreensaver\fP program sees.
+that the \fIxscreensaver\fP program sees.

 .TP 8
 .B HOME
 for the directory in which to read and write the \fI.xscreensaver\fP file.
 .TP 8
 .B HOME
 for the directory in which to read and write the \fI.xscreensaver\fP file.


@@ -272,22 +371,27 @@ for the directory in which to read and write the \fI.xscreensaver\fP file.
 .B XENVIRONMENT
 to get the name of a resource file that overrides the global resources
 stored in the RESOURCE_MANAGER property.
 .B XENVIRONMENT
 to get the name of a resource file that overrides the global resources
 stored in the RESOURCE_MANAGER property.

+.TP 8
+.B HTTP_PROXY\fR or \fPhttp_proxy
+to get the default HTTP proxy host and port.

 .SH UPGRADES
 .SH UPGRADES

-The latest version can always be found at 
-http://www.jwz.org/xscreensaver/
+The latest version of xscreensaver, an online version of this manual,
+and a FAQ can always be found at http://www.jwz.org/xscreensaver/

 .SH SEE ALSO
 .BR X (1),
 .BR xscreensaver (1),
 .SH SEE ALSO
 .BR X (1),
 .BR xscreensaver (1),

-.BR xscreensaver\-command (1)
+.BR xscreensaver\-command (1),
+.BR xscreensaver\-getimage (1),
+.BR xscreensaver\-text (1)

 .SH COPYRIGHT
 .SH COPYRIGHT

-Copyright \(co 1992, 1993, 1997, 1998, 1999, 2000, 2001
-by Jamie Zawinski.  Permission to use, copy, modify, distribute, and sell
-this software and its documentation for any purpose is hereby granted without
-fee, provided that the above copyright notice appear in all copies and that
-both that copyright notice and this permission notice appear in supporting
-documentation.  No representations are made about the suitability of this
-software for any purpose.  It is provided "as is" without express or implied
-warranty.
+Copyright \(co 1992-2013 by Jamie Zawinski.
+Permission to use, copy, modify, distribute, and sell this software
+and its documentation for any purpose is hereby granted without fee,
+provided that the above copyright notice appear in all copies and that
+both that copyright notice and this permission notice appear in
+supporting documentation.  No representations are made about the
+suitability of this software for any purpose.  It is provided "as is"
+without express or implied warranty.

 .SH AUTHOR
 Jamie Zawinski <jwz@jwz.org>, 13-aug-92.
 
 .SH AUTHOR
 Jamie Zawinski <jwz@jwz.org>, 13-aug-92.