ftp://ftp.sunet.se/pub/vendor/sco/skunkware/osr5/x11/savers/xscreensaver/xscreensaver...

[xscreensaver] / local / man / cat.1 / xscreensaver.1

                                                                1





XScreenSaver(1)                                   XScreenSaver(1)


N\bNA\bAM\bME\bE
       xscreensaver  -  graphics hack and screen locker, launched
       when the user is idle

S\bSY\bYN\bNO\bOP\bPS\bSI\bIS\bS
       x\bxs\bsc\bcr\bre\bee\ben\bns\bsa\bav\bve\ber\br [-display _\bh_\bo_\bs_\bt_\b:_\bd_\bi_\bs_\bp_\bl_\ba_\by_\b._\bs_\bc_\br_\be_\be_\bn] [-timeout _\bi_\bn_\bt]
       [-cycle _\bi_\bn_\bt] [-nice _\bi_\bn_\bt] [-lock] [-no-lock] [-lock-timeout
       _\bi_\bn_\bt] [-demo]  [-visual  _\bv_\bi_\bs_\bu_\ba_\bl]  [-install]  [-no-install]
       [-verbose]  [-silent] [-xidle-extension] [-no-xidle-exten-
       sion]  [-sgi-extension]  [-no-sgi-extension]  [-mit-exten-
       sion] [-no-mit-extension] [-xrm _\br_\be_\bs_\bo_\bu_\br_\bc_\be_\bs]

D\bDE\bES\bSC\bCR\bRI\bIP\bPT\bTI\bIO\bON\bN
       The  _\bx_\bs_\bc_\br_\be_\be_\bn_\bs_\ba_\bv_\be_\br  program  waits  until  the keyboard and
       mouse have been idle for a period, and then runs a  graph-
       ics  demo chosen at random.  It turns off as soon as there
       is any mouse or keyboard activity.

       This program can lock your terminal in  order  to  prevent
       others from using it, though its default mode of operation
       is merely to display pretty pictures on your  screen  when
       it is not in use.

       The  benefit that this program has over the combination of
       the x\bxl\blo\boc\bck\bk(1) and x\bxa\bau\but\bto\bol\blo\boc\bck\bk(1) programs is  the  ease  with
       which new graphics hacks can be installed.  You don't need
       to recompile (or even re-run) this program to  add  a  new
       display mode.

O\bOP\bPT\bTI\bIO\bON\bNS\bS
       _\bx_\bs_\bc_\br_\be_\be_\bn_\bs_\ba_\bv_\be_\br accepts the following command line options:

       -\b-t\bti\bim\bme\beo\bou\but\bt _\bm_\bi_\bn_\bu_\bt_\be_\bs
               The  screensaver  will activate after the keyboard
               and mouse have been idle for  this  many  minutes.
               Default 10.

       -\b-c\bcy\byc\bcl\ble\be _\bm_\bi_\bn_\bu_\bt_\be_\bs
               After  the  screensaver  has been running for this
               many minutes, the currently running graphics  hack
               sub-process  will  be killed (with S\bSI\bIG\bGT\bTE\bER\bRM\bM), and a
               new one started.  If this is 0, then the  graphics
               hack  will  not be changed: only one demo will run
               until  the  screensaver  is  deactivated  by  user
               activity.  Default 10.

       -\b-n\bni\bic\bce\be _\bi_\bn_\bt_\be_\bg_\be_\br
               The  sub-processes created by _\bx_\bs_\bc_\br_\be_\be_\bn_\bs_\ba_\bv_\be_\br will be
               ``niced'' to this level, so that  they  are  given
               lower priority than other processes on the system,
               and don't increase the  load  unnecessarily.   The
               default is 20.

               (Higher  numbers  mean lower priority; see n\bni\bic\bce\be(1)



X Version 11                31-May-97                           1





XScreenSaver(1)                                   XScreenSaver(1)


               for details.)

       -\b-l\blo\boc\bck\bk   Enable locking: before the screensaver  will  turn
               off,  it  requires you to type the password of the
               person who launched the screensaver, or  the  root
               password.  (Note: this doesn't work if the screen-
               saver is launched by x\bxd\bdm\bm(1) because it can't  know
               the user-id of the logged-in user.)

       -\b-n\bno\bo-\b-l\blo\boc\bck\bk
               Disable locking.  This is the default.

       -\b-l\blo\boc\bck\bk-\b-t\bti\bim\bme\beo\bou\but\bt _\bm_\bi_\bn_\bu_\bt_\be_\bs
               This  is  how long after the screensaver activates
               that locking is enabled.  For example, if this  is
               5,  and _\b-_\bt_\bi_\bm_\be_\bo_\bu_\bt is 10, then after 10 minutes, the
               screen would blank.  If there was user activity at
               12  minutes,  no password would be required.  But,
               if there was user activity at 15 minutes or  later
               (_\b-_\bl_\bo_\bc_\bk_\b-_\bt_\bi_\bm_\be_\bo_\bu_\bt  minutes  after  activation) then a
               password would be required.   The  default  is  0,
               meaning  that  if locking is enabled, then a pass-
               word will be required as soon as  the  screensaver
               activates.

       -\b-d\bde\bem\bmo\bo   Enter  the interactive demo mode immediately after
               startup.  Normally demo mode is  invoked  via  the
               x\bxs\bsc\bcr\bre\bee\ben\bns\bsa\bav\bve\ber\br-\b-c\bco\bom\bmm\bma\ban\bnd\bd(1)  program,  but  this  is a
               shortcut for new users.  See below for a  descrip-
               tion of how demo-mode works.

       -\b-v\bvi\bis\bsu\bua\bal\bl _\bv_\bi_\bs_\bu_\ba_\bl
               Specify  which  X visual to use by default.  Legal
               values are:

               d\bde\bef\bfa\bau\bul\blt\bt Use  the  screen's  default  visual   (the
                       visual  of  the root window.)  This is the
                       default.

               b\bbe\bes\bst\bt    Use the visual  which  supports  the  most
                       colors.   Note,  however,  that the visual
                       with the most colors might be a  TrueColor
                       visual,  which  does  not support colormap
                       animation.

               m\bmo\bon\bno\bo    Use a monochrome visual, if there is  one.

               g\bgr\bra\bay\by    Use  a  grayscale or staticgray visual, if
                       there is one and  it  has  more  than  one
                       plane (that is, it's not monochrome.)

               c\bco\bol\blo\bor\br   Use  the  best  of  the  color visuals, if
                       there are any.




X Version 11                31-May-97                           2





XScreenSaver(1)                                   XScreenSaver(1)


               _\bc_\bl_\ba_\bs_\bs   where _\bc_\bl_\ba_\bs_\bs is one

                       of  S\bSt\bta\bat\bti\bic\bcG\bGr\bra\bay\by,  S\bSt\bta\bat\bti\bic\bcC\bCo\bol\blo\bor\br,   T\bTr\bru\bue\beC\bCo\bol\blo\bor\br,
                       G\bGr\bra\bay\byS\bSc\bca\bal\ble\be,  P\bPs\bse\beu\bud\bdo\boC\bCo\bol\blo\bor\br,  or  D\bDi\bir\bre\bec\bct\btC\bCo\bol\blo\bor\br.
                       Selects the deepest visual  of  the  given
                       class.

               _\bn_\bu_\bm_\bb_\be_\br  where  _\bn_\bu_\bm_\bb_\be_\br  (decimal  or hex) is inter-
                       preted as a visual id number, as  reported
                       by  the  x\bxd\bdp\bpy\byi\bin\bnf\bfo\bo(1)  program; in this way
                       you can have finer  control  over  exactly
                       which  visual  gets  used, for example, to
                       select a shallower one than  would  other-
                       wise have been chosen.

               Note  that  this option specifies only the _\bd_\be_\bf_\ba_\bu_\bl_\bt
               visual that will be used: the visual used  may  be
               overridden on a program-by-program basis.  See the
               description of the p\bpr\bro\bog\bgr\bra\bam\bms\bs resource, below.

       -\b-i\bin\bns\bst\bta\bal\bll\bl
               When using a non-default visual, install a private
               colormap  while the screensaver is active, so that
               the graphics hacks can get as many colors as  pos-
               sible.    This is the default.  (This only applies
               when the screen's default visual  is  being  used,
               since  non-default visuals get their own colormaps
               automatically.)

       -\b-n\bno\bo-\b-i\bin\bns\bst\bta\bal\bll\bl
               Use the default colormap.

       -\b-v\bve\ber\brb\bbo\bos\bse\be
               Print diagnostics.

       -\b-s\bsi\bil\ble\ben\bnt\bt

       -\b-x\bxi\bid\bdl\ble\be-\b-e\bex\bxt\bte\ben\bns\bsi\bio\bon\bn
               Use the X\bXI\bID\bDL\bLE\bE server extension to  decide  whether
               the user is idle.  This is the default if _\bx_\bs_\bc_\br_\be_\be_\bn_\b-
               _\bs_\ba_\bv_\be_\br has been  compiled  with  support  for  this
               extension.   On  X11R4 or X11R5 systems, the XIdle
               method is faster and more reliable than what  will
               be done otherwise, so use it if you can.

       -\b-n\bno\bo-\b-x\bxi\bid\bdl\ble\be-\b-e\bex\bxt\bte\ben\bns\bsi\bio\bon\bn
               Don't use the X\bXI\bID\bDL\bLE\bE server extension.

       -\b-s\bsg\bgi\bi-\b-e\bex\bxt\bte\ben\bns\bsi\bio\bon\bn
               Use  the  SGI  S\bSC\bCR\bRE\bEE\bEN\bN_\b_S\bSA\bAV\bVE\bER\bR  server  extension  to
               decide whether the user  is  idle.   This  is  the
               default  if  _\bx_\bs_\bc_\br_\be_\be_\bn_\bs_\ba_\bv_\be_\br  has  been compiled with
               support for this extension (which is  the  default
               on   SGI  systems.).   If  it  is  available,  the



X Version 11                31-May-97                           3





XScreenSaver(1)                                   XScreenSaver(1)


               S\bSC\bCR\bRE\bEE\bEN\bN_\b_S\bSA\bAV\bVE\bER\bR method is faster  and  more  reliable
               than what will be done otherwise, so use it if you
               can.

       -\b-n\bno\bo-\b-s\bsg\bgi\bi-\b-e\bex\bxt\bte\ben\bns\bsi\bio\bon\bn
               Don't use the SGI S\bSC\bCR\bRE\bEE\bEN\bN_\b_S\bSA\bAV\bVE\bER\bR server extension.

       -\b-m\bmi\bit\bt-\b-e\bex\bxt\bte\ben\bns\bsi\bio\bon\bn
               Use  the  M\bMI\bIT\bT-\b-S\bSC\bCR\bRE\bEE\bEN\bN-\b-S\bSA\bAV\bVE\bER\bR  server  extension   to
               decide  whether  the  user  is  idle.  This is the
               default if _\bx_\bs_\bc_\br_\be_\be_\bn_\bs_\ba_\bv_\be_\br  has  been  compiled  with
               support  for this extension.  However, this exten-
               sion is flaky, so it's use is  not  really  recom-
               mended.   (It  also makes the _\bf_\ba_\bd_\be option not work
               properly.)

       -\b-n\bno\bo-\b-m\bmi\bit\bt-\b-e\bex\bxt\bte\ben\bns\bsi\bio\bon\bn
               Don't use the M\bMI\bIT\bT-\b-S\bSC\bCR\bRE\bEE\bEN\bN-\b-S\bSA\bAV\bVE\bER\bR server extension.

X\bX R\bRE\bES\bSO\bOU\bUR\bRC\bCE\bES\bS
       _\bx_\bs_\bc_\br_\be_\be_\bn_\bs_\ba_\bv_\be_\br understands the following resources:


       t\bti\bim\bme\beo\bou\but\bt (class T\bTi\bim\bme\be)
               Same as the _\b-_\bt_\bi_\bm_\be_\bo_\bu_\bt command-line option.  Default
               10 minutes.

       c\bcy\byc\bcl\ble\be (class T\bTi\bim\bme\be)
               Same  as  the _\b-_\bc_\by_\bc_\bl_\be command-line option.  Default
               10 minutes.

       n\bni\bic\bce\be (class N\bNi\bic\bce\be)
               Same as the _\b-_\bn_\bi_\bc_\be  command-line  option.   Default
               10.

       l\blo\boc\bck\bk (class B\bBo\boo\bol\ble\bea\ban\bn)
               Same as the _\b-_\bl_\bo_\bc_\bk command-line option.

       l\blo\boc\bck\bkT\bTi\bim\bme\beo\bou\but\bt (class T\bTi\bim\bme\be)
               Same as the _\b-_\bl_\bo_\bc_\bk_\b-_\bt_\bi_\bm_\be_\bo_\bu_\bt command-line option.

       p\bpa\bas\bss\bsw\bwd\bdT\bTi\bim\bme\beo\bou\but\bt (class T\bTi\bim\bme\be)
               If  the  screen  is  locked, then this is how many
               seconds the password dialog box should be left  on
               the  screen  before  giving up (default 30.)  This
               should not be too large: the X server  is  grabbed
               for  the  duration that the password dialog box is
               up (for security purposes) and leaving the  server
               grabbed for too long can cause problems.

       v\bve\ber\brb\bbo\bos\bse\be (class B\bBo\boo\bol\ble\bea\ban\bn)
               Same as the _\b-_\bv_\be_\br_\bb_\bo_\bs_\be command-line option.





X Version 11                31-May-97                           4





XScreenSaver(1)                                   XScreenSaver(1)


       x\bxi\bid\bdl\ble\be (class B\bBo\boo\bol\ble\bea\ban\bn)
               Same as the _\b-_\bx_\bi_\bd_\bl_\be command-line option.

       f\bfa\bad\bde\be (class B\bBo\boo\bol\ble\bea\ban\bn)
               If  this  is true, then when the screensaver acti-
               vates, the current contents  of  the  screen  will
               fade to black instead of simply winking out.  This
               only works on displays  with  writable  colormaps,
               that is, if the screen's default visual is a Pseu-
               doColor visual.  Default true.  A fade  will  also
               be  done  when  switching graphics hacks (when the
               _\bc_\by_\bc_\bl_\be timer expires.)

       u\bun\bnf\bfa\bad\bde\be (class B\bBo\boo\bol\ble\bea\ban\bn)
               If this is true, then when the screensaver deacti-
               vates,  the  original  contents of the screen will
               fade in from black instead  of  appearing  immedi-
               ately.   This only works on displays with writable
               colormaps, and if _\bf_\ba_\bd_\be is true as  well.   Default
               false.

       f\bfa\bad\bde\beS\bSe\bec\bco\bon\bnd\bds\bs (class T\bTi\bim\bme\be)
               If _\bf_\ba_\bd_\be is true, this is how long the fade will be
               in seconds (default 3.)

       f\bfa\bad\bde\beT\bTi\bic\bck\bks\bs (class I\bIn\bnt\bte\beg\bge\ber\br)
               If _\bf_\ba_\bd_\be is true, this is how many times  a  second
               the  colormap  will  be  changed to effect a fade.
               Higher numbers yield smoother fades, but may  make
               the  fades take longer than the specified _\bf_\ba_\bd_\be_\bS_\be_\bc_\b-
               _\bo_\bn_\bd_\bs if your server isn't fast enough to keep  up.
               Default 20.

       v\bvi\bis\bsu\bua\bal\blI\bID\bD (class V\bVi\bis\bsu\bua\bal\blI\bID\bD)
               Same  as the _\b-_\bv_\bi_\bs_\bu_\ba_\bl command-line option.  Default
               d\bde\bef\bfa\bau\bul\blt\bt.

       i\bin\bns\bst\bta\bal\bll\blC\bCo\bol\blo\bor\brm\bma\bap\bp (class B\bBo\boo\bol\ble\bea\ban\bn)
               Same as the _\b-_\bi_\bn_\bs_\bt_\ba_\bl_\bl command-line option.  Default
               true.

       c\bca\bap\bpt\btu\bur\bre\beS\bSt\btd\bde\ber\brr\br (class B\bBo\boo\bol\ble\bea\ban\bn)
               Whether _\bx_\bs_\bc_\br_\be_\be_\bn_\bs_\ba_\bv_\be_\br should redirect its standard-
               error stream to  the  window  itself.   Since  its
               nature  is  to take over the screen, you would not
               normally  see  error  messages  generated  by  the
               screensaver or the programs it runs; this resource
               will cause the output of all relevant programs  to
               be  drawn on the screensaver window itself instead
               of written to  the  controlling  terminal  of  the
               screensaver driver process.  Default true.

       c\bca\bap\bpt\btu\bur\bre\beS\bSt\btd\bdo\bou\but\bt (class B\bBo\boo\bol\ble\bea\ban\bn)
               Like  c\bca\bap\bpt\btu\bur\bre\beS\bSt\btd\bde\ber\brr\br  but  for  the standard-output



X Version 11                31-May-97                           5





XScreenSaver(1)                                   XScreenSaver(1)


               stream.  Default true.

       f\bfo\bon\bnt\bt (class F\bFo\bon\bnt\bt)
               The font used for the stdout/stderr text, if  c\bca\bap\bp-\b-
               t\btu\bur\bre\beS\bSt\btd\bdo\bou\but\bt  or  c\bca\bap\bpt\btu\bur\bre\beS\bSt\btd\bde\ber\brr\br  are  true.  Default
               *\b*-\b-m\bme\bed\bdi\biu\bum\bm-\b-r\br-\b-*\b*-\b-1\b14\b40\b0-\b-*\b*-\b-m\bm-\b-*\b*  (a  14  point  fixed-width
               font.)

       t\bte\bex\bxt\btF\bFo\bor\bre\beg\bgr\bro\bou\bun\bnd\bd (class F\bFo\bor\bre\beg\bgr\bro\bou\bun\bnd\bd)
               The  foreground  color  used for the stdout/stderr
               text, if c\bca\bap\bpt\btu\bur\bre\beS\bSt\btd\bdo\bou\but\bt or c\bca\bap\bpt\btu\bur\bre\beS\bSt\btd\bde\ber\brr\br are  true.
               Default: Yellow.

       t\bte\bex\bxt\btB\bBa\bac\bck\bkg\bgr\bro\bou\bun\bnd\bd (class B\bBa\bac\bck\bkg\bgr\bro\bou\bun\bnd\bd)
               The  background  color  used for the stdout/stderr
               text, if c\bca\bap\bpt\btu\bur\bre\beS\bSt\btd\bdo\bou\but\bt or c\bca\bap\bpt\btu\bur\bre\beS\bSt\btd\bde\ber\brr\br are  true.
               Default: Black.

       p\bpr\bro\bog\bgr\bra\bam\bms\bs (class P\bPr\bro\bog\bgr\bra\bam\bms\bs)
               The  graphics  hacks  which _\bx_\bs_\bc_\br_\be_\be_\bn_\bs_\ba_\bv_\be_\br runs when
               the user is idle.  The value of this resource is a
               string, one _\bs_\bh-syntax command per line.  Each line
               must contain exactly one command -- no semicolons,
               no ampersands.

               When  the  screensaver  starts up, one of these is
               selected at random,  and  run.   After  the  _\bc_\by_\bc_\bl_\be
               period  expires,  it  is  killed,  and  another is
               selected and run.

               If the value of this resource is  empty,  then  no
               programs  will  be  run; the screen will simply be
               made black.

               If the display has multiple screens, then  a  dif-
               ferent program will be run for each screen.

               Note that you must escape the newlines; here is an
               example of how you might set this  in  your  _\b._\bX_\bd_\be_\b-
               _\bf_\ba_\bu_\bl_\bt_\bs file:

               xscreensaver.programs:  \
                       qix -root                          \n\
                       ico -r -faces -sleep 1 -obj ico    \n\
                       xdaliclock -builtin2 -root         \n\
                       xv -root -rmode 5 image.gif -quit  \n

               To  use a program as a screensaver, two things are
               required: that that program draw on the root  win-
               dow  (or  be  able to be configured to draw on the
               root window); and  that  that  program  understand
               ``virtual  root'' windows, as used by virtual win-
               dow managers such as _\bt_\bv_\bt_\bw_\bm.  (Generally,  this  is
               accomplished   by  just  including  the  _\b"_\bv_\br_\bo_\bo_\bt_\b._\bh_\b"



X Version 11                31-May-97                           6





XScreenSaver(1)                                   XScreenSaver(1)


               header file in the program's source.)

               If there are some programs that you  want  to  run
               only  when  using a color display, and others that
               you want to run only when using a monochrome  dis-
               play, you can specify that like this:

                       mono:   mono-program  -root        \n\
                       color:  color-program -root        \n\

               More generally, you can specify the kind of visual
               that should be used for the window  on  which  the
               program will be drawing.  For example, if one pro-
               gram works best if it has a colormap, but  another
               works  best if it has a 24-bit visual, both can be
               accomidated:

                       PseudoColor: cmap-program  -root   \n\
                       TrueColor:   24bit-program -root   \n\

               (This sort of thing used to be  accomplished  with
               the  _\bc_\bo_\bl_\bo_\br_\bP_\br_\bo_\bg_\br_\ba_\bm_\bs and _\bm_\bo_\bn_\bo_\bP_\br_\bo_\bg_\br_\ba_\bm_\bs resources, but
               those resources have now been removed;  a  warning
               will be issued if they are used.)

               If  you specify a particular visual for a program,
               and that visual does not exist on the screen, then
               that  program  will  not  be  chosen to run.  This
               means that on displays with  multiple  screens  of
               different  depths, you can arrange for appropriate
               hacks to be run on  each.   For  example,  if  one
               screen is color and the other is monochrome, hacks
               that look good in mono can  be  run  on  one,  and
               hacks that only look good in color will show up on
               the other.


       Normally you won't need to change the following resources:

       b\bbo\bou\bur\brn\bne\beS\bSh\bhe\bel\bll\bl (class B\bBo\bou\bur\brn\bne\beS\bSh\bhe\bel\bll\bl)
               The  pathname  of the shell that _\bx_\bs_\bc_\br_\be_\be_\bn_\bs_\ba_\bv_\be_\br uses
               to start subprocesses.  This must be whatever your
               local  variant  of /\b/b\bbi\bin\bn/\b/s\bsh\bh is -- in particular, it
               must not be c\bcs\bsh\bh.

       w\bwi\bin\bnd\bdo\bow\bwC\bCr\bre\bea\bat\bti\bio\bon\bnT\bTi\bim\bme\beo\bou\but\bt (class T\bTi\bim\bme\be)
               When server extensions are not in use,  this  con-
               trols  the  delay between when windows are created
               and when  _\bx_\bs_\bc_\br_\be_\be_\bn_\bs_\ba_\bv_\be_\br  selects  events  on  them.
               Default 30 seconds.

       p\bpo\boi\bin\bnt\bte\ber\brP\bPo\bol\bll\blT\bTi\bim\bme\be (class T\bTi\bim\bme\be)
               When  server  extensions are not in use, this con-
               trols how frequently _\bx_\bs_\bc_\br_\be_\be_\bn_\bs_\ba_\bv_\be_\br checks to see if



X Version 11                31-May-97                           7





XScreenSaver(1)                                   XScreenSaver(1)


               the   mouse  position  or  buttons  have  changed.
               Default 5 seconds.

       i\bin\bni\bit\bti\bia\bal\blD\bDe\bel\bla\bay\by (class T\bTi\bim\bme\be)
               When server extensions are not  in  use,  _\bx_\bs_\bc_\br_\be_\be_\bn_\b-
               _\bs_\ba_\bv_\be_\br will wait this many seconds before selecting
               events on existing windows, under  the  assumption
               that  _\bx_\bs_\bc_\br_\be_\be_\bn_\bs_\ba_\bv_\be_\br  is  started  during your login
               procedure, and the window state may  be  in  flux.
               Default 30 seconds.

       o\bov\bve\ber\brl\bla\bay\byS\bSt\btd\bde\ber\brr\br (class B\bBo\boo\bol\ble\bea\ban\bn)
               If  c\bca\bap\bpt\btu\bur\bre\beS\bSt\btd\bde\ber\brr\br  or  c\bca\bap\bpt\btu\bur\bre\beS\bSt\btd\bdo\bou\but\bt are True, and
               your server supports ``overlay'' visuals, then the
               text will be written into one of the higher layers
               instead of into the  same  layer  as  the  running
               screenhack.   Set  this  to  False to disable that
               (though you shouldn't need to.)

H\bHO\bOW\bW I\bIT\bT W\bWO\bOR\bRK\bKS\bS
       When it is time to activate the screensaver, a full-screen
       black  window  is  created  on each screen of the display.
       The window or windows is given the appropriate  properties
       so  that,  to  any  subsequently-created programs, it will
       appear to be a ``virtual root'' window.  Because of  this,
       any  program  which  draws  on  the root window (and which
       understands virtual roots) can be used as a screensaver.

       When the user becomes active again, the  screensaver  win-
       dows  are unmapped and the running subprocesses are killed
       by sending them S\bSI\bIG\bGT\bTE\bER\bRM\bM.  This is  also  how  the  subpro-
       cesses  are  killed when the screensaver decides that it's
       time to run a different demo: the old one is killed and  a
       new one is launched.

       Before  launching  a  subprocess,  _\bx_\bs_\bc_\br_\be_\be_\bn_\bs_\ba_\bv_\be_\br  stores an
       appropriate value for $\b$D\bDI\bIS\bSP\bPL\bLA\bAY\bY in the environment that the
       child  will  recieve.   (This  is  so  that  if  you start
       _\bx_\bs_\bc_\br_\be_\be_\bn_\bs_\ba_\bv_\be_\br with a _\b-_\bd_\bi_\bs_\bp_\bl_\ba_\by argument, the programs  which
       _\bx_\bs_\bc_\br_\be_\be_\bn_\bs_\ba_\bv_\be_\br  launches  will draw on the same display; and
       so that the child will end up drawing on  the  appropriate
       screen of a multi-headed display.)

       When  the  screensaver  turns  off,  or is killed, care is
       taken to restore the ``real'' virtual root window if there
       is  one.   Because  of  this, it is important that you not
       kill the screensaver process with _\bk_\bi_\bl_\bl _\b-_\b9 if you are  run-
       ning  a  virtual-root window manager.  If you kill it with
       -9, you may need to restart your window manager to  repair
       the  damage.   This isn't an issue if you aren't running a
       virtual-root window manager.

       For all the gory details, see the commentary at the top of
       xscreensaver.c.



X Version 11                31-May-97                           8





XScreenSaver(1)                                   XScreenSaver(1)


       You can control a running screensaver process by using the
       x\bxs\bsc\bcr\bre\bee\ben\bns\bsa\bav\bve\ber\br-\b-c\bco\bom\bmm\bma\ban\bnd\bd(1) program (which see.)

U\bUS\bSI\bIN\bNG\bG X\bXD\bDM\bM(\b(1\b1)\b)
       You can run _\bx_\bs_\bc_\br_\be_\be_\bn_\bs_\ba_\bv_\be_\br from your xdm  session,  so  that
       the  screensaver will run even when nobody is logged in on
       the  console.   Simply  add  "\b"x\bxs\bsc\bcr\bre\bee\ben\bns\bsa\bav\bve\ber\br  &\b&"\b"   to   your
       _\b/_\bu_\bs_\br_\b/_\bl_\bi_\bb_\b/_\bX_\b1_\b1_\b/_\bx_\bd_\bm_\b/_\bX_\bs_\be_\bt_\bu_\bp  file.  Because _\bx_\bd_\bm grabs the key-
       board, keypresses will not make  the  screensaver  deacti-
       vate, but any mouse activity will.

       (If  your  system does not seem to be executing the _\bX_\bs_\be_\bt_\bu_\bp
       file, you may need to configure it to do so -- the  tradi-
       tional  way  to  do this is to make that file the value of
       the _\bD_\bi_\bs_\bp_\bl_\ba_\by_\bM_\ba_\bn_\ba_\bg_\be_\br_\b*_\bs_\be_\bt_\bu_\bp resource in the _\bx_\bd_\bm_\b-_\bc_\bo_\bn_\bf_\bi_\bg  file.
       See the man page for x\bxd\bdm\bm(1) for more details.)

       Users  may  want to add "\b"x\bxs\bsc\bcr\bre\bee\ben\bns\bsa\bav\bve\ber\br-\b-c\bco\bom\bmm\bma\ban\bnd\bd -\b-r\bre\bes\bst\bta\bar\brt\bt"\b" to
       their startup scripts, so that  the  screensaver  will  be
       reinitialized  with  their  private resource settings when
       they log in.

       It is safe to run this program as root (as _\bx_\bd_\bm  is  likely
       to  do.)   If run as root, _\bx_\bs_\bc_\br_\be_\be_\bn_\bs_\ba_\bv_\be_\br changes its effec-
       tive user and group ids to something safe (like  _\b"_\bn_\bo_\bb_\bo_\bd_\by_\b")
       before connecting to the X server or launching user-speci-
       fied programs.

       Locking doesn't work if the  screensaver  is  launched  by
       _\bx_\bd_\bm.  To get around this, you can run the screensaver from
       _\bx_\bd_\bm without locking, and kill and  restart  it  from  your
       personal X startup script to enable locking; for example:

               xscreensaver-command -exit ; xscreensaver


D\bDE\bEM\bMO\bO M\bMO\bOD\bDE\bE
       If  _\bx_\bs_\bc_\br_\be_\be_\bn_\bs_\ba_\bv_\be_\br receives the D\bDE\bEM\bMO\bO ClientMessage, which is
       done by running the x\bxs\bsc\bcr\bre\bee\ben\bns\bsa\bav\bve\ber\br-\b-c\bco\bom\bmm\bma\ban\bnd\bd program with  the
       -\b-d\bde\bem\bmo\bo  option,  the  screensaver will black the screen and
       pop up a dialog box from which you can examine and experi-
       ment with the client programs.

       The  dialog  box  contains a scrolling list, a text field,
       and a number of buttons.

       Double-clicking on one of the programs in  the  list  will
       run  it.   Clicking  the mouse again will bring the dialog
       box back.

       Single-clicking in the list will place the indicated  pro-
       gram  and  its  args in the text field to be edited.  Edit
       the arguments and hit return to run the program  with  the
       parameters  you have specified.  (Note that these are one-



X Version 11                31-May-97                           9





XScreenSaver(1)                                   XScreenSaver(1)


       time changes and won't be remembered; to make the  changes
       permanent, you need to edit your X resource file.)

       The buttons are:

       R\bRu\bun\bn N\bNe\bex\bxt\bt
               Clicking  this button will run the next program in
               the list after  the  currently-selected  one,  and
               will  scroll around to the top when it reaches the
               bottom.

       R\bRu\bun\bn P\bPr\bre\bev\bvi\bio\bou\bus\bs
               Opposite of Run  Next;  at  the  top,  it  scrolls
               around to the bottom.

       E\bEd\bdi\bit\bt P\bPa\bar\bra\bam\bme\bet\bte\ber\brs\bs
               This  pops  up  a  second dialog box, in which you
               have the option to interactively  change  most  of
               the  screensaver's operational parameters, such as
               its timeouts,  and  whether  it  should  lock  the
               screen.    Changing  these  parameters  here  will
               affect only the running _\bx_\bs_\bc_\br_\be_\be_\bn_\bs_\ba_\bv_\be_\br  process;  to
               make  the changes permanent, you need to edit your
               X resource file.

       E\bEx\bxi\bit\bt D\bDe\bem\bmo\bo M\bMo\bod\bde\be
               Returns to normal screensaver operation.

       R\bRe\bei\bin\bni\bit\bti\bia\bal\bli\biz\bze\be
               This causes the X resource database to be re-read,
               to  pick up any changes you might have made.  This
               works by causing the screensaver process  to  exit
               and then restart itself with the same command-line
               arguments.  This is just like the  _\b-_\br_\be_\bs_\bt_\ba_\br_\bt  argu-
               ment  to  x\bxs\bsc\bcr\bre\bee\ben\bns\bsa\bav\bve\ber\br-\b-c\bco\bom\bmm\bma\ban\bnd\bd(1) except that when
               executed from this button,  the  screensaver  will
               automatically  return  to demo mode after restart-
               ing.

B\bBU\bUG\bGS\bS
       (This is not a bug, but) note that as of release 1.32, the
       c\bco\bol\blo\bor\brP\bPr\bro\bog\bgr\bra\bam\bms\bs  and  m\bmo\bon\bno\boP\bPr\bro\bog\bgr\bra\bam\bms\bs  resources  are no longer
       used: they have been supplanted by the extended syntax  of
       the p\bpr\bro\bog\bgr\bra\bam\bms\bs resource (see above.)

       Extensions
               If  you  are  not  making use of one of the server
               extensions (X\bXI\bID\bDL\bLE\bE,  S\bSC\bCR\bRE\bEE\bEN\bN_\b_S\bSA\bAV\bVE\bER\bR,  or  M\bMI\bIT\bT-\b-S\bSC\bCR\bRE\bEE\bEN\bN-\b-
               S\bSA\bAV\bVE\bER\bR),  then  it is possible, in rare situations,
               for _\bx_\bs_\bc_\br_\be_\be_\bn_\bs_\ba_\bv_\be_\br to interfere with event  propaga-
               tion  and make another X program malfunction.  For
               this to occur, that other application  would  need
               to _\bn_\bo_\bt select K\bKe\bey\byP\bPr\bre\bes\bss\bs events on its non-leaf win-
               dows  within  the  first  30  seconds   of   their



X Version 11                31-May-97                          10





XScreenSaver(1)                                   XScreenSaver(1)


               existence,  but  then  select  for them later.  In
               this case, that client _\bm_\bi_\bg_\bh_\bt fail to receive those
               events.   This  isn't  very likely, since programs
               generally select a constant set of events  immedi-
               ately  after creating their windows and then don't
               change them, but this is the reason  that  it's  a
               good  idea  to  install  and use one of the server
               extensions instead, to work around this  shortcom-
               ing in the X protocol.

       Machine Load
               Although  this  program ``nices'' the subprocesses
               that it starts, graphics-intensive subprograms can
               still overload the machine by causing the X server
               process itself (which is not ``niced'') to suck  a
               lot  of cycles.  Care should be taken to slow down
               programs  intended  for  use  as  screensavers  by
               inserting strategic calls to s\bsl\ble\bee\bep\bp(3) or u\bus\bsl\ble\bee\bep\bp(3)
               (or making liberal use of any _\b-_\bd_\be_\bl_\ba_\by options which
               the programs may provide.)

               Also,  an  active  screensaver  will  cause your X
               server to be pretty much permanently  swapped  in;
               but  the  same  is  true of any program that draws
               periodically, like x\bxc\bcl\blo\boc\bck\bk(1) or x\bxl\blo\boa\bad\bd(1).

       Latency and Responsiveness
               If the subprocess is drawing too quickly  and  the
               connection  to the X server is a slow one (such as
               an X terminal running over a phone line) then  the
               screensaver might not turn off right away when the
               user becomes active again  (the  i\bic\bco\bo(1)  demo  has
               this  problem  if  being  run in full-speed mode).
               This can  be  alleviated  by  inserting  strategic
               calls  to  X\bXS\bSy\byn\bnc\bc(3)  in code intended for use as a
               screensaver.   This  prevents  too  much  graphics
               activity from being buffered up.

       Locking and XDM
               Locking   doesn't   work  if  the  screensaver  is
               launched by _\bx_\bd_\bm.  The reason for this is that when
               it  is launched by _\bx_\bd_\bm, the screensaver process is
               owned by some standard user id (such  as  _\br_\bo_\bo_\bt  or
               _\bd_\ba_\be_\bm_\bo_\bn)  instead  of  the user who is logged in on
               the console: because the screensaver  was  started
               _\bb_\be_\bf_\bo_\br_\be  anyone  was  logged  in.  In order for the
               screensaver to prompt for the password of the per-
               son  who  had logged in from _\bx_\bd_\bm, it would need to
               know who that user was, and there is  no  reliable
               and  safe  way  to  figure that out.  (And even if
               there was, there  would  be  some  other  security
               issues here as well.)

               So  if  you  want  to use it as a locker, you must



X Version 11                31-May-97                          11





XScreenSaver(1)                                   XScreenSaver(1)


               start it with your user id.   If  it  has  already
               been started by _\bx_\bd_\bm, you can kill it with x\bxs\bsc\bcr\bre\bee\ben\bn-\b-
               s\bsa\bav\bve\ber\br-\b-c\bco\bom\bmm\bma\ban\bnd\bd -\b-e\bex\bxi\bit\bt, and then start  it  again  as
               you.

       Passwords
               If  you  get  an error message like ``couldn't get
               password of _\bu_\bs_\be_\br'' then this probably  means  that
               you're  on  a  system  in  which  the  g\bge\bet\btp\bpw\bwe\ben\bnt\bt(3)
               library routine can only be  effectively  used  by
               root.  If this is the case, then _\bx_\bs_\bc_\br_\be_\be_\bn_\bs_\ba_\bv_\be_\br must
               be installed as setuid to  root.   Care  has  been
               taken to make this a safe thing to do.

               It  also  may  mean  that  your system uses shadow
               passwords instead of the standard _\bg_\be_\bt_\bp_\bw_\be_\bn_\bt  inter-
               face;  in  that  case, you may need to change some
               options in _\bc_\bo_\bn_\bf_\bi_\bg_\b._\bh and recompile.

       TWM and Colormaps
               The i\bin\bns\bst\bta\bal\bll\blC\bCo\bol\blo\bor\brm\bma\bap\bp option doesn't work very  well
               with  the  t\btw\bwm\bm(1)  window  manager and its descen-
               dants.

               There is a race condition between the  screensaver
               and  this  window manager, which can result in the
               screensaver's colormap not getting installed prop-
               erly,  meaning  the  graphics hacks will appear in
               essentially random colors.  (If  the  screen  goes
               white instead of black, this is probably why.)

               The  m\bmw\bwm\bm(1) and o\bol\blw\bwm\bm(1) window managers don't seem
               to have this problem.  The race  condition  exists
               because X apparently does not provide a way for an
               OverrideRedirect window to have its own  colormap,
               short  of  grabbing the server (which is neither a
               good idea, nor really possible  with  the  current
               design.)   What  happens  is  that, as soon as the
               screensaver installs its colormap, t\btw\bwm\bm responds to
               the  C\bCo\bol\blo\bor\brm\bma\bap\bpN\bNo\bot\bti\bif\bfy\by event that is generated by re-
               instaling the default colormap.   Apparently,  t\btw\bwm\bm
               doesn't  _\ba_\bl_\bw_\ba_\by_\bs  do  this; it seems to do it regu-
               larly if the screensaver is activated from a  menu
               item,  but  seems  to not do it if the screensaver
               comes on of its own volition, or is activated from
               another console.  Any thoughts on this problem are
               welcome...

       XView Clients
               Apparently there are some problems with XView pro-
               grams  getting  confused  and  thinking  that  the
               screensaver window is the real  root  window  even
               when the screensaver is not active: ClientMessages
               intended for the window manager are  sent  to  the



X Version 11                31-May-97                          12





XScreenSaver(1)                                   XScreenSaver(1)


               screensaver  window instead.  This could be solved
               by making xscreensaver  forward  all  unrecognised
               ClientMessages  to the real root window, but there
               may be other problems as well.  If anyone has  any
               insight  on  the cause of this problem, please let
               me know.

       MIT Extension and Fading
               When using the M\bMI\bIT\bT-\b-S\bSC\bCR\bRE\bEE\bEN\bN-\b-S\bSA\bAV\bVE\bER\bR extension in  con-
               junction  with  the f\bfa\bad\bde\be option, you may notice an
               unattractive flicker just before the fade  begins.
               This  is  because  the  server maps a black window
               just before it tells the _\bx_\bs_\bc_\br_\be_\be_\bn_\bs_\ba_\bv_\be_\br  process  to
               activate.   The  _\bx_\bs_\bc_\br_\be_\be_\bn_\bs_\ba_\bv_\be_\br  process immediately
               unmaps that window, but this results in a flicker.
               I  haven't  figured  a way  to get around this; it
               seems to be a fundamental property of  the  (mis-)
               design of this server extension.

       LessTif (Motif Clone)
               Rumor  has  it that demo mode is buggy if XScreen-
               Saver was compiled with the GNU  LessTif  reimple-
               mentation  of Motif.  Since it works fine with OSF
               Motif on a variety  of  systems,  I  assume  these
               problems  are  due to bugs in LessTif.  Again, any
               insight would be appreciated.

       Red Hot Lava
               There need to be a lot more  graphics  hacks.   In
               particular,  there  should  be  a  simulation of a
               Lavalite (tm).

E\bEN\bNV\bVI\bIR\bRO\bON\bNM\bME\bEN\bNT\bT
       D\bDI\bIS\bSP\bPL\bLA\bAY\bY to get the default host and display number, and to
               inform  the sub-programs of the screen on which to
               draw.

       X\bXE\bEN\bNV\bVI\bIR\bRO\bON\bNM\bME\bEN\bNT\bT
               to get the name of a resource file that  overrides
               the  global  resources stored in the RESOURCE_MAN-
               AGER property.

U\bUP\bPG\bGR\bRA\bAD\bDE\bES\bS
       The latest version can  always  be  found  at  http://peo-
       ple.netscape.com/jwz/xscreensaver/

S\bSE\bEE\bE A\bAL\bLS\bSO\bO
       X\bX(1),  x\bxs\bsc\bcr\bre\bee\ben\bns\bsa\bav\bve\ber\br-\b-c\bco\bom\bmm\bma\ban\bnd\bd(1),  x\bxl\blo\boc\bck\bk(1), x\bxn\bnl\blo\boc\bck\bk(1), x\bxa\bau\bu-\b-
       t\bto\bol\blo\boc\bck\bk(1), x\bxd\bdm\bm(1), a\bat\btt\btr\bra\bac\bct\bti\bio\bon\bn(1), g\bgr\bre\bey\byn\bne\bet\bti\bic\bc(1),  h\bhe\bel\bli\bix\bx(1),
       h\bho\bop\bpa\bal\blo\bon\bng\bg(1),   n\bno\bos\bse\beg\bgu\buy\by(1),   p\bpy\byr\bro\bo(1),  x\bxr\bro\bog\bge\ber\br(1),  q\bqi\bix\bx(1),
       r\bro\boc\bck\bks\bs(1),    r\bro\bor\brs\bsc\bch\bha\bac\bch\bh(1),     b\bbl\bli\bit\bts\bsp\bpi\bin\bn(1),     i\bim\bms\bsm\bma\bap\bp(1),
       s\bsl\bli\bid\bde\bes\bsc\bcr\bre\bee\ben\bn(1),   d\bde\bec\bca\bay\bys\bsc\bcr\bre\bee\ben\bn(1),  m\bma\baz\bze\be(1),  h\bhy\byp\bpe\ber\brc\bcu\bub\bbe\be(1),
       h\bha\bal\blo\bo(1), f\bfl\bla\bam\bme\be(1), p\bpe\bed\bda\bal\bl(1), l\blm\bmo\bor\brp\bph\bh(1), d\bde\bec\bco\bo(1), m\bmo\boi\bir\bre\be(1),
       k\bka\bal\ble\bei\bid\bde\bes\bsc\bco\bop\bpe\be(1),   b\bbu\bub\bbb\bbl\ble\bes\bs(1),  l\bli\big\bgh\bht\btn\bni\bin\bng\bg(1),  s\bst\btr\bra\ban\bng\bge\be(1),



X Version 11                31-May-97                          13





XScreenSaver(1)                                   XScreenSaver(1)


       f\bfr\bra\bac\bct\bt(1), s\bsp\bpi\bir\bra\bal\bl(1), l\bla\bas\bse\ber\br(1), g\bgr\bra\bav\bv(1), d\bdr\bri\bif\bft\bt(1),  i\bif\bfs\bs(1),
       j\bju\bul\bli\bia\ba(1),    p\bpe\ben\bnr\bro\bos\bse\be(1),    s\bsi\bie\ber\brp\bpi\bin\bns\bsk\bki\bi(1),    h\bho\bop\bpa\bal\blo\bon\bng\bg(1),
       b\bbr\bra\bai\bid\bd(1),  b\bbo\bou\bub\bbo\bou\bul\ble\be(1),  g\bga\bal\bla\bax\bxy\by(1),  f\bfl\bla\bag\bg(1),   f\bfo\bor\bre\bes\bst\bt(1),
       s\bsp\bph\bhe\ber\bre\be(1), l\bli\bis\bsa\ba(1), x\bxd\bda\bal\bli\bic\bcl\blo\boc\bck\bk(1), x\bxb\bbo\bou\bun\bnc\bce\beb\bbi\bit\bts\bs(1), i\bic\bco\bo(1),
       x\bxs\bsw\bwa\bar\brm\bm(1), x\bxw\bwa\bav\bve\be(1),  x\bxv\bv(1),  x\bxt\bta\bac\bcy\by(1),  b\bbo\bon\bng\bgo\bo(1),  x\bxf\bfi\bis\bsh\bh-\b-
       t\bta\ban\bnk\bk(1)

C\bCO\bOP\bPY\bYR\bRI\bIG\bGH\bHT\bT
       Copyright  (C) 1991, 1992, 1993, 1994, 1995, 1996, 1997 by
       Jamie Zawinski.  Permission to  use,  copy,  modify,  dis-
       tribute,  and sell this software and its documentation for
       any purpose is hereby granted without fee,  provided  that
       the  above  copyright notice appear in all copies and that
       both that copyright  notice  and  this  permission  notice
       appear  in  supporting  documentation.  No representations
       are made about the suitability of this  software  for  any
       purpose.   It  is  provided  "as  is"  without  express or
       implied warranty.

A\bAU\bUT\bTH\bHO\bOR\bR
       Jamie Zawinski <jwz@netscape.com>.  Written in late  1991;
       first posted to comp.sources.x on 13-Aug-1992.

       Please  let  me  know  if  you  find  any bugs or make any
       improvements.

       Thanks to David Wojtowicz for implementing _\bl_\bo_\bc_\bk_\bT_\bi_\bm_\be_\bo_\bu_\bt.

       Thanks to Martin Kraemer for  adding  support  for  shadow
       passwords and locking-disabled diagnostics.

       Thanks  to  the  many people who have contributed graphics
       demos to the package.

       Thanks to Patrick Moreau for the VMS port.

       And huge thanks to Jon A. Christopher for implementing the
       Athena  dialog support, so that locking and demo-mode work
       even if you don't have Motif.


















X Version 11                31-May-97                          14