git.hungrycats.org Git - xscreensaver/blob - driver/xscreensaver-command.hlp

   1 1 XSCREENCOMMAND
   2 Control a running xscreensaver process
   3
   4 SYNOPSIS
   5
   6   $ xscreencommand [-activate] [-deactivate] [-cycle] [-next] [-prev]
   7                    [-exit] [-restart] [-demo] [-lock]
   8
   9 2 DESCRIPTION
  10 The xscreensaver-command program controls a running xscreensaver
  11 process by sending it client-messages.
  12
  13 2 OPTIONS
  14 xscreencommand accepts the following options:
  15
  16    -activate
  17 Tell the screensaver to turn on immediately (that is, pretend that the
  18 user been idle for long enough.)  It will turn off as soon as there is
  19 any user activity, as usual.
  20
  21 It is useful to run this from a menu; you may wish to run it as
  22
  23   $ wait 0:00:05
  24   $ xscreencommand -activate
  25
  26 to be sure that you have time to remove your hand from the mouse before
  27 the screensaver comes on.
  28
  29    -deactivate
  30 Tell the screensaver to turn off, as if there had been user activity.
  31 If locking is enabled, then the screensaver will prompt for a password
  32 as usual.
  33
  34    -cycle
  35 Tell the screensaver to change which graphics hack it is running, just
  36 as if the ``cycle'' timer had expired.
  37
  38    -next
  39 This is like either -activate or -cycle, depending on which is
  40 more appropriate, except that the screenhack that will be run is the next
  41 one in the list of programs, instead of a randomly-chosen one.  This option
  42 is good for looking at a demo of each of the screensavers currently available.
  43 You might want to put this on a menu.
  44
  45    -prev
  46 This is like -next, but cycles in the other direction.
  47
  48    -demo
  49 Cause the screensaver to enter its interactive demo mode, if it has been
  50 compiled with support for it.
  51
  52    -lock
  53 Like -activate, but a password will be required before the screensaver
  54 turns off, even if the screensaver's lock resource is false.  The
  55 display will be locked immediately even if the screensaver's lockTimeout
  56 resource is non-zero.
  57
  58    -exit
  59 Causes the screensaver process to exit gracefully.  This is a slightly
  60 safer way to kill the screensaver than by using kill.
  61
  62 Never use kill -9 with xscreensaver while the screensaver is
  63 active.  If you are using a virtual root window manager, that can leave
  64 things in an inconsistent state, and you may need to restart your window
  65 manager to repair the damage.
  66
  67    -restart
  68 Causes the screensaver process to exit and then restart with the same command
  69 line arguments.  This is a good way of causing the screensaver to re-read the
  70 resource database.
  71
  72 If the screensaver is run from xdm(1) (that is, it is already running
  73 before you log in) then you may want to issue the ``restart'' command from
  74 one of your startup scripts, so that the screensaver gets your resource
  75 settings instead of the default ones.
  76
  77 2 ENVIRONMENT
  78
  79    DISPLAY
  80 to get the default host and display number.
  81
  82    PATH
  83 to find the executable to restart.
  84
  85 2 BUGS
  86 Diagnostics are reported on the stderr of the xscreensaver
  87 process, not this process, so the caller of xscreencommand
  88 may not see the error messages.
  89
  90 2 COPYRIGHT
  91 Copyright (co 1992, 1993 by Jamie Zawinski.  Permission to use, copy, modify,
  92 distribute, and sell this software and its documentation for any purpose is
  93 hereby granted without fee, provided that the above copyright notice appear
  94 in all copies and that both that copyright notice and this permission notice
  95 appear in supporting documentation.  No representations are made about the
  96 suitability of this software for any purpose.  It is provided "as is" without
  97 express or implied warranty.
  98
  99 2 AUTHOR
 100 Jamie Zawinski <jwz@mcom.com>, 13-aug-92.
 101
 102 2 VMS_PORT
 103
 104 Patrick MOREAU - CENA/Athis-Mons - FRANCE (pmoreau@cena.dgac.fr)
 105