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