[xscreensaver] / driver / xscreensaver-demo.man

.de EX          \"Begin example
.ne 5
.if n .sp 1
.if t .sp .5
.nf
.in +.5i
..
.de EE
.fi
.in -.5i
.if n .sp 1
.if t .sp .5
..
.TH XScreenSaver 1 "12-May-2004 (4.16)" "X Version 11"
.SH NAME
xscreensaver-demo - interactively control the background xscreensaver daemon
.SH SYNOPSIS
.B xscreensaver\-demo
[\-display \fIhost:display.screen\fP]
[\-prefs]
[--crapplet]
[--debug]
.SH DESCRIPTION
The \fIxscreensaver\-demo\fP program is a graphical front-end for 
setting the parameters used by the background
.BR xscreensaver (1)
daemon.
It is essentially two things: a tool for editing the \fI~/.xscreensaver\fP
file; and a tool for demoing the various graphics hacks that 
the \fIxscreensaver\fP daemon will launch.

The main window consists of a menu bar and two tabbed pages.  The first page
is for editing the list of demos, and the second is for editing various other
parameters of the screensaver.
.SH MENU COMMANDS
All of these commands are on either the \fBFile\fP or \fBHelp\fP menus:
.TP 4
.B Blank Screen Now
Activates the background \fIxscreensaver\fP daemon, which will then run
a demo at random.  This is the same as running
.BR xscreensaver-command (1)
with the \fI\-activate\fP option.
.TP 4
.B Lock Screen Now
Just like \fBBlank Screen Now\fP, except the screen will be locked as 
well (even if it is not configured to lock all the time.)  This is the
same as running
.BR xscreensaver-command (1)
with the \fI\-lock\fP option.
.TP 4
.B Kill Daemon
If the xscreensaver daemon is running on this screen, kill it.
This is the same as running
.BR xscreensaver-command (1)
with the \fI\-exit\fP option.
.TP 4
.B Restart Daemon
If the xscreensaver daemon is running on this screen, kill it.
Then launch it again.  This is the same as doing
``\fIxscreensaver-command -exit\fP'' followed by ``\fIxscreensaver\fP''.

Note that it is \fInot\fP the same as doing
``\fIxscreensaver-command -restart\fP''.
.TP 4
.B Exit
Exits the \fIxscreensaver-demo\fP program (this program) without
affecting the background \fIxscreensaver\fP daemon, if any.
.TP 4
.B About...
Displays the version number of this program, \fIxscreensaver-demo\fP.
.TP 4
.B Documentation...
Opens up a web browser looking at the XScreenSaver web page, where you
can find online copies of the
.BR xscreensaver (1),
.BR xscreensaver\-demo (1),
and
.BR xscreensaver\-command (1)
manuals.
.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 behavior of the screen saver.  The options are:
.RS 8
.TP 8
.B Random Screen Saver
When blanking the screen, select a random display mode from among those
that are enabled and applicable.  This is the default.
.TP 8
.B Only One Screen Saver
When blanking the screen, only ever use one particular display mode (the
one selected in the list.)
.TP 8
.B Blank Screen Only
When blanking the screen, just go black: don't run any graphics hacks.
.TP 8
.B Disable Screen Saver
Don't ever blank the screen, and don't ever allow the monitor to power down.

.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.
Clicking the mouse again will stop the demo and un-blank the screen, making
the dialog box visible again.

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.)

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 
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
.B Blank After
After the user has been idle this long, the \fIxscreensaver\fP daemon
will blank the screen.
.TP 4
.B Cycle After
jAfter the screensaver has been running for this long, the currently
running graphics demo will be killed, and a new one started.  
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
.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 ADVANCED TAB
This tab lets you change various settings used by the xscreensaver daemon
itself, rather than its sub-programs.
.TP 4
.B Grab Desktop Images
Some of the graphics hacks manipulate 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 from disk, from the directory you specify in the text
entry field.  That directory will be recursively searched for files,
and it is assumed that all the files under that directory are images.

If more than one of these 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.  

(All three of these options work by invoking the
.BR xscreensaver\-getimage (1)
program, which is what actually does the work.)
.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.)

If you change this option, it will only take effect the next time the
xscreensaver daemon is restarted.  (All other settings take effect
immediately.)
.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.
.TP 4
.B Power Management Enabled
Whether the monitor should be powered down after a period of inactivity.

If this option is grayed out, it means your X server does not support
the XDPMS extension, and so control over the monitor's power state is
not available.

If you're using a laptop, don't be surprised if this has no effect:
many laptops have monitor power-saving behavior built in at a very low
level that is invisible to Unix and X.  On such systems, you can 
typically only adjust the power-saving delays by changing settings 
in the BIOS in some hardware-specific way.
.TP 4
.B Standby After
If \fIPower Management Enabled\fP is selected, the monitor will go black
after this much idle time.  (Graphics demos will stop running, also.)
.TP 4
.B Suspend After
If \fIPower Management Enabled\fP is selected, the monitor will go
into power-saving mode after this much idle time.  This duration should
be greater than or equal to \fIStandby\fP.
.TP 4
.B Off After
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
.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.
.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.  (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
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.
.PP
There are more settings than these available, but these are the most 
commonly used ones; see the manual for
.BR xscreensaver (1)
for other parameters that can be set by editing the \fI~/.xscreensaver\fP
file, or the X resource database.
.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 may 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.  It also lets you configure the X visual type that
this mode 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.  (OpenGL programs should always have their visual set to "GL".)
.SH COMMAND-LINE OPTIONS
.I xscreensaver\-demo
accepts the following command line options.
.TP 8
.B \-display \fIhost:display.screen\fP
The X display to use.  The \fIxscreensaver\-demo\fP program will open its
window on that display, and also control the \fIxscreensaver\fP daemon that
is managing that same display.
.TP 8
.B \-prefs
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
that share a file system.  When \fIxscreensaver\-demo\fP writes a new version
of the \fI~/.xscreensaver\fP file, it's important that the \fIxscreensaver\fP
see that same file.  If the two processes are seeing 
different \fI~/.xscreensaver\fP files, things will malfunction.
.SH ENVIRONMENT
.PP
.TP 8
.B DISPLAY
to get the default host and display number.
.TP 8
.B PATH
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.
.TP 8
.B HOME
for the directory in which to read and write the \fI.xscreensaver\fP file.
.TP 8
.B XENVIRONMENT
to get the name of a resource file that overrides the global resources
stored in the RESOURCE_MANAGER property.
.SH UPGRADES
The latest version can always be found at 
http://www.jwz.org/xscreensaver/
.SH SEE ALSO
.BR X (1),
.BR xscreensaver (1),
.BR xscreensaver\-command (1),
.BR xscreensaver\-getimage (1)
.SH COPYRIGHT
Copyright \(co 1992, 1993, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004
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.

Please let me know if you find any bugs or make any improvements.