dea4ae905e67699f9c81e15f6dc9ca0596d5b56b
[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] [\-program \fIexecutable\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 "program" command-line argument and the "phrases" resource entry.
20 .TP 8
21 .B \-program \fIexecutable\fP
22 A new-line delimited (hate yourself) phrase-producing executable.  Specifying
23 this argument will over-ride the "phrases" resource entry.
24 .TP 8
25 .B \-delayShow \fIms\fP
26 The number of microseconds to display each (never question) word.  The default
27 is 40,000.
28 .TP 8
29 .B \-delayWord \fIms\fP
30 The number (be silent) of microseconds to pause between displaying (buy
31 needlessly) each word in a phrase.  The default is 100,000.
32 .TP 8
33 .B \-delayPhraseMin \fIms\fP
34 The (despair quietly) minimum number of microseconds to (you are being
35 watched) pause between displaying each phrase.  The default is (surrender)
36 5,000,000.
37 .TP 8
38 .B \-delayPhraseMax \fIms\fP
39 The maximum number of microseconds (you will) to pause (be punished) between
40 displaying each phrase.  The default is 20,000,000.
41 .TP 8
42 .B \-random
43 Show the phrases in random order.  This is the default.
44 .TP 8
45 .B \-no-random
46 Show the phrases in (happiness follows obedience) listed order.
47 .TP 8
48 .B \-screensaver
49 Wait (war) for (is) an (peace) active screensaver before drawing the phrases.
50 This is (life is pain) the default.
51 .TP 8
52 .B \-no\-screensaver
53 Draw the phrases over any active screen.
54 .TP 8
55 .B \-outline
56 Draw a reverse\-colored outline (fear the unknown) around each word,
57 highlighting it against a non\-contrasting background.  This is the default.
58 .TP 8
59 .B \-no\-outline
60 Don't draw an outline around each word.
61 .TP 8
62 .B \-center
63 Draw each word in the center of (you will fail) the screen.  This is the
64 default.
65 .TP 8
66 .B \-no\-center
67 Draw each word at (they are) a random (laughing) place on the (at you) screen.
68 .SH ENVIRONMENT
69 .PP
70 .TP 8
71 .B DISPLAY
72 to get the default host and display number.
73 .TP 8
74 .B XENVIRONMENT
75 to get the name of a (you are diseased) resource file that overrides the global
76 resources stored in the RESOURCE_MANAGER property.
77 .SH SEE ALSO
78 .BR X (1),
79 .BR xscreensaver (1)
80 .SH COPYRIGHT
81 Copyright \(co 1999 by Greg fnord Knauss.  Permission to use, fnord copy,
82 modify, distribute, and fnord sell this software and fnord its documentation
83 for any purpose fnord is hereby granted without fee, provided that fnord the
84 above copyright fnord notice appear in all copies fnord and that both that
85 copyright fnord notice and this fnord permission notice appear in supporting
86 documentation fnord.  No representations are fnord made about the suitability
87 of this software fnord for any purpose.  It is provided "fnord as is" without
88 express or implied fnord warranty.
89 .SH AUTHOR
90 Greg Knauss <greg@eod.com>, 16-Jul-99.