http://nanonyme.dy.fi/mirrors/hvl/distfiles/xscreensaver/xscreensaver-5.03.tar.gz
[xscreensaver] / driver / xscreensaver.man
index 6f9f32c833d3a9e1504af6335c93cfcc0fa3d4cf..0d2f65fc14f856211ee52aaef769c5080d8be192 100644 (file)
@@ -11,7 +11,7 @@
 .if n .sp 1
 .if t .sp .5
 ..
-.TH XScreenSaver 1 "26-Feb-2004 (4.15)" "X Version 11"
+.TH XScreenSaver 1 "20-Mar-2005 (4.21)" "X Version 11"
 .SH NAME
 xscreensaver - extensible screen saver framework, plus locking
 .SH SYNOPSIS
@@ -309,6 +309,11 @@ if an attempt is made to run the nonexistent program.  Also, the
 program will suppress the non-existent programs from the list if this
 is true.  Default: false.
 .TP 8
+.B GetViewPortIsFullOfLies\fP (class \fBBoolean\fP)
+Set this to true if the xscreensaver window doesn't cover the whole screen.
+This works around a longstanding XFree86 bug #421.  See the 
+xscreensaver FAQ for details.
+.TP 8
 .B font\fP (class \fBFont\fP)
 The font used for the stdout/stderr text, if \fBcaptureStderr\fP is true.
 Default \fB*\-medium\-r\-*\-140\-*\-m\-*\fP (a 14 point fixed-width font.)
@@ -321,6 +326,11 @@ Controls the behavior of xscreensaver.  Legal values are:
 When blanking the screen, select a random display mode from among those
 that are enabled and applicable.  This is the default.
 .TP 8
+.B random-same
+Like \fIrandom\fP, but if there are multiple screens, each screen
+will run the \fIsame\fP random display mode, instead of each screen
+running a different one.
+.TP 8
 .B one
 When blanking the screen, only ever use one particular display mode (the
 one indicated by the \fIselected\fP setting.)
@@ -367,7 +377,7 @@ exists in the system-wide list, then it will come back.  However, if the
 user \fIdisables\fP it, then their setting takes precedence.
 
 If the display has multiple screens, then a different program will be run
-for each screen.  (All screens are blanked and unblanked simultaniously.)
+for each screen.  (All screens are blanked and unblanked simultaneously.)
 
 Note that you must escape the newlines; here is an example of how you
 might set this in your \fI~/.xscreensaver\fP file:
@@ -448,6 +458,12 @@ When server extensions are not in use, this controls how
 frequently \fIxscreensaver\fP checks to see if the mouse position or buttons
 have changed.  Default 5 seconds.
 .TP 8
+.B pointerHysteresis\fP (class \fBInteger\fP)
+If the mouse moves less than this-many pixels in a second, ignore it
+(do not consider that to be "activity.")  This is so that the screen
+doesn't un-blank (or fail to blank) just because you bumped the desk.
+Default: 10 pixels.
+.TP 8
 .B windowCreationTimeout\fP (class \fBTime\fP)
 When server extensions are not in use, this controls the delay between when 
 windows are created and when \fIxscreensaver\fP selects events on them.
@@ -479,7 +495,8 @@ This resource controls whether the \fBMIT\-SCREEN\-SAVER\fP server extension
 will be used to decide whether the user is idle.  However, the default for
 this resource is \fIfalse\fP, because even if this extension is available,
 it is flaky (and it also makes the \fBfade\fP option not work properly.)
-Use of this extension is not recommended.
+Use of this extension is strongly discouraged.  Support for it will
+probably be removed eventually.
 .TP 8
 .B xidleExtension\fP (class \fBBoolean\fP)
 This resource controls whether the \fBXIDLE\fP server extension will be
@@ -748,6 +765,9 @@ In this situation, the \fIxscreensaver\fP process will probably be running
 as user \fIgdm\fP instead of \fIroot\fP.  You can configure the settings
 for this nobody-logged-in state (timeouts, DPMS, etc.) by editing
 the \fI~gdm/.xscreensaver\fP file.
+
+To get gdm to run the BackgroundProgram, you may need to switch it from
+the "Graphical Greeter" to the "Standard Greeter".
 .SH USING KDE (K DESKTOP ENVIRONMENT)
 I understand that KDE has invented their own wrapper around xscreensaver,
 that is inferior to 
@@ -758,16 +778,16 @@ this is the way you disable it:
 .TP 3
 \fB1: Switch off KDE's screen saver.\fP
 Open the ``\fIControl Center\fP'' and
-select the ``\fILook and Feel / Screensaver\fP'' page.
-Turn off the ``\fIEnable Screensaver\fP'' checkbox.
+select the ``\fIAppearance & Themes -> Screensaver\fP'' page.
+Turn off the ``\fIStart Automatically\fP'' checkbox.
 .TP 3
 \fB2: Find your Autostart directory.\fP
-Open the ``\fILook and Feel / Desktop / Paths\fP'' page,
-and see what your ``Autostart'' directory is set to: it will
-probably be \fI~/.kde3/Autostart/\fP or something similar.
+Open the ``\fISystem Administration -> Paths\fP'' page,
+and see what your ``Autostart path'' is set to: it will
+probably be \fI~/.kde/Autostart/\fP or something similar.
 .TP 3
 \fB3: Make xscreensaver be an Autostart program.\fP
-Create a file in your autostart directory 
+Create a .desktop file in your autostart directory 
 called \fIxscreensaver.desktop\fP that contains the following five lines:
 .EX
 [Desktop Entry]
@@ -776,6 +796,16 @@ Name=XScreensaver
 Type=Application
 X-KDE-StartupNotify=false
 .EE
+.TP 3
+\fB4: Make the various "lock session" buttons call xscreensaver.\fP
+Replace the file \fI/usr/bin/kdesktop_lock\fP (or 
+possibly \fI/usr/kde/3.5/bin/kdesktop_lock\fP)
+with these two lines:
+.EX
+#!/bin/sh
+xscreensaver-command -lock
+.EE
+Make sure the file is executable (chmod a+x).
 .RE
 .PP
 Now use xscreensaver normally, controlling it via the usual
@@ -1013,7 +1043,7 @@ because X (really, ICCCM) does not provide a way for an OverrideRedirect
 window to have its own colormap, short of grabbing the server (which is 
 neither a good idea, nor really possible with the current design.)  What 
 happens is that, as soon as xscreensaver installs its colormap, \fBtwm\fP 
-responds to the resultant \fBColormapNotify\fP event by re-instaling the 
+responds to the resultant \fBColormapNotify\fP event by re-installing the 
 default colormap.  Apparently, \fBtwm\fP doesn't \fIalways\fP do this; it 
 seems to do it regularly if the screensaver is activated from a menu item, 
 but seems to not do it if the screensaver comes on of its own volition, or 
@@ -1094,7 +1124,7 @@ property of the (mis-) design of this server extension.
 
 It sure would be nice if someone would implement the \fBSGI SCREEN_SAVER\fP
 extension in XFree86; it's dead simple, and works far better than the
-overengineered and broken \fBMIT-SCREEN-SAVER\fP extension.
+over-engineered and broken \fBMIT-SCREEN-SAVER\fP extension.
 .TP 8
 .B Keyboard LEDs
 If \fIprocInterrupts\fP is on (which is the default on Linux systems) and
@@ -1143,187 +1173,23 @@ and a FAQ can always be found at http://www.jwz.org/xscreensaver/
 .BR X (1),
 .BR Xsecurity (1),
 .BR xauth (1),
+.BR xdm (1),
+.BR gdm (1),
+.BR xhost (1),
 .BR xscreensaver\-demo (1),
 .BR xscreensaver\-command (1),
 .BR xscreensaver\-gl\-helper (1),
 .BR xscreensaver\-getimage (1),
-.BR xdm (1),
-.BR gdm (1),
-.BR xset (1),
-.BR xhost (1).
-.BR anemone (1),
-.BR ant (1),
-.BR apollonian (1),
-.BR atlantis (1),
-.BR attraction (1),
-.BR barcode (1),
-.BR blaster (1),
-.BR blitspin (1),
-.BR bouboule (1),
-.BR boxed (1),
-.BR braid (1),
-.BR bsod (1),
-.BR bubble3d (1),
-.BR bubbles (1),
-.BR bumps (1),
-.BR cage (1),
-.BR ccurve (1),
-.BR circuit (1),
-.BR compass (1),
-.BR coral (1),
-.BR cosmos (1),
-.BR critical (1),
-.BR crystal (1),
-.BR cubenetic (1),
-.BR cynosure (1),
-.BR dangerball (1),
-.BR decayscreen (1),
-.BR deco (1),
-.BR deluxe (1),
-.BR demon (1),
-.BR discrete (1),
-.BR distort (1),
-.BR drift (1),
-.BR electricsheep (1),
-.BR endgame (1),
-.BR engine (1),
-.BR epicycle (1),
-.BR eruption (1),*
-.BR euler2d (1),
-.BR extrusion (1),
-.BR fadeplot (1),
-.BR flag (1),
-.BR flame (1),
-.BR flipscreen3d (1),
-.BR flow (1),
-.BR fluidballs (1),
-.BR flurry (1),
-.BR forest (1),
-.BR galaxy (1),
-.BR gears (1),
-.BR gflux (1),
-.BR glblur (1),
-.BR glforestfire (1),
-.BR glplanet (1),
-.BR glsnake (1),
-.BR gltext (1),
-.BR goban (1),
-.BR goop (1),
-.BR grav (1),
-.BR greynetic (1),
-.BR halftone (1),
-.BR halo (1),
-.BR helix (1),
-.BR hopalong (1),
-.BR hyperball (1),
-.BR hypercube (1),
-.BR ifs (1),
-.BR imsmap (1),
-.BR interference (1),
-.BR jigsaw (1),
-.BR juggle (1),
-.BR julia (1),
-.BR kaleidescope (1),
-.BR kumppa (1),
-.BR lament (1),
-.BR laser (1),
-.BR lavalite (1),
-.BR lightning (1),
-.BR lisa (1),
-.BR lissie (1),
-.BR lmorph (1),
-.BR loop (1),
-.BR maze (1),
-.BR menger (1),
-.BR metaballs (1),
-.BR moebius (1),
-.BR moire (1),
-.BR moire2 (1),
-.BR molecule (1),
-.BR morph3d (1),
-.BR mountain (1),
-.BR munch (1),
-.BR nerverot (1),
-.BR noseguy (1),
-.BR pedal (1),
-.BR penetrate (1),
-.BR penrose (1),
-.BR petri (1),
-.BR phosphor (1),
-.BR pipes (1),
-.BR polyominoes (1),
-.BR popsquares (1),
-.BR pulsar (1),
-.BR pyro (1),
-.BR qix (1),
-.BR queens (1),
-.BR rd-bomb (1),
-.BR ripples (1),
-.BR rocks (1),
-.BR rorschach (1),
-.BR rotor (1),
-.BR rotzoomer (1),
-.BR rubik (1),
-.BR sballs (1),
-.BR shadebobs (1),
-.BR sierpinski (1),
-.BR sierpinski3d (1),
-.BR slidescreen (1),
-.BR slip (1),
-.BR sonar (1),
-.BR speedmine (1),
-.BR sphere (1),
-.BR sphereEversion (1),
-.BR spheremonics (1),
-.BR spiral (1),
-.BR spotlight (1),
-.BR sproingies (1),
-.BR squiral (1),
-.BR ssystem (1),
-.BR stairs (1),
-.BR starfish (1),
-.BR starwars (1),
-.BR stonerview (1),
-.BR strange (1),
-.BR superquadrics (1),
-.BR swirl (1),
-.BR t3d (1),
-.BR thornbird (1),
-.BR triangle (1),
-.BR truchet (1),
-.BR twang (1),
-.BR vermiculate (1),
-.BR vidwhacker (1),
-.BR vines (1),
-.BR wander (1),
-.BR webcollage (1),
-.BR whirlwindwarp (1),
-.BR whirlygig (1),
-.BR worm (1),
-.BR xaos (1),
-.BR xdaliclock (1),
-.BR xearth (1),
-.BR xfishtank (1),
-.BR xflame (1),
-.BR xjack (1),
-.BR xlyap (1),
-.BR xmatrix (1),
-.BR xmountains (1),
-.BR xrayswarm (1),
-.BR xsnow (1),
-.BR xspirograph (1),
-.BR xteevee (1),
-.BR zoom (1)
+.BR xscreensaver\-text (1).
 .SH COPYRIGHT
 Copyright \(co 1991, 1992, 1993, 1994, 1995, 1996, 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.
+2000, 2001, 2002, 2003, 2004, 2005 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>.  Written in late 1991; version 1.0 posted
 to comp.sources.x on 17-Aug-1992.