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 .SH DESCRIPTION
  17 Packs the screen with growing boxes or circles, colored according to a
  18 horizontal or vertical gradient.  The objects grow until they touch,
  19 then stop.  When the screen is full, they shrink away and the process
  20 restarts.
  21 .SH OPTIONS
  22 .TP 8
  23 .B \-visual \fIvisual\fP
  24 Specify which visual to use.  Legal values are the name of a visual class,
  25 or the id number (decimal or hex) of a specific visual.
  26 .TP 8
  27 .B \-window
  28 Draw on a newly-created window.  This is the default.
  29 .TP 8
  30 .B \-root
  31 Draw on the root window.
  32 .TP 8
  33 .B \-delay \fImicroseconds\fP
  34 How much of a delay should be introduced between steps of the animation.
  35 Default 20000, or about 0.02 seconds.
  36 .TP 8
  37 .B \-count \fIint\fP
  38 How many boxes or circles to animate simultaneously; default 50.
  39 Smaller numbers yield larger boxes/circles.
  40 .TP 8
  41 .B \-growby \fIint\fP
  42 How many pixels the objects should grow by, each frame.  Default 1.
  43 .TP 8
  44 .B \-spacing \fIint\fP
  45 How many pixels of space should be left between the objects.  Default 1.
  46 .TP 8
  47 .B \-border \fIint\fP
  48 Thickness of the colored border around each object.  Default 1.
  49 .TP 8
  50 .B \-circles\fB | \-squares\fP | \-random\fP
  51 Draw circles, squares, or choose randomly (the default).
  52 .SH ENVIRONMENT
  53 .PP
  54 .TP 8
  55 .B DISPLAY
  56 to get the default host and display number.
  57 .TP 8
  58 .B XENVIRONMENT
  59 to get the name of a resource file that overrides the global resources
  60 stored in the RESOURCE_MANAGER property.
  61 .SH SEE ALSO
  62 .BR X (1),
  63 .BR xscreensaver (1)
  64 .SH COPYRIGHT
  65 Copyright \(co 2005 by Jamie Zawinski.  Permission to use, copy, modify,
  66 distribute, and sell this software and its documentation for any purpose is
  67 hereby granted without fee, provided that the above copyright notice appear
  68 in all copies and that both that copyright notice and this permission notice
  69 appear in supporting documentation.  No representations are made about the
  70 suitability of this software for any purpose.  It is provided "as is" without
  71 express or implied warranty.
  72 .SH AUTHOR
  73 Jamie Zawinski <jwz@jwz.org>