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

   1 .TH XScreenSaver 1 "" "X Version 11"
   2 .SH NAME
   3 carousel - displays multiple images rotating in a circular formation
   4 .SH SYNOPSIS
   5 .B carousel
   6 [\-display \fIhost:display.screen\fP]
   7 [\-visual \fIvisual\fP]
   8 [\-window]
   9 [\-root]
  10 [\-count \fIint\fP]
  11 [\-zoom | \-no\-zoom]
  12 [\-tilt \fIXY\fP]
  13 [\-titles | \-no\-titles]
  14 [\-font \fIfont\fP]
  15 [\-speed \fIratio\fP]
  16 [\-duration \fIseconds\fP]
  17 [\-fps]
  18 [\-debug]
  19 [\-wireframe]
  20 .SH DESCRIPTION
  21 Loads several random images, and displays them flying in a circular
  22 formation.  The circle changes speed and direction randomly, tilts on
  23 its axis, and the images move in and out.
  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 \-count \fIint\fP
  44 How many images to display.  Default 7.
  45 .TP 8
  46 .B \-zoom \fB| \-no\-zoom\fP
  47 Whether the images should move in and out (toward and away from the
  48 axis of rotation).  Default true.
  49 .TP 8
  50 .B \-tilt \fIXY\fP \fB| \-no\-tilt\fP
  51 Whether the axis of rotation should tilt, and how.  \fB-tilt X\fP
  52 means that it will tilt toward and away from the viewer.
  53 \fB-tilt Y\fP means that it will tilt to the left and right of the
  54 screen.  \fB-tilt XY\fP (the default) means it will do both.
  55 .TP 8
  56 .B \-titles \fB| \-no\-titles\fP
  57 Whether to display the file names of the images beneath them.  Default: yes.
  58 .TP 8
  59 .B \-font \fIfont-name\fP
  60 The font to use for titles.  Note that the size of the font affects
  61 the clarity of the characters, not their size (it is auto-scaled.)
  62 .TP 8
  63 .B \-duration \fIseconds\fP
  64 Every \fIduration\fP seconds, one of the images will be replaced
  65 with a new one.  Default 20 seconds.
  66 .TP 8
  67 .B \-speed \fIratio\fP
  68 Speed up or slow down the animation.  0.5 means half as fast as the
  69 default; 2.0 means twice as fast.
  70 .TP 8
  71 .B \-delay \fInumber\fP
  72 Per-frame delay, in microseconds.  Default: 20000 (0.02 seconds.).
  73 .TP 8
  74 .B \-fps
  75 Display the current frame rate, CPU load, and polygon count.
  76 .TP 8
  77 .B \-debug
  78 Prints debugging info to stderr.
  79 .TP 8
  80 .B \-wireframe
  81 Another debug mode.
  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 .BR glslideshow (MANSUFFIX)
  97 .BR photopile (MANSUFFIX)
  98 .SH COPYRIGHT
  99 Copyright \(co 2005 by Jamie Zawinski.
 100
 101 Permission to use, copy, modify, distribute, and sell this software and
 102 its documentation for any purpose is hereby granted without fee,
 103 provided that the above copyright notice appear in all copies and that
 104 both that copyright notice and this permission notice appear in
 105 supporting documentation.  No representations are made about the
 106 suitability of this software for any purpose.  It is provided "as is"
 107 without express or implied warranty.
 108 .SH AUTHOR
 109 Jamie Zawinski.