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