http://ftp.x.org/contrib/applications/xscreensaver-3.22.tar.gz
[xscreensaver] / driver / xscreensaver.man
index 63b0d32586b2fa084a6eb57e8a98b2633e9fd9dc..4ea3794930b360febd6b9f0f468eb18793d539a6 100644 (file)
@@ -11,7 +11,7 @@
 .if n .sp 1
 .if t .sp .5
 ..
-.TH XScreenSaver 1 "15-Mar-99 (3.08)" "X Version 11"
+.TH XScreenSaver 1 "09-Dec-99 (3.22)" "X Version 11"
 .SH NAME
 xscreensaver - graphics hack and screen locker, launched when the user is idle
 .SH SYNOPSIS
@@ -190,6 +190,10 @@ one plane (that is, it's not monochrome.)
 .B color
 Use the best of the color visuals, if there are any.
 .TP 8
+.B GL
+Use the visual that is best for OpenGL programs.  (OpenGL programs have
+somewhat different requirements than other X programs.)
+.TP 8
 .I class
 where \fIclass\fP is one of \fBStaticGray\fP, \fBStaticColor\fP, 
 \fBTrueColor\fP, \fBGrayScale\fP, \fBPseudoColor\fP, or \fBDirectColor\fP.
@@ -442,6 +446,8 @@ The drawback to doing this is that perhaps you \fIreally do\fP want idleness
 on the X console to cause the X display to lock, even if there is activity
 on other virtual consoles.  If you want that, then set this option to False.
 (Or just lock the X console manually.)
+
+The default value for this resource is True, on systems where it works.
 .TP 8
 .B overlayStderr\fP (class \fBBoolean\fP)
 If \fBcaptureStderr\fP is True, and your server supports ``overlay'' visuals,
@@ -870,7 +876,48 @@ popup menu.  Alternately, you could just put the xscreensaver menu items
 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
@@ -1119,39 +1166,8 @@ overengineered and broken \fBMIT-SCREEN-SAVER\fP extension.
 If you're running Irix 6.3, you might find that your monitor is powering down
 after an hour or two even if you've told it not to.  This is fixed by SGI
 patches 2447 and 2537.
-.TP 8
-.B OpenGL Programs and Visuals
-Some of the graphics demos included with xscreensaver make use of the 
-OpenGL (or MesaGL) 3D library, if it is available.  It is possible (even 
-likely) that \fIxscreensaver\fP's notion of the ``\fIbest\fP'' visual is 
-not quite right for these GL programs.  
-
-The odd thing about GL programs is that, unlike normal X11 programs, they
-tend to work best on a visual \fIhalf\fP as deep as the depth of the screen,
-since that way, they can do double-buffering.  Try it and see, but you will
-probably find that, for these particular programs, you should specify the
-deepest visual that is half as deep as the screen.  (See the discussion
-of the \fBprograms\fP resource in the \fIConfiguration\fP section, above.)
-
-For example, on a screen that supports both 24-bit TrueColor and 12-bit
-PseudoColor visuals, the 12-bit visual will probably work best (this is true
-of base-model SGI Indys: the 0x29 visual is the one you want.)  
-
-Oddly, on SGI O2s (machines that have serious hardware support for GL), the
-12-bit PseudoColor visual looks awful (you get a black and white, flickery
-image.)  On these machines, the visual you want turns out to be 0x31.
-However, 0x31 is but \fIone\fP of the \fIeight\fP 15-bit TrueColor visuals
-(yes, 8, and yes, 15) that the O2 X server provides.  This is the only visual
-that works properly: as far as
-.BR xdpyinfo (1)
-is concerned, all of the 15-bit TrueColor visuals are identical, but some
-flicker like mad, and some have deeply weird artifacts (such as hidden 
-surfaces that show through, as if depth worked backwards!)  
-
-I suppose these other visuals must be tied to some arcane hardware feature...
-If anyone would care to explain it to me, that would be great.
 
-Your mileage, therefore, may vary dramatically.
+If you're running Irix 6.5, this bug is back.  I don't know a fix.
 .TP 8
 .B MesaGL and Voodoo Cards
 If you have a 3Dfx/Voodoo card, the default settings for xscreensaver will
@@ -1180,6 +1196,14 @@ If you find that GL programs only work properly when run as root, and not
 as normal users, then the problem is that your \fI/dev/3dfx\fP file is not
 configured properly.  Check the Linux 3Dfx FAQ.
 .TP 8
+.B Keyboard LEDs
+If \fIprocInterrupts\fP is on (which is the default on Linux systems) and
+you're using some program that toggles the state of your keyboard LEDs,
+xscreensaver won't work right: turning those LEDs on or off causes a 
+keyboard interrupt, which xscreensaver will interpret as user activity.
+So if you're using such a program, set the \fIprocInterrupts\fP resource
+to False.
+.TP 8
 .B Extensions
 If you are not making use of one of the server extensions (\fBXIDLE\fP,
 \fBSGI SCREEN_SAVER\fP, or \fBMIT-SCREEN-SAVER\fP), then it is possible, in 
@@ -1235,20 +1259,30 @@ http://www.jwz.org/xscreensaver/
 .BR bouboule (1),
 .BR braid (1),
 .BR bsod (1),
+.BR bubble3d (1),
 .BR bubbles (1),
 .BR cage (1),
+.BR compass (1),
 .BR coral (1),
+.BR critical (1),
+.BR crystal (1),
 .BR cynosure (1),
 .BR decayscreen (1),
 .BR deco (1),
+.BR deluxe (1),
+.BR demon (1),
+.BR discrete (1),
+.BR distort (1),
 .BR drift (1),
 .BR epicycle (1),
 .BR fadeplot (1),
 .BR flag (1),
 .BR flame (1),
+.BR flow (1),
 .BR forest (1),
 .BR galaxy (1),
 .BR gears (1),
+.BR glplanet (1),
 .BR goop (1),
 .BR grav (1),
 .BR greynetic (1),
@@ -1262,11 +1296,14 @@ http://www.jwz.org/xscreensaver/
 .BR jigsaw (1),
 .BR julia (1),
 .BR kaleidescope (1),
+.BR kumppa (1),
+.BR lament (1),
 .BR laser (1),
 .BR lightning (1),
 .BR lisa (1),
 .BR lissie (1),
 .BR lmorph (1),
+.BR loop (1),
 .BR maze (1),
 .BR moebius (1),
 .BR moire (1),
@@ -1276,8 +1313,12 @@ http://www.jwz.org/xscreensaver/
 .BR munch (1),
 .BR noseguy (1),
 .BR pedal (1),
+.BR penetrate (1),
 .BR penrose (1),
+.BR petri (1),
+.BR phosphor (1),
 .BR pipes (1),
+.BR pulsar (1),
 .BR pyro (1),
 .BR qix (1),
 .BR rd-bomb (1),
@@ -1288,20 +1329,27 @@ http://www.jwz.org/xscreensaver/
 .BR sierpinski (1),
 .BR slidescreen (1),
 .BR slip (1),
+.BR sonar (1),
 .BR sphere (1),
 .BR spiral (1),
+.BR spotlight (1),
 .BR sproingies (1),
+.BR squiral (1),
 .BR stairs (1),
 .BR starfish (1),
 .BR strange (1),
 .BR superquadrics (1),
 .BR swirl (1),
+.BR t3d (1),
 .BR triangle (1),
 .BR truchet (1),
 .BR vines (1),
+.BR wander (1),
 .BR worm (1),
+.BR xflame (1),
 .BR xjack (1),
 .BR xlyap (1),
+.BR xmatrix (1),
 .BR xroger (1),
 .BR bongo (1),
 .BR ico (1),
@@ -1331,16 +1379,21 @@ to comp.sources.x on 13-Aug-1992.
 
 Please let me know if you find any bugs or make any improvements.
 .SH ACKNOWLEDGEMENTS
+Thanks to the many people who have contributed graphics demos to the package.
+
 Thanks to David Wojtowicz for implementing \fIlockTimeout\fP.
 
 Thanks to Martin Kraemer for adding support for shadow passwords and
 locking-disabled diagnostics.
 
-Thanks to the many people who have contributed graphics demos to the package.
-
 Thanks to Patrick Moreau for the VMS port.
 
 Thanks to Mark Bowyer for figuring out how to hook it up to CDE.
 
-And huge thanks to Jon A. Christopher for implementing the Athena dialog
-support, back in the days before Lesstif was a viable alternative to Motif.
+Thanks to Nat Lanza for the Kerberos support.
+
+Thanks to Bill Nottingham for the initial PAM support.
+
+And thanks to Jon A. Christopher for implementing the Athena dialog
+support, back in the days before Lesstif or Gtk were viable alternatives
+to Motif.