http://packetstormsecurity.org/UNIX/admin/xscreensaver-3.34.tar.gz
[xscreensaver] / driver / xscreensaver.man
index c08ed63b26b783c2b9e22271973e4200f07e4ba9..c52e1e4b7cf4a021abd6742174d92dd4931946df 100644 (file)
@@ -11,7 +11,7 @@
 .if n .sp 1
 .if t .sp .5
 ..
-.TH XScreenSaver 1 "13-Feb-2001 (3.29)" "X Version 11"
+.TH XScreenSaver 1 "25-Oct-2001 (3.34)" "X Version 11"
 .SH NAME
 xscreensaver - graphics hack and screen locker, launched when the user is idle
 .SH SYNOPSIS
@@ -167,6 +167,23 @@ should not be too large: the X server is grabbed for the duration that the
 password dialog box is up (for security purposes) and leaving the server 
 grabbed for too long can cause problems.
 .TP 8
+.B dpmsEnabled\fP (class \fBBoolean\fP)
+Whether power management is enabled.
+.TP 8
+.B dpmsStandby\fP (class \fBTime\fP)
+If power management is enabled, how long until the monitor goes solid black.
+.TP 8
+.B dpmsSuspend\fP (class \fBTime\fP)
+If power management is enabled, how long until the monitor goes into
+power-saving mode.
+.TP 8
+.B dpmsOff\fP (class \fBTime\fP)
+If power management is enabled, how long until the monitor powers down
+completely.  Note that these settings will have no effect unless both
+the X server and the display hardware support power management; not 
+all do.  See the \fIPower Management\fP section, below, for more 
+information.
+.TP 8
 .B visualID\fP (class \fBVisualID\fP)
 Specify which X visual to use by default.  (Note carefully that this resource
 is called \fBvisualID\fP, not merely \fBvisual\fP; if you set the \fBvisual\fP
@@ -266,6 +283,21 @@ 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: 50M.
+.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
@@ -311,8 +343,21 @@ When the screensaver starts up, one of these is selected at random, and
 run.  After the \fIcycle\fP period expires, it is killed, and another
 is selected and run.
 
-If the value of this resource is empty, then no programs will be run; the
-screen will simply be made black.
+If a line begins with a dash (-) then that particular program is
+disabled: it won't be selected at random (though you can still select
+it explicitly using the
+.BR xscreensaver\-demo (1)
+program.)
+
+If all programs are disabled, then the screen will just be made blank.
+
+To disable a program, it's better to mark it as disabled with a dash
+than to remove it from the list.  This is because the system-wide
+(app-defaults) and per-user (.xscreensaver) settings are merged
+together, and if a user just \fIdeletes\fP an entry from their programs
+list, but that entry still 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.)
@@ -599,18 +644,31 @@ notice this (after a few minutes), and will not waste CPU by drawing
 graphics demos on a black screen.  An attempt will also be made to
 explicitly power the monitor back up as soon as user activity is detected.
 
-If your X server supports power management, then
-.BR xset (1)
-will accept a \fBdpms\fP option.  So, if you wanted \fIxscreensaver\fP
-to activate after 5 minutes, but you wanted your monitor to power down
-after one hour (3600 seconds) you would do this:
-.EX
-xset dpms 3600
-.EE
-See the man page for the
+As of version 3.28, the \fI~/.xscreensaver\fP file controls the
+configuration of your display's power management settings: if you have
+used
 .BR xset (1)
-program for details.  (Note that power management requires both software
-support in the X server, and hardware support in the monitor itself.)
+to change your power management settings, then xscreensaver will
+override those changes with the values specified 
+in \fI~/.xscreensaver\fP (or with its built-in defaults, if there
+is no \fI~/.xscreensaver\fP file yet.)
+
+To change your power management settings, run
+.BR xscreensaver\-demo (1)
+and change the various timeouts through the user interface.
+Alternately, you can edit the \fI~/.xscreensaver\fP file directly.
+
+If the power management section is grayed out in the
+.BR xscreensaver\-demo (1)
+window,  then that means that 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 changing the DPMS
+settings 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.
 .SH USING XDM(1)
 You can run \fIxscreensaver\fP from your 
 .BR xdm (1)
@@ -763,6 +821,7 @@ Edit the file \fI~/.dt/sessions/sessionetc\fP and add to it the line
 .EX
 xscreensaver &
 .EE
+And make sure the sessionetc file is executable.
 This will cause \fIxscreensaver\fP to be launched when you log in.
 (As always, make sure that xscreensaver and the graphics demos are on
 your \fB$PATH\fP; the path needs to be set in \fI.cshrc\fP 
@@ -1387,6 +1446,7 @@ http://www.jwz.org/xscreensaver/
 .BR xswarm (1),
 .BR xtacy (1),
 .BR xv (1),
+.BR chbg (1),
 .BR xwave (1).
 .SH COPYRIGHT
 Copyright \(co 1991, 1992, 1993, 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001