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