ftp://ftp.krokus.ru/pub/OpenBSD/distfiles/xscreensaver-4.21.tar.gz
[xscreensaver] / driver / xscreensaver.man
index 5d9c4ba06d4876d379fe3f001e73bd4f7c48623b..5271a144abe5ce56f48de22aa926c7f4303678b7 100644 (file)
@@ -11,7 +11,7 @@
 .if n .sp 1
 .if t .sp .5
 ..
-.TH XScreenSaver 1 "20-May-2003 (4.10)" "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
@@ -231,7 +231,7 @@ Whether to print diagnostics.  Default false.
 .TP 8
 .B timestamp\fP (class \fBBoolean\fP)
 Whether to print the time of day along with any other diagnostic messages.
-Default false.
+Default true.
 .TP 8
 .B splash\fP (class \fBBoolean\fP)
 Whether to display a splash screen at startup.  Default true.
@@ -239,6 +239,10 @@ Whether to display a splash screen at startup.  Default true.
 .B splashDuration\fP (class \fBTime\fP)
 How long the splash screen should remain visible; default 5 seconds.
 .TP 8
+.B quad\fP (class \fBBoolean\fP)
+If true, then \fIfour\fP screensavers will be run on each monitor.
+Use at your own risk!
+.TP 8
 .B helpURL\fP (class \fBURL\fP)
 The splash screen has a \fIHelp\fP button on it.  When you press it, it will
 display the web page indicated here in your web browser.
@@ -266,23 +270,6 @@ system, and don't increase the load unnecessarily.  The default is 10.
 .BR nice (1)
 for details.)
 .TP 8
-.B memoryLimit\fP (class \fBMemoryLimit\fP)
-The sub-processes created by \fIxscreensaver\fP will not be allowed to
-allocate more than this much memory (more accurately, this is the maximum
-size their address space may become.)  If any sub-process tries to allocate
-more than this,
-.BR malloc (3)
-will fail, and the process will likely exit (or safely crash) rather than
-going forth and hogging memory.  
-
-The assumption here is that if one of the screenhacks is trying to use
-a lot of memory, then something has gone wrong, and it's better to kill
-that program than to overload the machine.
-
-Default: 0, meaning "no limit."  30M is a good choice on most systems.
-(But beware that setting this to a small value can cause OpenGL programs
-to malfunction on certain systems.)
-.TP 8
 .B fade\fP (class \fBBoolean\fP)
 If this is true, then when the screensaver activates, the current contents
 of the screen will fade to black instead of simply winking out.  This only
@@ -322,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.)
@@ -334,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.)
@@ -461,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.
@@ -472,12 +475,13 @@ seconds before selecting events on existing windows, under the assumption that
 \fIxscreensaver\fP is started during your login procedure, and the window 
 state may be in flux.  Default 0.  (This used to default to 30, but that was
 back in the days when slow machines and X terminals were more common...)
-.TP 8
-.B sgiSaverExtension\fP (class \fBBoolean\fP)
+.RE
+.PP
 There are a number of different X server extensions which can make
 xscreensaver's job easier.  The next few resources specify whether these
 extensions should be utilized if they are available.
-
+.TP 8
+.B sgiSaverExtension\fP (class \fBBoolean\fP)
 This resource controls whether the SGI \fBSCREEN_SAVER\fP server extension
 will be used to decide whether the user is idle.  This is the default 
 if \fIxscreensaver\fP has been compiled with support for this 
@@ -491,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
@@ -760,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 
@@ -1328,14 +1336,13 @@ and a FAQ can always be found at http://www.jwz.org/xscreensaver/
 .BR zoom (1)
 .SH COPYRIGHT
 Copyright \(co 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999,
-2000, 2001, 2002, 2003 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.