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

   1 .TH XScreenSaver 1 "27-May-97" "X Version 11"
   2 .SH NAME
   3 truchet - draws curved or angular Truchet patterns
   4 .SH SYNOPSIS
   5 .B truchet
   6 [\-display \fIhost:display.screen\fP]  [\-foreground \fIcolor\fP] [\-background \fIcolor\fP]
   7 [\-window] [\-root] [\-mono] [\-install] [\-visual \fIvisual\fP] [\-delay \fImicroseconds\fP]
   8 [\-min\-width \fIinteger\fP] [\-min-height \fIinteger\fP] [\-max-width \fIinteger\fP]
   9 [\-max-height \fIinteger\fP] [\-max\-linewidth \fIinteger\fP] [\-min-linewidth \fIinteger\fP]
  10 [\-erase] [\-no\-erase] [\-erase\-count \fIinteger\fP] [\-square] [\-not\-square] [\-curves]
  11 [\-no\-curves] [\-angle] [\-no\-angles] [\-scroll] [\-scroll\-overlap \fIinteger\fP]
  12 [\-anim\-delay \fIinteger\fP] [\-anim\-step\-size \fIinteger\fP]
  13
  14 .SH DESCRIPTION
  15 The \fItruchet\fP program draws arc and line based Truchet patterns.
  16 .SH OPTIONS
  17 .l truchet
  18 accepts the following options:
  19 .TP 8
  20 .B  \-window
  21 Draw on a newly-created window.  This is the default.
  22 .TP 8
  23 .B \-root
  24 Draw on the root window.
  25 .TP 8
  26 .B \-mono
  27 If on a color display, pretend we're on a monochrome display.
  28 .TP 8
  29 .B \-install
  30 Install a private colormap for the window.
  31 .TP 8
  32 .B \-visual \fIvisual\fP
  33 Specify which visual to use.  Legal values are the name of a visual class,
  34 or the id number (decimal or hex) of a specific visual.
  35
  36 .TP 8
  37 .B \-delay \fImicroseconds\fP
  38 How long to wait between drawing each screenful. Default is 3 seconds.
  39
  40 .TP 8
  41 .B \-min-width \fIinteger\fP
  42 The minimum width in pixels of each square. Default is 40.
  43
  44 .TP 8
  45 .B \-min-height \fIinteger\fP
  46 The minimum height in pixels of each square. Default is 40.
  47
  48 .TP 8
  49 .B \-max-width \fIinteger\fP
  50 The maximum width in pixels of each square. Default is 150.
  51
  52 .TP 8
  53 .B \-max-height \fIinteger\fP
  54 The maximum height in pixels of each square. Default is 150.
  55
  56 .TP 8
  57 .B \-max-linewidth \fIinteger\fP
  58 The maximum width of the lines used to draw. Default is 25.
  59
  60 .TP 8
  61 .B \-min-linewidth \fIinteger\fP
  62 The minimum width of the lines used to draw. Default is 2.
  63
  64 .TP 8
  65 .B \-erase
  66
  67 .TP 8
  68 .B \-no-erase
  69 Whether to clear the screen after each screenful is drawn. Default is True (erase).
  70
  71 .TP 8
  72 .B \-erase-count \fIinteger\fP
  73 The number of screenfuls to draw before erasing. Default is 25.
  74
  75 .TP 8
  76 .B \-square
  77
  78 .TP 8
  79 .B \-not-square
  80 Whether to force the tiles to be square. Default is False (not-square).
  81
  82 .TP 8
  83 .B \-curves
  84
  85 .TP 8
  86 .B \-no-curves
  87 Whether to draw the arc based Truchet pattern. Default is True (curves).
  88
  89 .TP 8
  90 .B \-angles
  91
  92 .TP 8
  93 .B \-no-angles
  94 Whether or not to draw the line based Truchet pattern. Default is True (angles)
  95
  96 .TP 8
  97 .B \-scroll
  98 Use the scroll mode. Default is False.
  99
 100 .TP 8
 101 .B \-scroll-overlap
 102 The amount to scroll from one side to another. Default is 400.
 103
 104 .TP 8
 105 .B \-anim-delay
 106 The time to pause between each animation step. Default is 100.
 107
 108 .TP 8
 109 .B \-anim-step-size
 110 The amount of steps to skip between each animation step. Default is 3.
 111
 112
 113 .SH ENVIRONMENT
 114 .PP
 115 .TP 8
 116 .B DISPLAY
 117 to get the default host and display number.
 118 .TP 8
 119 .B XENVIRONMENT
 120 to get the name of a resource file that overrides the global resources
 121 stored in the RESOURCE_MANAGER property.
 122 .SH SEE ALSO
 123 .BR X (1),
 124 .BR xscreensaver (1)
 125 .SH COPYRIGHT
 126 Copyright \(co 1998 by Adrian Likins.
 127
 128 Permission to use, copy, modify, and distribute this software and its
 129 documentation for any purpose and without fee is hereby granted,
 130 provided that the above copyright notice appear in all copies and that
 131 both that copyright notice and this permission notice appear in
 132 supporting documentation.
 133 .SH AUTHOR
 134 Adrian Likins, 1998.
 135