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