http://ftp.x.org/contrib/applications/xscreensaver-3.09.tar.gz
[xscreensaver] / hacks / braid.man
1 .TH XScreenSaver 1 "10-May-97" "X Version 11"
2 .SH NAME
3 braid - draws random color-cycling braids around a circle
4 .SH SYNOPSIS
5 .B braid
6 [\-display \fIhost:display.screen\fP] [\-foreground \fIcolor\fP] [\-background \fIcolor\fP] [\-window] [\-root] [\-mono] [\-install] [\-visual \fIvisual\fP] [\-ncolors \fIinteger\fP] [\-delay \fImicroseconds\fP] [\-cycles \fIinteger\fP] [\-count \fIinteger\fP]
7
8 .SH DESCRIPTION
9 The \fIbraid\fP program draws random color-cycling braids around a circle.
10 .SH OPTIONS
11 .I braid
12 accepts the following options:
13 .TP 8
14 .B \-window
15 Draw on a newly-created window.  This is the default.
16 .TP 8
17 .B \-root
18 Draw on the root window.
19 .TP 8
20 .B \-mono 
21 If on a color display, pretend we're on a monochrome display.
22 .TP 8
23 .B \-install
24 Install a private colormap for the window.
25 .TP 8
26 .B \-visual \fIvisual\fP
27 Specify which visual to use.  Legal values are the name of a visual class,
28 or the id number (decimal or hex) of a specific visual.
29 .TP 8
30 .B \-ncolors \fIinteger\fP
31 How many colors should be used (if possible).  Default 64.
32 The colors used cycle through the hue, making N stops around
33 the color wheel.
34 .TP 8
35 .B \-cycles \fIinteger\fP
36
37 .TP 8
38 .B \-count \fIinteger\fP
39
40 .SH ENVIRONMENT
41 .PP
42 .TP 8
43 .B DISPLAY
44 to get the default host and display number.
45 .TP 8
46 .B XENVIRONMENT
47 to get the name of a resource file that overrides the global resources
48 stored in the RESOURCE_MANAGER property.
49 .SH SEE ALSO
50 .BR X (1),
51 .BR xscreensaver (1),
52 .BR xlock (1)
53 .SH COPYRIGHT
54 Copyright \(co 1995 by John Neil.
55
56 Permission to use, copy, modify, and distribute this software and its
57 documentation for any purpose and without fee is hereby granted,
58 provided that the above copyright notice appear in all copies and that
59 both that copyright notice and this permission notice appear in
60 supporting documentation. 
61 .SH AUTHOR
62 John Neil <neil@math.idbsu.edu>, 29-Aug-95.
63
64 Ability to run standalone or with \fIxscreensaver\fP added by 
65 Jamie Zawinski <jwz@jwz.org>, 10-May-97.