git.hungrycats.org Git - xscreensaver/blob - hacks/boxfit.man

   1 .TH XScreenSaver 1 "" "X Version 11"
   2 .SH NAME
   3 boxfit - fills space with a gradient of growing boxes or circles.
   4 .SH SYNOPSIS
   5 .B boxfit
   6 [\-display \fIhost:display.screen\fP]
   7 [\-visual \fIvisual\fP]
   8 [\-window]
   9 [\-root]
  10 [\-delay \fIusecs\fP]
  11 [\-count \fIint\fP]
  12 [\-growby \fIint\fP]
  13 [\-spacing \fIint\fP]
  14 [\-border \fIint\fP]
  15 [\-circles | \-squares | \-random]
  16 [\-grab]
  17 [\-peek]
  18 [\-fps]
  19 .SH DESCRIPTION
  20 Packs the screen with growing boxes or circles, colored according to a
  21 horizontal or vertical gradient.  The objects grow until they touch,
  22 then stop.  When the screen is full, they shrink away and the process
  23 restarts.
  24 .SH OPTIONS
  25 .TP 8
  26 .B \-visual \fIvisual\fP
  27 Specify which visual to use.  Legal values are the name of a visual class,
  28 or the id number (decimal or hex) of a specific visual.
  29 .TP 8
  30 .B \-window
  31 Draw on a newly-created window.  This is the default.
  32 .TP 8
  33 .B \-root
  34 Draw on the root window.
  35 .TP 8
  36 .B \-delay \fImicroseconds\fP
  37 How much of a delay should be introduced between steps of the animation.
  38 Default 20000, or about 0.02 seconds.
  39 .TP 8
  40 .B \-count \fIint\fP
  41 How many boxes or circles to animate simultaneously; default 50.
  42 Smaller numbers yield larger boxes/circles.
  43 .TP 8
  44 .B \-growby \fIint\fP
  45 How many pixels the objects should grow by, each frame.  Default 1.
  46 .TP 8
  47 .B \-spacing \fIint\fP
  48 How many pixels of space should be left between the objects.  Default 1.
  49 .TP 8
  50 .B \-border \fIint\fP
  51 Thickness of the colored border around each object.  Default 1.
  52 .TP 8
  53 .B \-circles\fB | \-squares\fP | \-random\fP
  54 Draw circles, squares, or choose randomly (the default).
  55 .TP 8
  56 .B \-grab
  57 Normally it colors the boxes with a horizontal or vertical gradient.
  58 If \fI\-grab\fP is specified, it will instead load a random image,
  59 and color the boxes according to the colors in that image.
  60 As the picture fills in, some features of the underlying image
  61 may become recognisable.
  62
  63 When grabbing images, the image will be grabbed from the portion of
  64 the screen underlying the window, or from the system's video input,
  65 or from a random file on disk, as indicated by
  66 the \fIgrabDesktopImages\fP, \fIgrabVideoFrames\fP,
  67 and \fIchooseRandomImages\fP options in the \fI~/.xscreensaver\fP
  68 file; see
  69 .BR xscreensaver-demo (1)
  70 for more details.
  71 .TP 8
  72 .B \-peek
  73 This option says to briefly show you the underlying image before
  74 beginning.  The default is not to show the unadulterated image at all.
  75 (This only has an effect when \fI\-grab\fP is used.)
  76 .TP 8
  77 .B \-fps
  78 Display the current frame rate and CPU load.
  79 .SH ENVIRONMENT
  80 .PP
  81 .TP 8
  82 .B DISPLAY
  83 to get the default host and display number.
  84 .TP 8
  85 .B XENVIRONMENT
  86 to get the name of a resource file that overrides the global resources
  87 stored in the RESOURCE_MANAGER property.
  88 .SH SEE ALSO
  89 .BR X (1),
  90 .BR xscreensaver (1)
  91 .BR xscreensaver\-demo (1),
  92 .BR xscreensaver\-getimage (1)
  93 .SH COPYRIGHT
  94 Copyright \(co 2005 by Jamie Zawinski.  Permission to use, copy, modify,
  95 distribute, and sell this software and its documentation for any purpose is
  96 hereby granted without fee, provided that the above copyright notice appear
  97 in all copies and that both that copyright notice and this permission notice
  98 appear in supporting documentation.  No representations are made about the
  99 suitability of this software for any purpose.  It is provided "as is" without
 100 express or implied warranty.
 101 .SH AUTHOR
 102 Jamie Zawinski <jwz@jwz.org>