c7d3493330e9c75106c515aac2cb3daa1eac5a6d
[xscreensaver] / hacks / glx / jigsaw.man
1 .TH XScreenSaver 1 "25-Aug-2008" "X Version 11"
2 .SH NAME
3 jigsaw - permute an image like a jigsaw puzzle
4 .SH SYNOPSIS
5 .B jigsaw
6 [\-display \fIhost:display.screen\fP]
7 [\-delay \fIusecs\fP]
8 [\-speed \fIratio\fP]
9 [\-complexity \fIratio\fP]
10 [\-resolution \fIint\fP]
11 [\-thickness \fIfloat\fP]
12 [\-no\-wobble]
13 [\-fps]
14 .SH DESCRIPTION
15 The \fIjigsaw\fP program loads an image, carves it up into
16 a jigsaw puzzle, shuffles it, and then solves it.
17
18 The image that it manipulates will be grabbed from the portion of
19 the screen underlying the window, or from the system's video input,
20 or from a random file on disk, as indicated by
21 the \fIgrabDesktopImages\fP, \fIgrabVideoFrames\fP,
22 and \fIchooseRandomImages\fP options in the \fI~/.xscreensaver\fP
23 file; see
24 .BR xscreensaver-demo (1)
25 for more details.
26 .SH OPTIONS
27 .I jigsaw
28 accepts the following options:
29 .TP 8
30 .B \-delay \fImicroseconds\fP
31 How long to wait between animation frames; default 20000.
32 .TP 8
33 .B \-speed \fIratio\fP
34 Less than 1 for slower, greater than 1 for faster.  Default 1.
35 .TP 8
36 .B \-complexity \fIratio\fP
37 Less than 1 for simpler puzzles (fewer pieces), greater than 1 for
38 more complex puzzles (more pieces).  Default 1.
39 .TP 8
40 .B \-resolution \fIratio\fP
41 Smoothness of the edges of the pieces.  Less than 1 for rougher pieces
42 (fewer polygons), greater than 1 for more smoother pieces (more polygons).
43 Default 1.
44 .TP 8
45 .B \-thickness \fIfloat\fP
46 Thickness of the puzzle pieces (relative to their width).
47 Default 0.06.
48 .TP 8
49 .B \-no\-wobble
50 Keep the display stationary instead of very slowly wobbling back and forth.
51 .TP 8
52 .B \-fps
53 Display the current frame rate, polygon count, and CPU load.
54 .TP 8
55 .B \-window
56 Draw on a newly-created window.  This is the default.
57 .TP 8
58 .B \-root
59 Draw on the root window.
60 .TP 8
61 .B \-install
62 Install a private colormap for the window.
63 .TP 8
64 .B \-visual \fIvisual\fP
65 Specify which visual to use.  Legal values are the name of a visual class,
66 or the id number (decimal or hex) of a specific visual.
67 .SH ENVIRONMENT
68 .PP
69 .TP 8
70 .B DISPLAY
71 to get the default host and display number.
72 .TP 8
73 .B XENVIRONMENT
74 to get the name of a resource file that overrides the global resources
75 stored in the RESOURCE_MANAGER property.
76 .SH SEE ALSO
77 .BR X (1),
78 .BR xscreensaver (1),
79 .BR xscreensaver\-demo (1),
80 .BR xscreensaver\-getimage (1)
81 .SH COPYRIGHT
82 Copyright \(co 1997 by Jamie Zawinski.  Permission to use, copy, modify, 
83 distribute, and sell this software and its documentation for any purpose is 
84 hereby granted without fee, provided that the above copyright notice appear 
85 in all copies and that both that copyright notice and this permission notice
86 appear in supporting documentation.  No representations are made about the 
87 suitability of this software for any purpose.  It is provided "as is" without
88 express or implied warranty.
89 .SH AUTHOR
90 Jamie Zawinski <jwz@jwz.org>, 25-Nov-97.