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 [\-polaroid | \-no\-polaroid]
  15 [\-shadows | \-no\-shadows]
  16 [\-font \fIfont\fP]
  17 [\-speed \fIratio\fP]
  18 [\-duration \fIseconds\fP]
  19 [\-fps]
  20 [\-debug]
  21 [\-wireframe]
  22 .SH DESCRIPTION
  23 Loads several random images, and displays them as if lying in a random pile.
  24 The pile is periodically reshuffled, with new images coming in and old ones
  25 being thrown out.
  26
  27 This program requires a good video card capable of supporting large
  28 textures.
  29
  30 To specify the directory that images are loaded from, run
  31 .BR xscreensaver-demo (1)
  32 and click on the "Advanced" tab.
  33 .SH OPTIONS
  34 .TP 8
  35 .B \-visual \fIvisual\fP
  36 Specify which visual to use.  Legal values are the name of a visual class,
  37 or the id number (decimal or hex) of a specific visual.
  38 .TP 8
  39 .B \-window
  40 Draw on a newly-created window.  This is the default.
  41 .TP 8
  42 .B \-root
  43 Draw on the root window.
  44 .TP 8
  45 .B \-count \fIint\fP
  46 How many images to display.  Default 7.
  47 .TP 8
  48 .B \-scale \fIfactor\fP
  49 Size of images in relation to the size of the window.  Default 0.4.
  50 .TP 8
  51 .B \-maxTilt \fIdegrees\fP
  52 Maximum deviation from vertical.  Default 50 degrees.
  53 .TP 8
  54 .B \-duration \fIseconds\fP
  55 Every \fIduration\fP seconds, one of the images will be replaced
  56 with a new one.  Default 5 seconds.
  57 .TP 8
  58 .B \-speed \fIratio\fP
  59 Speed up or slow down the animation.  0.5 means half as fast as the
  60 default; 2.0 means twice as fast.
  61 .TP 8
  62 .B \-delay \fInumber\fP
  63 Per-frame delay, in microseconds.  Default: 10000 (0.01 seconds.).
  64 .TP 8
  65 .B \-titles \fB| \-no\-titles\fP
  66 Whether to display the file names of the images beneath them.  Default: no.
  67 .TP 8
  68 .B \-polaroid \fB| \-no\-polaroid\fP
  69 Whether to simulate images taken by an instant camera.  Default: yes.
  70 .TP 8
  71 .B \-shadows \fB| \-no\-shadows\fP
  72 Whether to draw images with drop shadows.  Default: no.
  73 .TP 8
  74 .B \-font \fIfont-name\fP
  75 The font to use for the initial loading screen.
  76 .TP 8
  77 .B \-fps
  78 Display the current frame rate, CPU load, and polygon count.
  79 .TP 8
  80 .B \-debug
  81 Prints debugging info to stderr.
  82 .TP 8
  83 .B \-wireframe
  84 Another debug mode.
  85 .SH ENVIRONMENT
  86 .PP
  87 .TP 8
  88 .B DISPLAY
  89 to get the default host and display number.
  90 .TP 8
  91 .B XENVIRONMENT
  92 to get the name of a resource file that overrides the global resources
  93 stored in the RESOURCE_MANAGER property.
  94 .SH SEE ALSO
  95 .BR X (1),
  96 .BR xscreensaver-demo (1)
  97 .BR xscreensaver-getimage (1)
  98 .BR xscreensaver (1)
  99 .BR carousel (MANSUFFIX)
 100 .BR glslideshow (MANSUFFIX)
 101 .SH COPYRIGHT
 102 Copyright \(co 2005 by Jamie Zawinski.
 103 Copyright \(co 2008 by Jens Kilian.
 104
 105 Permission to use, copy, modify, distribute, and sell this software and
 106 its documentation for any purpose is hereby granted without fee,
 107 provided that the above copyright notice appear in all copies and that
 108 both that copyright notice and this permission notice appear in
 109 supporting documentation.  No representations are made about the
 110 suitability of this software for any purpose.  It is provided "as is"
 111 without express or implied warranty.
 112 .SH AUTHOR
 113 Jens Kilian.