http://ftp.x.org/contrib/applications/xscreensaver-2.24.tar.gz
[xscreensaver] / driver / xscreensaver.man
index ce5756bb6b5b8c59a7e0917994d95430e8aec24a..3db467c4726038606295c727a3d83a45d62637f1 100644 (file)
@@ -11,7 +11,7 @@
 .if n .sp 1
 .if t .sp .5
 ..
-.TH XScreenSaver 1 "15-Jun-98 (2.21)" "X Version 11"
+.TH XScreenSaver 1 "30-Jun-98 (2.24)" "X Version 11"
 .SH NAME
 xscreensaver - graphics hack and screen locker, launched when the user is idle
 .SH SYNOPSIS
@@ -546,6 +546,25 @@ For all the gory details, see the commentary at the top of xscreensaver.c.
 You can control a running screensaver process by using the
 .BR xscreensaver\-command (1)
 program (which see.)
+.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.
+
+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
+.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.)
 .SH USING XDM(1)
 You can run \fIxscreensaver\fP from your xdm session, so that the 
 screensaver will run even when nobody is logged in on the console.  
@@ -583,6 +602,27 @@ locking; for example, by using this pair of commands:
 xscreensaver-command -exit
 xscreensaver
 .EE
+If you get "connection refused" errors when running \fIxscreensaver\fP
+from \fIxdm\fP, then this probably means that you have
+.BR xauth (1)
+or some other security mechanism turned on.  One way around this is to
+add \fB"xhost\ +localhost"\fP to \fIXsetup\fP, just before \fIxscreensaver\fP
+is launched.  
+
+Note that this will give access to the X server to anyone capable of logging
+in to the local machine, so in some environments, this might not be 
+appropriate.  If turning off file-system-based access control is not
+acceptable, then running \fIxscreensaver\fP from \fIxdm\fP might not be
+possible, and users will have to launch it themselves instead of having it
+be launched by \fIxdm\fP before anyone logs in.
+
+For more information on the X server's access control mechanisms, see the
+man pages for
+.BR X (1),
+.BR Xsecurity (1),
+.BR xauth (1),
+and
+.BR xhost (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;
@@ -658,10 +698,16 @@ under VUE are similar to the above:
 .RS 4
 .TP 3
 \fB1: Switch off VUE's locker\fP
-Do this by turning off ``\fIScreen Saver and Screen Lock\fP'' in the
-Screen section of the Style Manager.
+Open the ``\fIStyle Manager\fP'' and select ``\fIScreen\fP.''
+Turn off ``\fIScreen Saver and Screen Lock\fP'' option.
 .TP 3
-\fB2: Edit vue.session\fP
+\fB2: Make sure you have a Session\fP
+Next, go to the Style Manager's, ``\fIStartup\fP'' page.
+Click on ``\fISet Home Session\fP'' to create a session, then 
+on ``\fIReturn to Home Session\fP'' to select this session each
+time you log in.
+.TP 3
+\fB3: Edit vue.session\fP
 Edit the file \fI~/.vue/sessions/home/vue.session\fP and add to it
 the line
 .EX
@@ -700,7 +746,7 @@ or (probably) any of \fItwm\fP's many descendants, you can do it like this:
 .TP 3
 \fB1. Create ~/.mwmrc (or ~/.twmrc or ...)\fP
 If you don't have a \fI~/.mwmrc\fP file (or, on SGIs, a \fI~/.4Dwmrc\fP file;
-or, with TWM, a \fI~/.twmrc\fP file) then create one by making a copy of
+or, with twm, a \fI~/.twmrc\fP file) then create one by making a copy of
 the \fI/usr/lib/X11/system.mwmrc\fP 
 file (or \fI/usr/lib/X11/twm/system.twmrc\fP, and so on.)
 .TP 3
@@ -789,13 +835,16 @@ in code intended for use as a screensaver.  This prevents too much graphics
 activity from being buffered up.
 .TP 8
 .B Locking and XDM
-If xscreensaver has been launched from XDM, you will need to cause the
-xscreensaver daemon to exit and restart in order to lock the screen.
+If xscreensaver has been launched from 
+.BR xdm (1),
+you will need to cause the xscreensaver daemon to exit and restart in 
+order to lock the screen.
 
-The reason for this is, if xscreensaver has been launched by XDM, that
-means it was launched \fIbefore\fP you logged in: so it has no way of
-knowing who the logged-in user is, and therefore, whose password it
-should prompt for.
+The reason for this is, if xscreensaver has been launched by 
+.BR xdm (1),
+that means it was launched \fIbefore\fP you logged in: so it has no way of
+knowing who the logged-in user is, and therefore, whose password it should
+prompt for.
 
 So if you want to use it as a locker, you must start it with your user id.
 If it has already been started by \fIxdm\fP, you can kill it by sending
@@ -805,6 +854,7 @@ something like the following in your personal X startup script:
 xscreensaver-command -exit
 xscreensaver &
 .EE
+See the ``\fIUsing XDM(1)\fP'' section, above, for more details.
 .TP 8
 .B Locking and root logins
 An implication of the above is that if you log in as \fIroot\fP on the
@@ -821,6 +871,24 @@ should log in as you, and
 to \fIroot\fP as necessary.  People who spend their day logged in 
 as \fIroot\fP are just begging for disaster.
 .TP 8
+.B XAUTH and XDM
+For xscreensaver to work when launched by
+.BR xdm (1),
+programs running on the local machine as user \fI"nobody"\fP must be
+able to connect to the X server.  This means that \fB"xhost +localhost"\fP
+is required if xscreensaver is to be launched by
+.BR xdm (1).
+This is \fInot\fP required if \fIxscreensaver\fP is launched by the
+individual users: it is only necessary when it is launched by
+.BR xdm (1),
+before any user has logged in.  See the ``\fIUsing XDM(1)\fP'' section, 
+above, for more details.
+
+If anyone has suggestions on how xscreensaver could be made to work with
+.BR xdm (1)
+without first turning off \fI.Xauthority\fP-based access control, please
+let me know.
+.TP 8
 .B Passwords
 If you get an error message like ``couldn't get password of \fIuser\fP'' 
 then this probably means that you're on a system in which the
@@ -972,6 +1040,10 @@ http://people.netscape.com/jwz/xscreensaver/
 .BR X (1),
 .BR xscreensaver\-command (1),
 .BR xdm (1),
+.BR xset (1),
+.BR Xsecurity (1),
+.BR xauth (1),
+.BR xhost (1).
 .BR ant (1),
 .BR atlantis (1),
 .BR attraction (1),