ftp://ftp.krokus.ru/pub/OpenBSD/distfiles/xscreensaver-4.21.tar.gz
[xscreensaver] / hacks / boxfit.man
index 49b4f57394fd7f0fc5d6739bdf275fe72866ea50..ffd74419357d2ee9a4009aacd8aebfa687399904 100644 (file)
@@ -13,6 +13,8 @@ boxfit - fills space with a gradient of growing boxes or circles.
 [\-spacing \fIint\fP]
 [\-border \fIint\fP]
 [\-circles | \-squares | \-random]
 [\-spacing \fIint\fP]
 [\-border \fIint\fP]
 [\-circles | \-squares | \-random]
+[\-grab]
+[\-peek]
 .SH DESCRIPTION
 Packs the screen with growing boxes or circles, colored according to a
 horizontal or vertical gradient.  The objects grow until they touch,
 .SH DESCRIPTION
 Packs the screen with growing boxes or circles, colored according to a
 horizontal or vertical gradient.  The objects grow until they touch,
@@ -49,6 +51,27 @@ Thickness of the colored border around each object.  Default 1.
 .TP 8
 .B \-circles\fB | \-squares\fP | \-random\fP
 Draw circles, squares, or choose randomly (the default).
 .TP 8
 .B \-circles\fB | \-squares\fP | \-random\fP
 Draw circles, squares, or choose randomly (the default).
+.TP 8
+.B \-grab
+Normally it colors the boxes with a horizontal or vertical gradient.
+If \fI\-grab\fP is specified, it will instead load a random image,
+and color the boxes according to the colors in that image.
+As the picture fills in, some features of the underlying image
+may become recognisable.
+
+When grabbing images, the image will be grabbed from the portion of
+the screen underlying the 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.
+.TP 8
+.B \-peek
+This option says to briefly show you the underlying image before
+beginning.  The default is not to show the unadulterated image at all.
+(This only has an effect when \fI\-grab\fP is used.)
 .SH ENVIRONMENT
 .PP
 .TP 8
 .SH ENVIRONMENT
 .PP
 .TP 8
@@ -61,6 +84,8 @@ stored in the RESOURCE_MANAGER property.
 .SH SEE ALSO
 .BR X (1),
 .BR xscreensaver (1)
 .SH SEE ALSO
 .BR X (1),
 .BR xscreensaver (1)
+.BR xscreensaver\-demo (1),
+.BR xscreensaver\-getimage (1)
 .SH COPYRIGHT
 Copyright \(co 2005 by Jamie Zawinski.  Permission to use, copy, modify, 
 distribute, and sell this software and its documentation for any purpose is 
 .SH COPYRIGHT
 Copyright \(co 2005 by Jamie Zawinski.  Permission to use, copy, modify, 
 distribute, and sell this software and its documentation for any purpose is