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

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