git.hungrycats.org Git - xscreensaver/blob - hacks/halo.man

   1 .TH XScreenSaver 1 "12-Jun-97" "X Version 11"
   2 .SH NAME
   3 halo - draw circular patterns
   4 .SH SYNOPSIS
   5 .B halo
   6 [\-display \fIhost:display.screen\fP] [\-foreground \fIcolor\fP] [\-background \fIcolor\fP] [\-window] [\-root] [\-mono] [\-install] [\-visual \fIvisual\fP] [\-count \fIint\fP] [\-delay \fIusecs\fP] [\-mode seuss | ramp | random ] [\-animate] [\-colors \fIinteger\fP]
   7 [\-fps]
   8 .SH DESCRIPTION
   9 The \fIhalo\fP program draws cool patterns based on circles.
  10 .SH OPTIONS
  11 .I halo
  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 \-count \fIinteger\fP
  31 How many circles to draw.  Default 0, meaning random.
  32 .TP 8
  33 .B \-mode "seuss | ramp | random"
  34 In \fIseuss\fP mode, alternating striped curves will be drawn.
  35
  36 In \fIramp\fP mode, a color ramp will be drawn.
  37
  38 \fIrandom\fP means pick the mode randomly.
  39 .TP 8
  40 .B \-delay \fImicroseconds\fP
  41 How much of a delay should be introduced between steps of the animation.
  42 Default 100000, or about 0.1 second.
  43 .TP 8
  44 .B \-colors \fIinteger\fP
  45 How many colors to use.  Default 100.
  46 .TP 8
  47 .B \-animate
  48 If specified, then the centerpoints of the circles will bounce around.
  49 Otherwise, the circles will be drawn once, erased, and a new set of
  50 circles will be drawn.
  51 .TP 8
  52 .B \-fps
  53 Display the current frame rate and CPU load.
  54 .SH ENVIRONMENT
  55 .PP
  56 .TP 8
  57 .B DISPLAY
  58 to get the default host and display number.
  59 .TP 8
  60 .B XENVIRONMENT
  61 to get the name of a resource file that overrides the global resources
  62 stored in the RESOURCE_MANAGER property.
  63 .SH SEE ALSO
  64 .BR X (1),
  65 .BR xscreensaver (1)
  66 .SH COPYRIGHT
  67 Copyright \(co 1993 by Jamie Zawinski.  Permission to use, copy, modify,
  68 distribute, and sell this software and its documentation for any purpose is
  69 hereby granted without fee, provided that the above copyright notice appear
  70 in all copies and that both that copyright notice and this permission notice
  71 appear in supporting documentation.  No representations are made about the
  72 suitability of this software for any purpose.  It is provided "as is" without
  73 express or implied warranty.
  74 .SH AUTHOR
  75 Jamie Zawinski <jwz@jwz.org>, 6-jul-93.