http://packetstormsecurity.org/UNIX/admin/xscreensaver-3.32.tar.gz
[xscreensaver] / hacks / blitspin.man
index e80ccf75e0888cf287a5abc7c032599d31ebb5cf..0d2b9fbbbee17538f036857d45b8422f18539d84 100644 (file)
@@ -1,9 +1,12 @@
-.TH XScreenSaver 1 "17-aug-92" "X Version 11"
+.TH XScreenSaver 1 "24-Nov-97" "X Version 11"
 .SH NAME
 blitspin - rotate a bitmap in an interesting way
 .SH SYNOPSIS
 .B blitspin
-[\-display \fIhost:display.screen\fP] [\-foreground \fIcolor\fP] [\-background \fIcolor\fP] [\-window] [\-root] [\-mono] [\-bitmap \fIfilename\fP] [\-delay \fIusecs\fP] [\-delay2 \fIusecs\fP]
+[\-display \fIhost:display.screen\fP]
+[\-foreground \fIcolor\fP] [\-background \fIcolor\fP] [\-window] [\-root]
+[\-mono] [\-install] [\-visual \fIvisual\fP] [\-bitmap \fIfilename\fP]
+[\-delay \fIusecs\fP] [\-delay2 \fIusecs\fP]
 .SH DESCRIPTION
 The \fIblitspin\fP program repeatedly rotates a bitmap by 90 degrees by
 using logical operations: the bitmap is divided into quadrants, and the
@@ -25,47 +28,65 @@ Draw on the root window.
 .B \-mono 
 If on a color display, pretend we're on a monochrome display.
 .TP 8
-.B \-bitmap bitmap-name
+.B \-install
+Install a private colormap for the window.
+.TP 8
+.B \-visual \fIvisual\fP
+Specify which visual to use.  Legal values are the name of a visual class,
+or the id number (decimal or hex) of a specific visual.
+.TP 8
+.B \-bitmap \fIfilename\fP
 The file name of a bitmap to rotate.  It need not be square: it 
 will be padded with the background color.  If unspecified or the
 string \fI(default)\fP, a builtin bitmap is used.
 
-If support for the \fBXPM\fP library was enabled at compile-time, 
-the specified file may be in XPM format as well as XBM, and thus 
-may be a color image.
+If support for the \fIXPM\fP library was enabled at compile-time, 
+the specified file may be in \fIXPM\fP format as well as \fIXBM\fP, and 
+thus may be a color image.
 
 The \fB*bitmapFilePath\fP resource will be searched if the bitmap
 name is not a fully-qualified pathname.
-.SH ENVIRONMENT
+.TP 8
+.B \-grab\-screen
+If this option is specified, then the image which is spun will be grabbed
+from the portion of the screen underlying the blitspin window, or from
+the system's video input, or from a random file on disk, as indicated by
+the \fIgrabDesktopImages\fP, \fIgrabVideoFrames\fP, 
+and \fIchooseRandomImages\fP options in the \fI~/.xscreensaver\fP file;
+see
+.BR xscreensaver-demo (1)
+for more details.
 .PP
 .TP 8
-.B \-delay microseconds
+.B \-delay \fImicroseconds\fP
 How long to delay between steps of the rotation process, in microseconds.
 Default is 500000, one-half second.
 .PP
 .TP 8
-.B \-delay2 microseconds
+.B \-delay2 \fImicroseconds\fP
 How long to delay between each 90-degree rotation, in microseconds.
 Default is 500000, one-half second.
 .B DISPLAY
 to get the default host and display number.
-.TP 8
+.SH ENVIRONMENT
 .B XENVIRONMENT
 to get the name of a resource file that overrides the global resources
 stored in the RESOURCE_MANAGER property.
 .SH SEE ALSO
 .BR X (1),
-.BR xscreensaver (1)
+.BR xscreensaver (1),
+.BR xscreensaver-demo (1),
+.BR xscreensaver-getimage (1)
 .SH COPYRIGHT
-Copyright \(co 1992, 1993 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.
+Copyright \(co 1992, 1993, 1997, 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 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@lucid.com>, 17-aug-92.
+Jamie Zawinski <jwz@jwz.org>, 17-aug-92.
 
 Based on SmallTalk code which appeared in the August 1981 issue of Byte
 magazine.