git.hungrycats.org Git - xscreensaver/blob - hacks/glx/glslideshow.man

   1 .TH XScreenSaver 1 "" "X Version 11"
   2 .SH NAME
   3 glslideshow - slideshow of images using smooth zooming and fades
   4 .SH SYNOPSIS
   5 .B glslideshow
   6 [\-display \fIhost:display.screen\fP]
   7 [\-visual \fIvisual\fP]
   8 [\-window]
   9 [\-root]
  10 [\-pan \fIseconds\fP]
  11 [\-fade \fIseconds\fP]
  12 [\-zoom \fIpercent\fP]
  13 [\-delay \fIusecs\fP]
  14 [\-cutoff \fIint\fP]
  15 [\-fps]
  16 [\-debug]
  17 [\-wireframe]
  18 .SH DESCRIPTION
  19 Loads a random sequence of images and smoothly scans and zooms around
  20 in each, fading from pan to pan.
  21
  22 This program requires a good video card capable of supporting large
  23 textures.
  24
  25 To specify the directory that images are loaded from, run
  26 .BR xscreensaver-demo (1)
  27 and click on the "Advanced" tab.
  28 .SH OPTIONS
  29 .TP 8
  30 .B \-visual \fIvisual\fP
  31 Specify which visual to use.  Legal values are the name of a visual class,
  32 or the id number (decimal or hex) of a specific visual.
  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 \-pan \fIseconds\fP
  41 How long each pan should last.  Default 6 seconds.
  42 .TP 8
  43 .B \-fade \fIseconds\fP
  44 How long each fade (in and out) should last.  Default 2 seconds.
  45 If set to 0, then no cross-fading will be done (all transitions
  46 will be jump-cuts.)
  47
  48 Note that fades are included in the pan, so \fI\-pan\fP should
  49 always be longer than  \fI\-fade\fP (it is auto-corrected if not.)
  50 .TP 8
  51 .B \-zoom \fInumber\fP
  52 Amount to zoom and pan as a percentage. Default: 75, meaning that
  53 75% or more of each image will always be visible.  If set to 100%,
  54 then the images will always fill the screen, and no panning or
  55 zooming will occur.  Images will still smoothly fade from one
  56 to another, however, assuming \fI\-fade\fP is non-zero.
  57 .TP 8
  58 .B \-delay \fInumber\fP
  59 Per-frame delay, in microseconds.  Default: 20000 (0.02 seconds.).
  60 .TP 8
  61 .B \-cutoff \fInumber\fP
  62 If the frame rate drops below this number of frames per second, then
  63 certain features will be turned off automatically (first zooming,
  64 then, if the low frame rates persist, fading.)  Default 5.
  65
  66 The idea here is that if your machine can't maintain a decent frame
  67 rate, then it must not have fast 3D hardware, so we might as well
  68 behave in a simpler manner.  Set this to 0 to disable this check.
  69 .TP 8
  70 .B \-fps
  71 Whether to show a frames-per-second display at the bottom of the screen.
  72 .TP 8
  73 .B \-debug
  74 Prints debugging info to stderr.
  75 .TP 8
  76 .B \-wireframe
  77 Instead of loading images, simply animates representative grids instead.
  78 .SH ENVIRONMENT
  79 .PP
  80 .TP 8
  81 .B DISPLAY
  82 to get the default host and display number.
  83 .TP 8
  84 .B XENVIRONMENT
  85 to get the name of a resource file that overrides the global resources
  86 stored in the RESOURCE_MANAGER property.
  87 .SH SEE ALSO
  88 .BR X (1),
  89 .BR xscreensaver-demo (1)
  90 .BR xscreensaver-getimage (1)
  91 .BR xscreensaver (1)
  92 .SH COPYRIGHT
  93 Copyright \(co 2003 by Jamie Zawinski, based on an earlier version that was
  94 Copyright \(co 2002 by Mike Oliphant.  Originally derived from
  95 .BR flipscreen3d (1) ,
  96 which was Copyright \(co 2001 Ben Buxton.
  97
  98 Permission to use, copy, modify, distribute, and sell this software and
  99 its documentation for any purpose is hereby granted without fee,
 100 provided that the above copyright notice appear in all copies and that
 101 both that copyright notice and this permission notice appear in
 102 supporting documentation.  No representations are made about the
 103 suitability of this software for any purpose.  It is provided "as is"
 104 without express or implied warranty.
 105 .SH AUTHOR
 106 Jamie Zawinski and Mike Oliphant.