http://www.jwz.org/xscreensaver/xscreensaver-5.13.tar.gz
[xscreensaver] / hacks / truchet.man
1 .TH XScreenSaver 1 "27-May-97" "X Version 11"
2 .SH NAME
3 truchet - draws curved or angular Truchet patterns
4 .SH SYNOPSIS
5 .B truchet
6 [\-display \fIhost:display.screen\fP]  [\-foreground \fIcolor\fP] [\-background \fIcolor\fP]
7 [\-window] [\-root] [\-mono] [\-install] [\-visual \fIvisual\fP] [\-delay \fImilliseconds\fP]
8 [\-min\-width \fIinteger\fP] [\-min-height \fIinteger\fP] [\-max-width \fIinteger\fP] 
9 [\-max-height \fIinteger\fP] [\-max\-linewidth \fIinteger\fP] [\-min-linewidth \fIinteger\fP] 
10 [\-erase] [\-no\-erase] [\-erase\-count \fIinteger\fP] [\-square] [\-not\-square] [\-curves]
11 [\-no\-curves] [\-angle] [\-no\-angles] [\-scroll] [\-scroll\-overlap \fIinteger\fP] 
12 [\-anim\-delay \fIinteger\fP] [\-anim\-step\-size \fIinteger\fP]
13
14 [\-fps]
15 .SH DESCRIPTION
16 The \fItruchet\fP program draws arc and line based Truchet patterns.
17 .SH OPTIONS
18 .I truchet
19 accepts the following options:
20 .TP 8
21 .B  \-window
22 Draw on a newly-created window.  This is the default.
23 .TP 8
24 .B \-root
25 Draw on the root window.
26 .TP 8
27 .B \-mono 
28 If on a color display, pretend we're on a monochrome display.
29 .TP 8
30 .B \-install
31 Install a private colormap for the window.
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
37 .TP 8
38 .B \-delay \fImilliseconds\fP
39 How long to wait between drawing each screenful. Default is 1 seconds.
40
41 .TP 8 
42 .B \-min-width \fIinteger\fP
43 The minimum width in pixels of each square. Default is 40.
44
45 .TP 8
46 .B \-min-height \fIinteger\fP
47 The minimum height in pixels of each square. Default is 40.
48
49 .TP 8
50 .B \-max-width \fIinteger\fP
51 The maximum width in pixels of each square. Default is 150.
52
53 .TP 8
54 .B \-max-height \fIinteger\fP
55 The maximum height in pixels of each square. Default is 150.
56
57 .TP 8
58 .B \-max-linewidth \fIinteger\fP
59 The maximum width of the lines used to draw. Default is 25.
60
61 .TP 8
62 .B \-min-linewidth \fIinteger\fP
63 The minimum width of the lines used to draw. Default is 2.
64
65 .TP 8
66 .B \-erase
67
68 .TP 8
69 .B \-no-erase
70 Whether to clear the screen after each screenful is drawn. Default is True (erase).
71
72 .TP 8
73 .B \-erase-count \fIinteger\fP
74 The number of screenfuls to draw before erasing. Default is 25.
75
76 .TP 8
77 .B \-square
78
79 .TP 8
80 .B \-not-square
81 Whether to force the tiles to be square. Default is True (square).
82
83 .TP 8
84 .B \-curves
85
86 .TP 8
87 .B \-no-curves
88 Whether to draw the arc based Truchet pattern. Default is True (curves).
89
90 .TP 8
91 .B \-angles
92
93 .TP 8
94 .B \-no-angles
95 Whether or not to draw the line based Truchet pattern. Default is True (angles)
96
97 .TP 8
98 .B \-scroll
99 Use the scroll mode. Default is False.
100
101 .TP 8
102 .B \-scroll-overlap
103 The amount to scroll from one side to another. Default is 400.
104
105 .TP 8
106 .B \-anim-delay
107 The time to pause between each animation step. Default is 100.
108
109 .TP 8
110 .B \-anim-step-size
111 The amount of steps to skip between each animation step. Default is 3.
112
113
114 .TP 8
115 .B \-fps
116 Display the current frame rate and CPU load.
117 .SH ENVIRONMENT
118 .PP
119 .TP 8
120 .B DISPLAY
121 to get the default host and display number.
122 .TP 8
123 .B XENVIRONMENT
124 to get the name of a resource file that overrides the global resources
125 stored in the RESOURCE_MANAGER property.
126 .SH SEE ALSO
127 .BR X (1),
128 .BR xscreensaver (1)
129 .SH COPYRIGHT
130 Copyright \(co 1998 by Adrian Likins.
131
132 Permission to use, copy, modify, and distribute this software and its
133 documentation for any purpose and without fee is hereby granted,
134 provided that the above copyright notice appear in all copies and that
135 both that copyright notice and this permission notice appear in
136 supporting documentation. 
137 .SH AUTHOR
138 Adrian Likins, 1998.
139