git.hungrycats.org Git - xscreensaver/blob - hacks/glx/splitflap.man

   1 .TH XScreenSaver 1 "" "X Version 11"
   2 .SH NAME
   3 splitflap - a simulation of a split-flap electromechanical display.
   4 .SH SYNOPSIS
   5 .B splitflap
   6 [\-display \fIhost:display.screen\fP]
   7 [\-visual \fIvisual\fP]
   8 [\-window]
   9 [\-root]
  10 [\-delay \fImicroseconds\fP]
  11 [\-speed \fIfloat\fP]
  12 [\-width \fIcolumns\fP]
  13 [\-height \fIrows\fP]
  14 [\-mode text | clock12 | clock24]
  15 [\-no-wander]
  16 [\-spin \fIaxes\fP]
  17 [\-no\-spin]
  18 [\-front] [\-no-front]
  19 [\-wireframe]
  20 [\-fps]
  21 .SH DESCRIPTION
  22 Simulates a split-flap display, an old style of electromechanical sign as
  23 seen in airports and train stations, and commonly used in alarm clocks in
  24 the 1960s and 1970s.
  25 .SH OPTIONS
  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 \-window
  32 Draw on a newly-created window.  This is the default.
  33 .TP 8
  34 .B \-root
  35 Draw on the root window.
  36 .TP 8
  37 .B \-delay \fInumber\fP
  38 Per-frame delay, in microseconds.  Default: 20000 (0.02 seconds).
  39 .TP 8
  40 .B \-speed \fInumber\fP
  41 Animation speed.  2.0 means twice as fast, 0.5 means half as fast.
  42 .TP 8
  43 .B \-width \fInumber\fP
  44 Columns of the display.  Default: 22.
  45 .TP 8
  46 .B \-height \fInumber\fP
  47 Rows of the display. Default: 8.
  48 .TP 8
  49 .B \-mode clock12
  50 Display a 12-hour clock.
  51 .TP 8
  52 .B \-mode clock24
  53 Display a 24-hour clock.
  54 .TP 8
  55 .B \-front | \-no-front
  56 When spinning, never spin all the way around or upside down:
  57 always face mostly forward so that the text is easily readable.
  58 This is the default.
  59 .TP 8
  60 .B \-no\-front
  61 Allow spins to go all the way around or upside down.
  62 .TP 8
  63 .B \-wander | \-no-wander
  64 Whether the object should wander around the screen.
  65 .TP 8
  66 .B \-spin
  67 Which axes around which the text should spin.  The default is "XYZ",
  68 meaning rotate it freely in space.  "\fB\-spin Z\fP" would rotate the
  69 text in the plane of the screen while not rotating it into or out
  70 of the screen; etc.
  71 .TP 8
  72 .B \-wireframe | \-no-wireframe
  73 Render in wireframe instead of solid.
  74 .TP 8
  75 .B \-fps | \-no-fps
  76 Whether to show a frames-per-second display at the bottom of the screen.
  77 .SH ENVIRONMENT
  78 .PP
  79 .TP 8
  80 .B DISPLAY
  81 to get the default host and display number.
  82 .TP 8
  83 .B XENVIRONMENT
  84 to get the name of a resource file that overrides the global resources
  85 stored in the RESOURCE_MANAGER property.
  86 .SH SEE ALSO
  87 .BR X (1),
  88 .BR xscreensaver (1)
  89 .SH COPYRIGHT
  90 Copyright \(co 2015 by Jamie Zawinski.  Permission to use, copy, modify,
  91 distribute, and sell this software and its documentation for any purpose is
  92 hereby granted without fee, provided that the above copyright notice appear
  93 in all copies and that both that copyright notice and this permission notice
  94 appear in supporting documentation.  No representations are made about the
  95 suitability of this software for any purpose.  It is provided "as is" without
  96 express or implied warranty.
  97 .SH AUTHOR
  98 Jamie Zawinski.