From http://www.jwz.org/xscreensaver/xscreensaver-5.31.tar.gz
[xscreensaver] / hacks / fuzzyflakes.man
1 .TH XScreenSaver 1 "12-May-04" "X Version 11"
2 .SH NAME
3 fuzzyflakes - falling snowflakes/flower shapes
4 .SH SYNOPSIS
5 .B fuzzyflakes
6 [\-display \fIhost:display.screen\fP] [\-foreground \fIcolor\fP]
7 [\-background \fIcolor\fP] [\-window] [\-root] [\-mono] [\-install]
8 [\-visual \fIvisual\fP] 
9 [\-delay \fIusecs\fP]
10 [\-speed \fIint\fP]
11 [\-arms \fIint\fP]
12 [\-thickness \fIint\fP]
13 [\-bthickness \fIint\fP]
14 [\-radius \fIint\fP]
15 [\-layers \fIint\fP]
16 [\-density \fIint\fP]
17 [\-no-db]
18 (\-color \fIstring\fP)
19 (\-random-colors)
20 [\-fps]
21 .SH DESCRIPTION
22 The
23 .I fuzzyflakes
24 program draws falling pastel colored snowflake/flower shapes.
25 Inspired by the credits of the anime "Azumanga Daioh".
26 .SH OPTIONS
27 .I fuzzyflakes
28 accepts the following options:
29 .TP 8
30 .B \-window
31 Draw on a newly-created window.  This is the default.
32 .TP 8
33 .B \-root
34 Draw on the root window.
35 .TP 8
36 .B \-mono 
37 If on a color display, pretend we're on a monochrome display.
38 .TP 8
39 .B \-install
40 Install a private colormap for the window.
41 .TP 8
42 .B \-visual \fIvisual\fP
43 Specify which visual to use.  Legal values are the name of a visual class,
44 or the id number (decimal or hex) of a specific visual.
45 .TP 8
46 .B \-delay \fIusecs\fP
47 The delay between steps of the animation, in microseconds.  Default: 250000.
48 .TP 8
49 .B \-speed \fIint\fP
50 How fast, 1-50.  Default 10.
51 .TP 8
52 .B \-arms \fIint\fP
53 How many arms on the flakes; default 5.
54 .TP 8
55 .B \-thickness \fIint\fP
56 How thick to make the lines; default 10 pixels.
57 .TP 8
58 .B \-bthickness \fIint\fP
59 How thick to make the borders; default 3 pixels.
60 .TP 8
61 .B \-radius \fIint\fP
62 Radius of the objects; default 20 pixels.
63 .TP 8
64 .B \-layers \fIint\fP
65 How many layers of objects; default 3.
66 .TP 8
67 .B \-density \fIint\fP
68 Default 5.
69 .TP 8
70 .B \-no-db
71 Disable double-buffering.
72 .TP 8
73 .B \-color \fIstring\fP
74 The base color for the color scheme.  Typed as a hexadecimal triplet
75 with or with out the leading #. ie. fa4563 & #43cd12 are both acceptable.
76 If the saturation of you color is too low (<0.03) the random color
77 generator will kick in.
78 The default color is #efbea5
79 .TP 8
80 .B \-random-colors
81 This enables the random color generation.  It is disabled by default.
82 It overrides anything from -color
83 .TP 8
84 .B \-fps
85 Display the current frame rate and CPU load.
86 .SH ENVIRONMENT
87 .PP
88 .TP 8
89 .B DISPLAY
90 to get the default host and display number.
91 .TP 8
92 .B XENVIRONMENT
93 to get the name of a resource file that overrides the global resources
94 stored in the RESOURCE_MANAGER property.
95 .SH SEE ALSO
96 .BR X (1),
97 .BR xscreensaver (1)
98 .SH COPYRIGHT
99 Copyright \(co 2004 Barry Dmytro.  Permission to use, copy, modify,
100 distribute, and sell this software and its documentation for any
101 purpose is hereby granted without fee, provided that the above
102 copyright notice appear in all copies and that both that copyright
103 notice and this permission notice appear in supporting documentation.
104 No representations are made about the suitability of this software for
105 any purpose.  It is provided "as is" without express or implied
106 warranty.
107 .SH AUTHOR
108 Barry Dmytro <badcherry@mailc.net>
109 .SH CREDITS
110 The color generation algorithm was borrowed from a friend <ZoeB>
111 from #vegans@irc.blitzed.org.  Her site was [REDACTED].
112 To see her original code in action visit her site.