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