97d089eeec0e04dd0bdd4d38688773c0dfb30282
[xscreensaver] / hacks / glx / pipes.man
1 .TH XScreenSaver 1 "" "X Version 11"
2 .SH NAME
3 pipes - fill the screen with a plumbing system.
4 .SH SYNOPSIS
5 .B pipes
6 [\-display \fIhost:display.screen\fP]
7 [\-visual \fIvisual\fP]
8 [\-window]
9 [\-root]
10 [-count 0]
11 [-count 1]
12 [-cycles \fInumber\fP]
13 [-size \fInumber\fP]
14 [-factory \fInumber\fP]
15 [-delay \fInumber\fP]
16 [-no-fisheye]
17 [-tightturns]
18 [-db]
19 [-fps]
20 .SH DESCRIPTION
21 If you've ever been in the same room with a Windows NT machine, you've
22 probably seen this GL hack.  It fills the screen with a plumbing system.
23 .SH OPTIONS
24 .TP 8
25 .B \-visual \fIvisual\fP
26 Specify which visual to use.  Legal values are the name of a visual class,
27 or the id number (decimal or hex) of a specific visual.
28 .TP 8
29 .B \-window
30 Draw on a newly-created window.  This is the default.
31 .TP 8
32 .B \-root
33 Draw on the root window.
34 .TP 8
35 .B \-count 0
36 Curved Pipes.
37 .TP 8
38 .B \-count 1
39 Ball Joints.
40 .TP 8
41 .B \-cycles \fInumber\fP
42 Number of pipe systems to draw at once.  Default: 5.
43 .TP 8
44 .B \-size \fInumber\fP
45 Length of each pipe system.  Default: 500.
46 .TP 8
47 .B \-factory \fInumber\fP
48 How much gadgetry to create; Useful range is 0-10.  Default: 2.
49 .TP 8
50 .B \-delay \fInumber\fP
51 How long (in microseconds) to sleep between frames.  Default: 10000.
52 .TP 8
53 .B \-fisheye | \-no-fisheye
54 Whether to use a fisheye lens.
55 .TP 8
56 .B \-tightturns | \-no-tightturns
57 Whether to allow tight turns.
58 .TP 8
59 .B \-db | \-no-db
60 Whether to double-buffer.
61 .TP 8
62 .B \-fps | \-no-fps
63 Whether to show a frames-per-second display at the bottom of the screen.
64 .SH ENVIRONMENT
65 .PP
66 .TP 8
67 .B DISPLAY
68 to get the default host and display number.
69 .TP 8
70 .B XENVIRONMENT
71 to get the name of a resource file that overrides the global resources
72 stored in the RESOURCE_MANAGER property.
73 .SH SEE ALSO
74 .BR X (1),
75 .BR xscreensaver (1)
76 .SH COPYRIGHT
77 Copyright \(co 2002 by Marcelo Vianna.  Permission to use, copy, modify, 
78 distribute, and sell this software and its documentation for any purpose is 
79 hereby granted without fee, provided that the above copyright notice appear 
80 in all copies and that both that copyright notice and this permission notice
81 appear in supporting documentation.  No representations are made about the 
82 suitability of this software for any purpose.  It is provided "as is" without
83 express or implied warranty.
84 .SH AUTHOR
85 Marcelo Vianna.