ftp://ftp.smr.ru/pub/0/FreeBSD/releases/distfiles/xscreensaver-3.16.tar.gz
[xscreensaver] / hacks / helix.man
1 .TH XScreenSaver 1 "18-sep-97" "X Version 11"
2 .SH NAME
3 helix - draw helical string-art patterns
4 .SH SYNOPSIS
5 .B helix
6 [\-display \fIhost:display.screen\fP] [\-foreground \fIcolor\fP] [\-background \fIcolor\fP] [\-window] [\-root] [\-mono] [\-erase\-speed \fIusecs\fP] [\-erase\-mode \fIinteger\fP] [\-delay \fIseconds\fP] [\-install] [\-visual \fIvisual\fP]
7 .SH DESCRIPTION
8 The \fIhelix\fP program draws interesting patterns composed of line segments
9 in random colors.
10 .SH OPTIONS
11 .I helix
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 \-erase\-speed \fIusecs\fP
24 This controls the speed at which the screen will be erased. Lower numbers 
25 erase faster.
26 .TP 8
27 .B \-erase\-mode \fIinteger\fP
28 This sets the erase mode. Mode \-1 chooses a random mode each time. There
29 are currently 6 modes defined (0\-5).
30 .TP 8
31 .B \-delay \fIseconds\fP
32 This sets the number of seconds that the helix will be on the screen.
33 .TP 8
34 .B \-install
35 Install a private colormap for the window.
36 .TP 8
37 .B \-visual \fIvisual\fP
38 Specify which visual to use.  Legal values are the name of a visual class,
39 or the id number (decimal or hex) of a specific visual.
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 .SH COPYRIGHT
53 Copyright \(co 1992 by Jamie Zawinski.  Permission to use, copy, modify, 
54 distribute, and sell this software and its documentation for any purpose is 
55 hereby granted without fee, provided that the above copyright notice appear 
56 in all copies and that both that copyright notice and this permission notice
57 appear in supporting documentation.  No representations are made about the 
58 suitability of this software for any purpose.  It is provided "as is" without
59 express or implied warranty.
60 .SH AUTHOR
61 Jamie Zawinski <jwz@jwz.org>, 13-aug-92.
62 Screen eraser improved by Johannes Keukelaar <johannes@nada.kth.se>, 
63  18-sep-97.