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

   1 .TH XScreenSaver 1 "9-Dec-2001" "X Version 11"\r
   2 .SH NAME\r
   3 xspirograph - simulates the rotation of a disk inside a circular rim\r
   4 .SH SYNOPSIS\r
   5 .B xspirograph\r
   6 [\-display \fIhost:display.screen\fP] [\-window] [\-root] [\-install]\r
   7 [\-visual \fIvisual\fP] \r
   8 [\-delay \fIseconds\fP] \r
   9 [\-subdelay \fIuseconds\fP] \r
  10 [\-layers \fIinteger\fP]\r
  11 [\-alwaysfinish] [\-noalwaysfinish]\r
  12 .SH DESCRIPTION\r
  13 \fIxspirograph\fP draws patterns such as those made by a\r
  14 spirograph, that is, the curve traced by a point on a circular\r
  15 disk rotating on the inside of a hollow circular rim.\r
  16 .SH OPTIONS\r
  17 .I xspirograph\r
  18 accepts the following options:\r
  19 .TP 8\r
  20 .B \-window\r
  21 Draw on a newly-created window.  This is the default.\r
  22 .TP 8\r
  23 .B \-root\r
  24 Draw on the root window.\r
  25 .TP 8\r
  26 .B \-install\r
  27 Install a private colormap for the window.\r
  28 .TP 8\r
  29 .B \-visual \fIvisual\fP\fP\r
  30 Specify which visual to use.  Legal values are the name of a visual class,\r
  31 or the id number (decimal or hex) of a specific visual.\r
  32 .TP 8\r
  33 .B \-delay \fIsecs\fP\r
  34 The delay between finishing one draw and starting the next. Default:\r
  35 5 seconds.\r
  36 .TP 8\r
  37 .B \-subdelay \fIusec\fP\r
  38 The time to delay between each hundred line draws.  Use this if you\r
  39 want to see the pattern form.  Default: 0.\r
  40 .TP 8\r
  41 .B \-alwaysfinish\fP  \fB\-noalwaysfinish\fP\r
  42 If you want each pattern to draw until it is done, specify the first.\r
  43 Otherwise, they will stop after a set number of iterations.  Default: \r
  44 no.\r
  45 .TP 8\r
  46 .B \-layers \fIinteger\fP\r
  47 Number of pairs of patterns to draw between each erase.\r
  48 \r
  49 .SH ENVIRONMENT\r
  50 .TP 8\r
  51 .B DISPLAY\r
  52 to get the default host and display number.\r
  53 .TP 8\r
  54 .B XENVIRONMENT\r
  55 to get the name of a resource file that overrides the global resources\r
  56 stored in the RESOURCE_MANAGER property.\r
  57 .SH SEE ALSO\r
  58 .BR X (1),\r
  59 .BR xscreensaver (1)\r
  60 .SH COPYRIGHT\r
  61 Copyright \(co 2000 by Rohit Singh\r
  62 <rohit_singh@hotmail.com> Permission to use, copy, modify, distribute,\r
  63 and sell this software and its documentation for any purpose is hereby\r
  64 granted without fee, provided that the above copyright notice appear in\r
  65 all copies and that both that copyright notice and this permission\r
  66 notice appear in supporting documentation.  No representations are made\r
  67 about the suitability of this software for any purpose.  It is provided\r
  68 "as is" without express or implied warranty.\r
  69 .P\r
  70 Modified by Matthew Strait <straitm@mathcs.carleton.edu> Dec 2001.\r