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

   1 .TH XScreenSaver 1 "" "X Version 11"
   2 .SH NAME
   3 photopile - displays multiple images in a periodically shuffled pile
   4 .SH SYNOPSIS
   5 .B photopile
   6 [\-display \fIhost:display.screen\fP]
   7 [\-visual \fIvisual\fP]
   8 [\-window]
   9 [\-root]
  10 [\-count \fIint\fP]
  11 [\-scale \fIfactor\fP]
  12 [\-maxTilt \fIdegrees\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 as if lying in a random pile.
  22 The pile is periodically reshuffled, with new images coming in and old ones
  23 being thrown 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 \-scale \fIfactor\fP
  47 Size of images in relation to the size of the window.  Default 0.4.
  48 .TP 8
  49 .B \-maxTilt \fIdegrees\fP
  50 Maximum deviation from vertical.  Default 50 degrees.
  51 .TP 8
  52 .B \-duration \fIseconds\fP
  53 Every \fIduration\fP seconds, one of the images will be replaced
  54 with a new one.  Default 5 seconds.
  55 .TP 8
  56 .B \-speed \fIratio\fP
  57 Speed up or slow down the animation.  0.5 means half as fast as the
  58 default; 2.0 means twice as fast.
  59 .TP 8
  60 .B \-delay \fInumber\fP
  61 Per-frame delay, in microseconds.  Default: 10000 (0.01 seconds.).
  62 .TP 8
  63 .B \-titles \fB| \-no\-titles\fP
  64 Whether to display the file names of the images beneath them.  Default: no.
  65 .TP 8
  66 .B \-font \fIfont-name\fP
  67 The font to use for the initial loading screen.
  68 .TP 8
  69 .B \-fps
  70 Display the current frame rate, CPU load, and polygon count.
  71 .TP 8
  72 .B \-debug
  73 Prints debugging info to stderr.
  74 .TP 8
  75 .B \-wireframe
  76 Another debug mode.
  77 .SH ENVIRONMENT
  78 .PP
  79 .TP 8
  80 .B DISPLAY
  81 to get the default host and display number.
  82 .TP 8
  83 .B XENVIRONMENT
  84 to get the name of a resource file that overrides the global resources
  85 stored in the RESOURCE_MANAGER property.
  86 .SH SEE ALSO
  87 .BR X (1),
  88 .BR xscreensaver-demo (1)
  89 .BR xscreensaver-getimage (1)
  90 .BR xscreensaver (1)
  91 .BR carousel (MANSUFFIX)
  92 .BR glslideshow (MANSUFFIX)
  93 .SH COPYRIGHT
  94 Copyright \(co 2005 by Jamie Zawinski.
  95 Copyright \(co 2008 by Jens Kilian.
  96
  97 Permission to use, copy, modify, distribute, and sell this software and
  98 its documentation for any purpose is hereby granted without fee,
  99 provided that the above copyright notice appear in all copies and that
 100 both that copyright notice and this permission notice appear in
 101 supporting documentation.  No representations are made about the
 102 suitability of this software for any purpose.  It is provided "as is"
 103 without express or implied warranty.
 104 .SH AUTHOR
 105 Jens Kilian.