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

   1 .TH XScreenSaver 1 "24-May-97" "X Version 11"
   2 .SH NAME
   3 flag - draws a waving flag, containing text or an image
   4 .SH SYNOPSIS
   5 .B flag
   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] [\-size \fIinteger\fP] [\-text \fIstring\fP] [\-font \fIfont\fP] [\-bitmap \fIxbm-file\fP]
   7
   8 [\-fps]
   9 .SH DESCRIPTION
  10 The \fIflag\fP program draws a waving flag that contains text or a bitmap.
  11 .SH OPTIONS
  12 .I flag
  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 200.
  33 .TP 8
  34 .B \-cycles \fIinteger\fP
  35
  36 .TP 8
  37 .B \-count \fIinteger\fP
  38
  39 .TP 8
  40 .B \-size \fIinteger\fP
  41 How large the pixels in the flag should be, from 1 to 8.
  42 If this is a negative number, the pixel size is chosen randomly
  43 from the range 1 to -size.  Default -7.
  44 .TP 8
  45 .B \-text \fItext\fP
  46 The text to display in the flag.  Multiple lines of text are allowed;
  47 the lines will be displayed centered atop one another.  Default: none.
  48 If the text is the magic string \fI"(default)"\fP, then the text used
  49 will be the local machine name; a newline; and the local OS version.
  50 .TP 8
  51 .B \-bitmap \fIxbm-file\fP
  52 The bitmap to display in the flag; this must be an XBM file (color XPMs
  53 are not allowed.)  Default: none.  If the bitmap is the magic
  54 string \fI"(default)"\fP, then the bitmap used will be a charming
  55 little picture of J. R. "Bob" Dobbs.
  56
  57 If neither \fI\-text\fP nor \fI\-bitmap\fP are specified, then either
  58 the builtin text or the builtin bitmap will be chosen randomly.
  59 .TP 8
  60 .B \-font \fIfont\fP
  61 The font in which to draw the text; the default is
  62 "-*-helvetica-bold-r-*-240-*".
  63 .TP 8
  64 .B \-fps
  65 Display the current frame rate and CPU load.
  66 .SH ENVIRONMENT
  67 .PP
  68 .TP 8
  69 .B DISPLAY
  70 to get the default host and display number.
  71 .TP 8
  72 .B XENVIRONMENT
  73 to get the name of a resource file that overrides the global resources
  74 stored in the RESOURCE_MANAGER property.
  75 .SH SEE ALSO
  76 .BR X (1),
  77 .BR xscreensaver (1),
  78 .BR xlock (1)
  79 .SH COPYRIGHT
  80 Copyright \(co 1996 Charles Vidal.
  81
  82 Permission to use, copy, modify, and distribute this software and its
  83 documentation for any purpose and without fee is hereby granted,
  84 provided that the above copyright notice appear in all copies and that
  85 both that copyright notice and this permission notice appear in
  86 supporting documentation.
  87
  88 .SH AUTHOR
  89 Charles Vidal <vidalc@univ-mlv.fr>, 1996.
  90
  91 Ability to run standalone or with \fIxscreensaver\fP, and the \-text
  92 and \-bitmap options, added by Jamie Zawinski <jwz@jwz.org>, 24-May-97.