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 [\-titles]
  15 [\-letterbox | \-clip]
  16 [\-delay \fIusecs\fP]
  17 [\-fps]
  18 [\-debug]
  19 [\-wireframe]
  20 [\-cutoff \fIint\fP]
  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-and-zoom should last.  Default 6 seconds.
  49
  50 With the default settings of \fI\-pan 6 \-duration 30\fP, each image
  51 will be displayed five times (30/6), and then a new image will be loaded.
  52 If you want a new image to be loaded at each fade, then set \fI\-pan\fP
  53 and \fI\-duration\fP to the same value.
  54 .TP 8
  55 .B \-fade \fIseconds\fP
  56 How long each cross-fade between images should last.  Default 2 seconds.
  57 If set to 0, then no cross-fading will be done (all transitions
  58 will be jump-cuts.)
  59
  60 Note that fades are included in the pan time, so \fI\-fade\fP cannot
  61 be larger than \fI\-pan\fP.
  62 .TP 8
  63 .B \-zoom \fInumber\fP
  64 Amount to zoom and pan as a percentage. Default: 75, meaning that
  65 75% or more of each image will always be visible.  If set to 100%,
  66 then the images will always fill the screen, and no panning or
  67 zooming will occur.  (Images will still smoothly fade from one
  68 to another if \fI\-fade\fP is non-zero.)
  69 .TP 8
  70 .B \-titles
  71 Whether to print the file name of the current image in the upper left corner.
  72 .TP 8
  73 .B \-letterbox
  74 In "letterbox" mode, when an image is not the same aspect ratio as the screen,
  75 black bars will appear at the top/bottom or left/right so that the whole
  76 image can be displayed.  This is the default.
  77 .TP 8
  78 .B \-clip
  79 In "clip" mode, when an image is not the same aspect ratio as the screen,
  80 we will zoom in further until the image takes up the whole screen.
  81 This is the opposite of \fI\-letterbox\fP.
  82 .TP 8
  83 .B \-delay \fInumber\fP
  84 Per-frame delay, in microseconds.  Default: 20000 (0.02 seconds.).
  85 .TP 8
  86 .B \-fps
  87 Whether to show a frames-per-second display at the bottom of the screen.
  88 .TP 8
  89 .B \-cutoff \fInumber\fP
  90 If the frame rate we are achieving is lower than this, then panning,
  91 fading, and zooming will be disabled.  Default 5 FPS.
  92
  93 The idea here is that if your machine can't maintain a decent frame
  94 rate, then it must not have fast 3D hardware, so we might as well
  95 behave in a simpler manner.  Set this to 0 to disable this check.
  96 .TP 8
  97 .B \-debug
  98 Prints debugging info to stderr.
  99 .TP 8
 100 .B \-wireframe
 101 Another debug mode.
 102 .SH ENVIRONMENT
 103 .PP
 104 .TP 8
 105 .B DISPLAY
 106 to get the default host and display number.
 107 .TP 8
 108 .B XENVIRONMENT
 109 to get the name of a resource file that overrides the global resources
 110 stored in the RESOURCE_MANAGER property.
 111 .SH SEE ALSO
 112 .BR X (1),
 113 .BR xscreensaver-demo (1),
 114 .BR xscreensaver-getimage (1),
 115 .BR xscreensaver (1),
 116 .BR carousel (1)
 117 .SH COPYRIGHT
 118 Copyright \(co 2003-2005 by Jamie Zawinski, based on an earlier version
 119 that was
 120 Copyright \(co 2002 by Mike Oliphant.
 121
 122 Permission to use, copy, modify, distribute, and sell this software and
 123 its documentation for any purpose is hereby granted without fee,
 124 provided that the above copyright notice appear in all copies and that
 125 both that copyright notice and this permission notice appear in
 126 supporting documentation.  No representations are made about the
 127 suitability of this software for any purpose.  It is provided "as is"
 128 without express or implied warranty.
 129 .SH AUTHOR
 130 Jamie Zawinski and Mike Oliphant.