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