dbea06633a70427c8ecd2366f6f959f8576d3c6d
[xscreensaver] / local / man / cat.1 / xscreensaver-demo.1
1
2
3
4 XScreenSaver(1)                                   XScreenSaver(1)
5
6
7 N\bNA\bAM\bME\bE
8        xscreensaver-demo  -  interactively control the background
9        xscreensaver daemon
10
11 S\bSY\bYN\bNO\bOP\bPS\bSI\bIS\bS
12        x\bxs\bsc\bcr\bre\bee\ben\bns\bsa\bav\bve\ber\br-\b-d\bde\bem\bmo\bo [-display _\bh_\bo_\bs_\bt_\b:_\bd_\bi_\bs_\bp_\bl_\ba_\by_\b._\bs_\bc_\br_\be_\be_\bn]  [-prefs]
13        [-xrm _\br_\be_\bs_\bo_\bu_\br_\bc_\be_\bs]
14
15 D\bDE\bES\bSC\bCR\bRI\bIP\bPT\bTI\bIO\bON\bN
16        The _\bx_\bs_\bc_\br_\be_\be_\bn_\bs_\ba_\bv_\be_\br_\b-_\bd_\be_\bm_\bo program is a graphical front-end for
17        setting the parameters used  by  the  background  x\bxs\bsc\bcr\bre\bee\ben\bn-\b-
18        s\bsa\bav\bve\ber\br(1) daemon.  It is essentially two things: a tool for
19        editing the _\b~_\b/_\b._\bx_\bs_\bc_\br_\be_\be_\bn_\bs_\ba_\bv_\be_\br file; and a tool  for  demoing
20        the  various  graphics  hacks that the _\bx_\bs_\bc_\br_\be_\be_\bn_\bs_\ba_\bv_\be_\br daemon
21        will launch.
22
23        The main dialog box contains  a  scrolling  list,  a  text
24        field, and a number of buttons.
25
26        Double-clicking  on  one  of the programs in the list will
27        run it.  The screen will go black, and  the  program  will
28        run  in full-screen mode, just as it would if the _\bx_\bs_\bc_\br_\be_\be_\bn_\b-
29        _\bs_\ba_\bv_\be_\br daemon had launched it.  Clicking  the  mouse  again
30        will  stop  the  demo  and un-blank the screen, making the
31        dialog box visible again.
32
33        Single-clicking in the list will place the indicated  pro-
34        gram  and  its  args in the text field to be edited.  Edit
35        the arguments and hit return to run the program  with  the
36        parameters  you  have specified.  This will also save your
37        changes to your _\b~_\b/_\b._\bx_\bs_\bc_\br_\be_\be_\bn_\bs_\ba_\bv_\be_\br file: so any  changes  you
38        make in this way are persistent.
39
40        If  one of the lines in the scrolling list begins with the
41        character "-", then that means that the  program  is  dis-
42        abled:  _\bx_\bs_\bc_\br_\be_\be_\bn_\bs_\ba_\bv_\be_\br  will not select it to be run (though
43        you can still try it out by clicking on it.)  Rather  than
44        just  deleting  the  programs  you  don't want to run, you
45        might want to disable them in this way  instead,  so  that
46        you can more easily change your mind later.
47
48        If  the line begins with the name of a visual, followed by
49        a colon, then that program will only be run on  that  kind
50        of visual.  For example, you can specify that a particular
51        program should only be run  if  color  is  available,  and
52        another should only be run in monochrome.  See the discus-
53        sion of the _\bp_\br_\bo_\bg_\br_\ba_\bm_\bs parameter in the  _\bC_\bo_\bn_\bf_\bi_\bg_\bu_\br_\ba_\bt_\bi_\bo_\bn  sec-
54        tion of the x\bxs\bsc\bcr\bre\bee\ben\bns\bsa\bav\bve\ber\br(1) manual.
55
56        The buttons are:
57
58        R\bRu\bun\bn N\bNe\bex\bxt\bt
59                Clicking  this button will run the next program in
60                the list after  the  currently-selected  one,  and
61
62
63
64 X Version 11             20-Jun-99 (3.15)                       1
65
66
67
68
69
70 XScreenSaver(1)                                   XScreenSaver(1)
71
72
73                will  wrap  around  to the top when it reaches the
74                bottom.
75
76        R\bRu\bun\bn P\bPr\bre\bev\bvi\bio\bou\bus\bs
77                Opposite of Run Next; at the top, it wraps  around
78                to the bottom.
79
80        P\bPr\bre\bef\bfe\ber\bre\ben\bnc\bce\bes\bs
81                This  pops  up  a  second dialog box, in which you
82                have the option to interactively  change  most  of
83                the  screensaver's operational parameters, such as
84                its timeouts,  and  whether  it  should  lock  the
85                screen.   When  you click OK, your chosen settings
86                will take effect immediately,  and  will  also  be
87                saved  to  the  _\b~_\b/_\b._\bx_\bs_\bc_\br_\be_\be_\bn_\bs_\ba_\bv_\be_\br  file in your home
88                directory, so that the settings will persist  next
89                time.
90
91        Q\bQu\bui\bit\bt    Exits  the  _\bx_\bs_\bc_\br_\be_\be_\bn_\bs_\ba_\bv_\be_\br_\b-_\bd_\be_\bm_\bo  program.  The back-
92                ground _\bx_\bs_\bc_\br_\be_\be_\bn_\bs_\ba_\bv_\be_\br daemon will  continue  running
93                as before.
94
95        The  Preferences  dialog box lets you change the following
96        settings.
97
98        (There are more settings available, but these are the most
99        commonly used ones; see the manual for x\bxs\bsc\bcr\bre\bee\ben\bns\bsa\bav\bve\ber\br(1) for
100        other  parameters  that  can  be  set   by   editing   the
101        _\b~_\b/_\b._\bx_\bs_\bc_\br_\be_\be_\bn_\bs_\ba_\bv_\be_\br file, or the X resource database.)
102
103        S\bSa\bav\bve\ber\br T\bTi\bim\bme\beo\bou\but\bt
104                After  the  user  has  been  idle  this  long, the
105                _\bx_\bs_\bc_\br_\be_\be_\bn_\bs_\ba_\bv_\be_\br daemon will blank the screen.
106
107        C\bCy\byc\bcl\ble\be T\bTi\bim\bme\beo\bou\but\bt
108                After the screensaver has been  running  for  this
109                long,  the currently running graphics demo will be
110                killed, and a new one started.  If this is 0, then
111                the  graphics demo will never be changed: only one
112                demo will run until the screensaver is deactivated
113                by user activity.
114
115        V\bVe\ber\brb\bbo\bos\bse\be
116                Whether to print lots of debugging information.
117
118        I\bIn\bns\bst\bta\bal\bll\bl C\bCo\bol\blo\bor\brm\bma\bap\bp
119                Whether  to  install  a private colormap while the
120                screensaver is active, so that the graphics  hacks
121                can  get  as  many colors as possible.  (This only
122                applies when the screen's default visual is  being
123                used, since non-default visuals get their own col-
124                ormaps automatically.)  This can also be  overrid-
125                den on a per-demo basis.
126
127
128
129
130 X Version 11             20-Jun-99 (3.15)                       2
131
132
133
134
135
136 XScreenSaver(1)                                   XScreenSaver(1)
137
138
139        F\bFa\bad\bde\be C\bCo\bol\blo\bor\brm\bma\bap\bp
140                If  selected, then when the screensaver activates,
141                the current contents of the screen  will  fade  to
142                black  instead  of  simply winking out.  This only
143                works on displays with  writable  colormaps,  that
144                is,  if  the  screen's default visual is a Pseudo-
145                Color visual.  A  fade  will  also  be  done  when
146                switching  graphics  hacks (when the _\bC_\by_\bc_\bl_\be _\bT_\bi_\bm_\be_\bo_\bu_\bt
147                expires.)
148
149        U\bUn\bnf\bfa\bad\bde\be C\bCo\bol\blo\bor\brm\bma\bap\bp
150                The complement to _\bF_\ba_\bd_\be _\bC_\bo_\bl_\bo_\br_\bm_\ba_\bp: if selected, then
151                when  the  screensaver  deactivates,  the original
152                contents of the screen will  fade  in  from  black
153                instead of appearing immediately.  This only works
154                on displays with writable colormaps, and when _\bF_\ba_\bd_\be
155                _\bC_\bo_\bl_\bo_\br_\bm_\ba_\bp is also selected.
156
157        F\bFa\bad\bde\be D\bDu\bur\bra\bat\bti\bio\bon\bn
158                When  fading  or  unfading are selected, this con-
159                trols how long the fade will take.
160
161        F\bFa\bad\bde\be T\bTi\bic\bck\bks\bs
162                This controls how many times a second the colormap
163                will  be changed to effect a fade.  Higher numbers
164                yield smoother fades, but may make the fades  take
165                longer  than  the  specified number of seconds, if
166                your server isn't fast enough to keep up.
167
168        R\bRe\beq\bqu\bui\bir\bre\be P\bPa\bas\bss\bsw\bwo\bor\brd\bd
169                Whether the screen saver should  lock  the  screen
170                when it activates.
171
172        L\bLo\boc\bck\bk T\bTi\bim\bme\beo\bou\but\bt
173                If _\bR_\be_\bq_\bu_\bi_\br_\be _\bP_\ba_\bs_\bs_\bw_\bo_\br_\bd is selected, this controls the
174                length of the ``grace period''  between  when  the
175                screensaver activates, and when the screen becomes
176                locked.  For example,  if  this  is  0:05:00,  and
177                _\bS_\ba_\bv_\be_\br  _\bT_\bi_\bm_\be_\bo_\bu_\bt  is 0:10:00, then after 10 minutes,
178                the screen would blank.  If there was user  activ-
179                ity  at  12 minutes, no password would be required
180                to un-blank the screen.  But, if  there  was  user
181                activity  at  15  minutes  or later (that is, _\bL_\bo_\bc_\bk
182                _\bT_\bi_\bm_\be_\bo_\bu_\bt minutes after activation) then a  password
183                would be required.  The default is 0, meaning that
184                if locking is enabled, then  a  password  will  be
185                required as soon as the screen blanks.
186
187        P\bPa\bas\bss\bsw\bwo\bor\brd\bd T\bTi\bim\bme\beo\bou\but\bt
188                When  the screensaver is prompting for a password,
189                the prompt dialog box will stay on the screen  for
190                this  long  before  giving  up,  and  reverting to
191                screen-saving mode.
192
193
194
195
196 X Version 11             20-Jun-99 (3.15)                       3
197
198
199
200
201
202 XScreenSaver(1)                                   XScreenSaver(1)
203
204
205 C\bCO\bOM\bMM\bMA\bAN\bND\bD-\b-L\bLI\bIN\bNE\bE O\bOP\bPT\bTI\bIO\bON\bNS\bS
206        _\bx_\bs_\bc_\br_\be_\be_\bn_\bs_\ba_\bv_\be_\br_\b-_\bd_\be_\bm_\bo  accepts  the  following  command   line
207        options.
208
209        -\b-d\bdi\bis\bsp\bpl\bla\bay\by _\bh_\bo_\bs_\bt_\b:_\bd_\bi_\bs_\bp_\bl_\ba_\by_\b._\bs_\bc_\br_\be_\be_\bn
210                The  X display to use.  The _\bx_\bs_\bc_\br_\be_\be_\bn_\bs_\ba_\bv_\be_\br_\b-_\bd_\be_\bm_\bo pro-
211                gram will open its window  on  that  display,  and
212                also  control the _\bx_\bs_\bc_\br_\be_\be_\bn_\bs_\ba_\bv_\be_\br daemon that is man-
213                aging that same display.
214
215        -\b-p\bpr\bre\bef\bfs\bs  Start up in Preferences mode: this  is  just  like
216                launching  the program with no arguments, and then
217                pressing the _\bP_\br_\be_\bf_\be_\br_\be_\bn_\bc_\be_\bs button.
218
219        It  is  important  that  the  _\bx_\bs_\bc_\br_\be_\be_\bn_\bs_\ba_\bv_\be_\br  and   _\bx_\bs_\bc_\br_\be_\be_\bn_\b-
220        _\bs_\ba_\bv_\be_\br_\b-_\bd_\be_\bm_\bo processes be running on the same machine, or at
221        least, on two machines that share  a  file  system.   When
222        _\bx_\bs_\bc_\br_\be_\be_\bn_\bs_\ba_\bv_\be_\br_\b-_\bd_\be_\bm_\bo  writes a new version of the _\b~_\b/_\b._\bx_\bs_\bc_\br_\be_\be_\bn_\b-
223        _\bs_\ba_\bv_\be_\br file, it's important that the _\bx_\bs_\bc_\br_\be_\be_\bn_\bs_\ba_\bv_\be_\br see  that
224        same  file.   If  the  two  processes are seeing different
225        _\b~_\b/_\b._\bx_\bs_\bc_\br_\be_\be_\bn_\bs_\ba_\bv_\be_\br files, things will malfunction.
226
227 E\bEN\bNV\bVI\bIR\bRO\bON\bNM\bME\bEN\bNT\bT
228        D\bDI\bIS\bSP\bPL\bLA\bAY\bY to get the default host and display number.
229
230        P\bPA\bAT\bTH\bH    to find the sub-programs to  run.   However,  note
231                that the sub-programs are actually launched by the
232                _\bx_\bs_\bc_\br_\be_\be_\bn_\bs_\ba_\bv_\be_\br  daemon,  not  by   _\bx_\bs_\bc_\br_\be_\be_\bn_\bs_\ba_\bv_\be_\br_\b-_\bd_\be_\bm_\bo
233                itself.   So,  what  matters  is  what  $\b$P\bPA\bAT\bTH\bH  the
234                _\bx_\bs_\bc_\br_\be_\be_\bn_\bs_\ba_\bv_\be_\br program sees.
235
236        H\bHO\bOM\bME\bE    for the directory in which to read and  write  the
237                _\b._\bx_\bs_\bc_\br_\be_\be_\bn_\bs_\ba_\bv_\be_\br file.
238
239        X\bXE\bEN\bNV\bVI\bIR\bRO\bON\bNM\bME\bEN\bNT\bT
240                to  get the name of a resource file that overrides
241                the global resources stored in  the  RESOURCE_MAN-
242                AGER property.
243
244 U\bUP\bPG\bGR\bRA\bAD\bDE\bES\bS
245        The    latest    version    can   always   be   found   at
246        http://www.jwz.org/xscreensaver/
247
248 S\bSE\bEE\bE A\bAL\bLS\bSO\bO
249        X\bX(1), x\bxs\bsc\bcr\bre\bee\ben\bns\bsa\bav\bve\ber\br(1), x\bxs\bsc\bcr\bre\bee\ben\bns\bsa\bav\bve\ber\br-\b-c\bco\bom\bmm\bma\ban\bnd\bd(1)
250
251 C\bCO\bOP\bPY\bYR\bRI\bIG\bGH\bHT\bT
252        Copyright (C) 1992, 1993, 1997, 1998, 1999 by Jamie Zawin-
253        ski.   Permission  to  use,  copy, modify, distribute, and
254        sell this software and its documentation for  any  purpose
255        is  hereby  granted  without  fee, provided that the above
256        copyright notice appear in all copies and that  both  that
257        copyright notice and this permission notice appear in sup-
258        porting documentation.  No representations are made  about
259
260
261
262 X Version 11             20-Jun-99 (3.15)                       4
263
264
265
266
267
268 XScreenSaver(1)                                   XScreenSaver(1)
269
270
271        the  suitability  of this software for any purpose.  It is
272        provided "as is" without express or implied warranty.
273
274 A\bAU\bUT\bTH\bHO\bOR\bR
275        Jamie Zawinski <jwz@jwz.org>, 13-aug-92.
276
277        Please let me know if  you  find  any  bugs  or  make  any
278        improvements.
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328 X Version 11             20-Jun-99 (3.15)                       5
329
330