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