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

   1 .TH XScreenSaver 1 "24-Nov-97" "X Version 11"
   2 .SH NAME
   3 slidescreen - permute the screen image like an 8-puzzle
   4 .SH SYNOPSIS
   5 .B slidescreen
   6 [\-display \fIhost:display.screen\fP]
   7 [\-background \fIcolor\fP]
   8 [\-grid-size \fIpixels\fP]
   9 [\-ibw \fIpixels\fP]
  10 [\-increment \fIpixels\fP]
  11 [\-delay \fIusecs\fP]
  12 [\-delay2 \fIusecs\fP]
  13 [\-duration \fIsecs\fP]
  14 [\-window]
  15 [\-root]
  16 [\-install]
  17 [\-visual \fIvisual\fP]
  18 [\-fps]
  19 .SH DESCRIPTION
  20 The \fIslidescreen\fP program takes an image, divides it into
  21 a grid, deletes a random square of that grid, and then randomly slides
  22 one of the neighbors of this "hole" into the hole (and repeat.)
  23
  24 The image that it manipulates will be grabbed from the portion of
  25 the screen underlying the window, or from the system's video input,
  26 or from a random file on disk, as indicated by
  27 the \fIgrabDesktopImages\fP, \fIgrabVideoFrames\fP,
  28 and \fIchooseRandomImages\fP options in the \fI~/.xscreensaver\fP
  29 file; see
  30 .BR xscreensaver-demo (1)
  31 for more details.
  32 .SH OPTIONS
  33 .I slidescreen
  34 accepts the following options:
  35 .TP 8
  36 .B \-window
  37 Draw on a newly-created window.  This is the default.
  38 .TP 8
  39 .B \-root
  40 Draw on the root window.
  41 .TP 8
  42 .B \-install
  43 Install a private colormap for the window.
  44 .TP 8
  45 .B \-visual \fIvisual\fP
  46 Specify which visual to use.  Legal values are the name of a visual class,
  47 or the id number (decimal or hex) of a specific visual.
  48 .TP 8
  49 .B \-grid-size \fIpixels\fP
  50 The size of the grid cells.  Default 70 pixels.
  51 .TP 8
  52 .B \-ibw \fIpixels\fP
  53 The size of the "gutter" between grid cells.  Default 4 pixel.
  54 .TP 8
  55 .B \-increment \fIpixels\fP
  56 How many pixels by which a piece should be moved when sliding to a new
  57 location.  Default 10 pixels.
  58 .TP 8
  59 .B \-delay \fImicroseconds\fP
  60 How much of a delay should be introduced between steps of the animation of
  61 the motion of each segment.  Default 50000, which is 0.05 seconds.  This
  62 is closely related to the \fI\-increment\fP parameter.
  63 .TP 8
  64 .B \-delay2 \fImicroseconds\fP
  65 How much of a delay should be introduced between the end of the motion of
  66 one segment and the beginning of the motion of another.  Default 1000000,
  67 which is one second.
  68 .TP 8
  69 .B \-duration \fIseconds\fP
  70 How long to run before loading a new image.  Default 120 seconds.
  71 .TP 8
  72 .B \-fps
  73 Display the current frame rate and CPU load.
  74 .SH ENVIRONMENT
  75 .PP
  76 .TP 8
  77 .B DISPLAY
  78 to get the default host and display number.
  79 .TP 8
  80 .B XENVIRONMENT
  81 to get the name of a resource file that overrides the global resources
  82 stored in the RESOURCE_MANAGER property.
  83 .SH SEE ALSO
  84 .BR X (1),
  85 .BR xscreensaver (1),
  86 .BR xscreensaver\-demo (1),
  87 .BR xscreensaver\-getimage (1)
  88 .SH COPYRIGHT
  89 Copyright \(co 1992 by Jamie Zawinski.  Permission to use, copy, modify,
  90 distribute, and sell this software and its documentation for any purpose is
  91 hereby granted without fee, provided that the above copyright notice appear
  92 in all copies and that both that copyright notice and this permission notice
  93 appear in supporting documentation.  No representations are made about the
  94 suitability of this software for any purpose.  It is provided "as is" without
  95 express or implied warranty.
  96 .SH AUTHOR
  97 Jamie Zawinski <jwz@jwz.org>, 3-dec-92.