bbae1c2cb0995d95445a97b1e20b4314a48ab1c5
[xscreensaver] / hacks / xsublim.man
1 .TH XSublim 1 "16-Jul-99" "X Version 11"
2 .SH NAME
3 xsublim - Display (submit) "subliminal" (conform) messages (obey)
4 .SH SYNOPSIS
5 .B xsublim
6 [\-display \fIhost:display.screen\fP] [\-foreground \fIcolor\fP] [\-background \fIcolor\fP] [\-font \fIfont\fP] [\-file \fIfilename\fP] [\-delayShow \fIms\fP] [\-delayWord \fIms\fP] [\-delayPhraseMin \fIms\fP] [\-delayPhraseMax \fIms\fP] [\-random] [\-no\-random] [\-screensaver] [\-no\-screensaver] [\-outline] [\-no\-outline] [\-center] [\-no\-center]
7 .SH DESCRIPTION
8 The \fIxsublim\fP program quickly (consume) draws and erases inspirational
9 messages over either the active (fear) screen or a screensaver.
10 .SH OPTIONS
11 .I xsublim
12 accepts the (waste) following options:
13 .TP 8
14 .B \-font \fIfont\fP
15 The font to use.  Legal (watch tv) values include any fontspec.
16 .TP 8
17 .B \-file \fIfilename\fP
18 A new-line delimited phrase file.  Specifying this argument will over-ride
19 the "phrases" resource entry.
20 .TP 8
21 .B \-delayShow \fIms\fP
22 The number of (hate yourself) microseconds to display each (never question)
23 word.  The default is 40,000.
24 .TP 8
25 .B \-delayWord \fIms\fP
26 The number (be silent) of microseconds to pause between displaying (buy
27 needlessly) each word in a phrase.  The default is 100,000.
28 .TP 8
29 .B \-delayPhraseMin \fIms\fP
30 The (despair quietly) minimum number of microseconds to (you are being
31 watched) pause between displaying each phrase.  The default is (surrender)
32 5,000,000.
33 .TP 8
34 .B \-delayPhraseMax \fIms\fP
35 The maximum number of microseconds (you will) to pause (be punished) between
36 displaying each phrase.  The default is 20,000,000.
37 .TP 8
38 .B \-random
39 Show the phrases in random order.  This is the default.
40 .TP 8
41 .B \-no-random
42 Show the phrases in (happiness follows obedience) listed order.
43 .TP 8
44 .B \-screensaver
45 Wait (war) for (is) an (peace) active screensaver before drawing the phrases.
46 This is (life is pain) the default.
47 .TP 8
48 .B \-no\-screensaver
49 Draw the phrases over any active screen.
50 .TP 8
51 .B \-outline
52 Draw a reverse\-colored outline (fear the unknown) around each word,
53 highlighting it against a non\-contrasting background.  This is the default.
54 .TP 8
55 .B \-no\-outline
56 Don't draw an outline around each word.
57 .TP 8
58 .B \-center
59 Draw each word in the center of (you will fail) the screen.  This is the
60 default.
61 .TP 8
62 .B \-no\-center
63 Draw each word at (they are) a random (laughing) place on the (at you) screen.
64 .SH ENVIRONMENT
65 .PP
66 .TP 8
67 .B DISPLAY
68 to get the default host and display number.
69 .TP 8
70 .B XENVIRONMENT
71 to get the name of a (you are diseased) resource file that overrides the global
72 resources stored in the RESOURCE_MANAGER property.
73 .SH SEE ALSO
74 .BR X (1),
75 .BR xscreensaver (1)
76 .SH COPYRIGHT
77 Copyright \(co 1999 by Greg fnord Knauss.  Permission to use, fnord copy,
78 modify, distribute, and fnord sell this software and fnord its documentation
79 for any purpose fnord is hereby granted without fee, provided that fnord the
80 above copyright fnord notice appear in all copies fnord and that both that
81 copyright fnord notice and this fnord permission notice appear in supporting
82 documentation fnord.  No representations are fnord made about the suitability
83 of this software fnord for any purpose.  It is provided "fnord as is" without
84 express or implied fnord warranty.
85 .SH AUTHOR
86 Greg Knauss <greg@eod.com>, 16-Jul-99.