From http://www.jwz.org/xscreensaver/xscreensaver-5.31.tar.gz
[xscreensaver] / hacks / binaryring.man
diff --git a/hacks/binaryring.man b/hacks/binaryring.man
new file mode 100644 (file)
index 0000000..2d44496
--- /dev/null
@@ -0,0 +1,88 @@
+.TH "Binary Ring" 1 "02-Sep-14" "X Version 11"
+.SH NAME
+binaryring - A system of path tracing particles evolves continuously from an initial creation. 
+.SH SYNOPSIS
+.B binaryring
+[\-fps]
+[\-install]
+[\-noinstall]
+[\-mono]
+[\-root]
+[\-visual \fIvisual\fP]
+[\-window] 
+[\-window\-id \fIwindow\-id\fP]
+[\-color]
+[\-no\-color]
+[\-growth\-delay \fIdelayms\fP]
+[\-particle\-number \fIparticles\fP]
+[\-ring\-radius \fIradius\fP]
+.SH DESCRIPTION
+A system of path tracing particles evolves continuously from an initial circular creation. 
+Ages of darkness play arbitrarily with ages of light.
+
+Ported (with some extensions) from the code by J. Tarbell at http://complexification.net
+.SH OPTIONS
+.I binaryring
+accepts the following options:
+.TP 8
+.B \-fps
+Display the current frame rate and CPU load.
+.TP 8
+.B \-install
+Install a private colormap for the window.
+.TP 8
+.B \-mono
+If on a color display, pretend we're on a monochrome display.
+.TP 8
+.B \-noinstall
+Don't install a private colormap for the window.
+.TP 8
+.B \-root
+Draw on the root window.
+.TP 8
+.B \-visual \fIvisual\fP
+Specify which visual to use. Legal values are the name of a visual
+class or the id number (decimal or hex) of a specific visual.
+.TP 8
+.B \-window
+Draw on a newly-created window. This is the default.
+.TP 8
+.B \-window\-id \fIwindow\-id\fP
+Specify which window id to use.
+.TP 8
+.B \-color (Default)
+Particles have random generated colors that gradually change over time.
+.TP 8
+.B \-no\-color
+Use the original black and white visualization.
+.TP 8
+.B \-growth\-delay \fIdelayms\fP (Default: \fI10000\fP)
+Delay in ms between growth cycles. More delay, slower (but less CPU intensive).
+.TP 8
+.B \-particles\-number \fIparticles\fP (Default: \fI5000\fP)
+The number of particles in the system. With more particles the fps
+can also be affected.
+.TP 8
+.B \-ring\-radius \fIradius\fP (Default: \fI40\fP)
+The radius of the ring where the particles are born, in pixels.
+.SH ENVIRONMENT
+.PP
+.TP 8
+.B DISPLAY
+to get the default host and display number.
+.TP 8
+.B XENVIRONMENT
+to get the name of a resource file that overrides the global
+resources stored in the RESOURCE_MANAGER property.
+.SH SEE ALSO
+.BR X (1),
+.BR xscreensaver (1)
+.SH COPYRIGHT
+Copyright \(co 2003 by J. Tarbell
+(complex@complexification.net, http://www.complexification.net).
+
+Ported to XScreensaver by Emilio Del Tessandoro (emilio.deltessa@gmail.com)
+.SH AUTHOR
+J. Tarbell <complex@complexification.net>, Jun-03
+
+Emilio Del Tessandoro <emilio.deltessa@gmail.com>, Aug-14