.if n .sp 1
.if t .sp .5
..
-.TH XScreenSaver 1 "30-Oct-99 (3.19)" "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
.BR xscreensaver-command (1)
programs.
.SH CONFIGURATION
-Options to \fIxscreensaver\fP are specified in one of two places: in
+The easiest way to configure \fIxscreensaver\fP is to simply run the
+.BR xscreensaver-demo (1)
+program, and change the settings through the GUI. The rest of this
+manual page describes lower level ways of changing settings.
+
+Options to \fIxscreensaver\fP are stored in one of two places: in
a \fI.xscreensaver\fP file in your home directory; or in the X resource
database. If the \fI.xscreensaver\fP file exists, it overrides any settings
in the resource database.
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
.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
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.)
time to run a different demo: the old one is killed and a new one is launched.
Before launching a subprocess, \fIxscreensaver\fP stores an appropriate value
-for \fB$DISPLAY\fP in the environment that the child will recieve. (This is
+for \fB$DISPLAY\fP in the environment that the child will receive. (This is
so that if you start \fIxscreensaver\fP with a \fI-display\fP argument, the
programs which \fIxscreensaver\fP launches will draw on the same display;
and so that the child will end up drawing on the appropriate screen of a
.SH POWER MANAGEMENT
Modern X servers contain support to power down the monitor after an idle
period. If the monitor has powered down, then \fIxscreensaver\fP will
-notice this, 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.
+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
+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)
-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
-.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)
To the file \fI/usr/lib/X11/xdm/Xsetup\fP, add the lines
.EX
+xhost +localhost
xscreensaver-command -exit
xscreensaver &
.EE
.BR xauth (1),
and
.BR xhost (1).
+.SH USING GDM(1)
+The instructions for using \fIxscreensaver\fP with
+.BR gdm (1)
+are almost the same as for using
+.BR xdm (1),
+above. There are only two differences, really: instead
+of editing \fI/usr/lib/X11/xdm/Xsetup\fP, edit the
+file \fI/etc/X11/gdm/Init/Default\fP; and instead of
+editing \fI/usr/lib/X11/xdm/Xsession\fP, edit one or all of the
+files in the \fI/etc/X11/gdm/Sessions/\fP directory. (Note that
+the default session (\fI/etc/X11/gdm/Sessions/Default\fP) usually
+simply executes \fI/usr/lib/X11/xdm/Xsession\fP, so be careful
+you aren't initializing xscreensaver twice.)
+
+All the same caveats apply for
+.BR gdm (1)
+as for
+.BR xdm (1).
.SH USING CDE (COMMON DESKTOP ENVIRONMENT)
The easiest way to use \fIxscreensaver\fP on a system with CDE is to simply
switch off the built-in CDE screensaver, and use \fIxscreensaver\fP instead;
.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
directly into the root menu.
.RE
-Other window managers are guaranteed to do things gratuitously differently.
+For Fvwm2, the process is similar: first create a \fI~/.fvwm2rc\fP file
+if you don't already have one, by making a copy of
+the \fI/etc/X11/fvwm2/system.fvwm2rc\fP file. Then, add a menu definition
+to it:
+.EX
+AddToMenu XScreenSaver "XScreenSaver" Title
++ "Blank Screen Now" Exec xscreensaver-command -activate
++ "Lock Screen Now" Exec xscreensaver-command -lock
++ "Screen Saver Demo" Exec xscreensaver-command -demo
++ "Screen Saver Preferences" Exec xscreensaver-command -prefs
++ "Reinitialize Screen Saver" Exec xscreensaver-command -restart
++ "Kill Screen Saver" Exec xscreensaver-command -exit
++ "Launch Screen Saver" Exec xscreensaver
++ "Run Next Demo" Exec xscreensaver-command -next
++ "Run Previous Demo" Exec xscreensaver-command -prev
+
+# To put the XScreenSaver sub-menu at the end of the root menu:
+AddToMenu RootMenu "XScreenSaver" Popup XScreenSaver
+.EE
+The Enlightenment window manager keeps each of its menus in a separate
+file. So, you need to create a file
+named \fI~/.enlightenment/xscreensaver.menu\fP with the contents:
+.EX
+"XScreenSaver Commands"
+ "Blank Screen Now" NULL exec "xscreensaver-command -activate"
+ "Lock Screen Now" NULL exec "xscreensaver-command -lock"
+ "Screen Saver Demo" NULL exec "xscreensaver-command -demo"
+ "Screen Saver Prefs" NULL exec "xscreensaver-command -prefs"
+ "Reinitialize Saver" NULL exec "xscreensaver-command -restart"
+ "Kill Screen Saver" NULL exec "xscreensaver-command -exit"
+ "Launch Screen Saver" NULL exec "xscreensaver"
+.EE
+then add
+.EX
+ "XScreenSaver" NULL menu "xscreensaver.menu"
+.EE
+to \fI~/.enlightenment/file.menu\fP to put the XScreenSaver submenu on
+your left-button root-window menu.
+
+As you see, every window manager does this stuff gratuitously differently,
+just to make your life difficult. You are in a maze of twisty menu
+configuration languages, all alike.
.SH BUGS
Bugs? There are no bugs. Ok, well, maybe. If you find one, please let
me know. http://www.jwz.org/xscreensaver/bugs.html explains how to
.BR X (1),
.BR xscreensaver\-demo (1),
.BR xscreensaver\-command (1),
+.BR xscreensaver\-gl\-helper (1),
.BR xdm (1),
.BR xset (1),
.BR Xsecurity (1),
.BR xjack (1),
.BR xlyap (1),
.BR xmatrix (1),
-.BR xroger (1),
.BR bongo (1),
.BR ico (1),
.BR xaos (1),
.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
+Copyright \(co 1991, 1992, 1993, 1994, 1995, 1996, 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
Please let me know if you find any bugs or make any improvements.
.SH ACKNOWLEDGEMENTS
+Thanks to Angela Goodman for the XScreenSaver logo.
+
Thanks to the many people who have contributed graphics demos to the package.
Thanks to David Wojtowicz for implementing \fIlockTimeout\fP.
projects / xscreensaver / blobdiff