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 "02-Oct-98 (2.31)" "X Version 11"
  15 .SH NAME
  16 xscreensaver-command - control a running xscreensaver process
  17 .SH SYNOPSIS
  18 .B xscreensaver-command
  19 [\-help] \
  20 [\-demo] \
  21 [\-prefs] \
  22 [\-activate] \
  23 [\-deactivate] \
  24 [\-cycle] \
  25 [\-next] \
  26 [\-prev] \
  27 [\-exit] \
  28 [\-restart] \
  29 [\-lock] \
  30 [\-version] \
  31 [\-time]
  32 .SH DESCRIPTION
  33 The \fIxscreensaver\-command\fP program controls a running \fIxscreensaver\fP
  34 process by sending it client-messages.
  35
  36 .BR xscreensaver (1)
  37 has a client-server model: the xscreensaver process is a
  38 daemon that runs in the background; it is controlled by the
  39 foreground \fIxscreensaver-command\fP program.
  40 .SH OPTIONS
  41 .I xscreensaver-command
  42 accepts the following command-line options:
  43 .TP 8
  44 .B \-help
  45 Prints a brief summary of command-line options.
  46 .TP 8
  47 .B \-demo
  48 Cause the screensaver to enter its interactive demo mode, in which one
  49 can experiment with the various graphics hacks available.  See
  50 .BR xscreensaver (1)
  51 for details.
  52 .TP 8
  53 .B \-prefs
  54 Cause the screensaver to enter its interactive demo mode, and bring up
  55 the Preferences control panel, in which one can change most of the settings
  56 that control the xscreensaver daemon's behavior.  See
  57 .BR xscreensaver (1)
  58 for details.
  59 .TP 8
  60 .B \-activate
  61 Tell xscreensaver to turn on immediately (that is, blank the screen, as if
  62 the user had been idle for long enough.)  The screensaver will deactivate as
  63 soon as there is any user activity, as usual.
  64
  65 It is useful to run this from a menu; you may wish to run it as
  66 .EX
  67 sleep 5 ; xscreensaver-command -activate
  68 .EE
  69 to be sure that you have time to remove your hand from the mouse before
  70 the screensaver comes on.  (Because if you jiggle the mouse, xscreensaver
  71 will notice, and deactivate.)
  72 .TP 8
  73 .B \-deactivate
  74 If the screensaver is active (the screen is blanked), this command will
  75 deactivate it just as if there had been keyboard or mouse activity.
  76 If locking is enabled, then the screensaver will prompt for a password
  77 as usual.
  78 .TP 8
  79 .B \-cycle
  80 If the screensaver is active (the screen is blanked), then stop the current
  81 graphics demo and run a new one (chosen randomly.)
  82 .TP 8
  83 .B \-next
  84 This is like either \fI\-activate\fP or \fI\-cycle\fP, depending on which is
  85 more appropriate, except that the graphics hack that will be run is the next
  86 one in the list, instead of a randomly-chosen one.  In other words,
  87 repeatedly executing -next will cause the xscreensaver process to invoke each
  88 graphics demo sequentially.  (Though using the \fI\-demo\fP option is probably
  89 an easier way to accomplish that.)
  90 .TP 8
  91 .B \-prev
  92 This is like \fI\-next\fP, but cycles in the other direction.
  93 .TP 8
  94 .B \-exit
  95 Causes the xscreensaver process to exit gracefully.  This is roughly the same
  96 as killing the process with
  97 .BR kill (1),
  98 but it is easier, since you don't need to first figure out the pid.
  99
 100 .B Warning:
 101 never use \fIkill -9\fP with \fIxscreensaver\fP while the screensaver is
 102 active.  If you are using a virtual root window manager, that can leave
 103 things in an inconsistent state, and you may need to restart your window
 104 manager to repair the damage.
 105 .TP 8
 106 .B \-restart
 107 Causes the screensaver process to exit and then restart with the same command
 108 line arguments as last time.  Do this after you've changed the resource
 109 database, to cause xscreensaver to notice the changes.
 110
 111 If the screensaver is run from \fIxdm(1)\fP (that is, it is already running
 112 before you log in) then you may want to issue the \fI\-restart\fP command from
 113 one of your startup scripts, so that the screensaver gets your resource
 114 settings instead of the default ones.
 115 .TP 8
 116 .B \-lock
 117 Tells the running xscreensaver process to lock the screen immediately.
 118 This is like \fI\-activate\fP, but forces locking as well, even if locking
 119 is not the default (that is, even if xscreensaver's \fIlock\fP resource is
 120 false, and even if the \fIlockTimeout\fP resource is non-zero.)
 121 .TP 8
 122 .B \-version
 123 Prints the version of xscreensaver that is currently running on the display:
 124 that is, the actual version number of the running xscreensaver background
 125 process, rather than the version number of xscreensaver-command.  (To see
 126 the version number of \fIxscreensaver-command\fP itself, use
 127 the \fI\-help\fP option.)
 128 .TP 8
 129 .B \-time
 130 Prints the time at which the screensaver last activated or
 131 deactivated (roughly, how long the user has been idle or non-idle: but
 132 not quite, since it only tells you when the screen became blanked or
 133 un-blanked.)
 134 .SH ENVIRONMENT
 135 .PP
 136 .TP 8
 137 .B DISPLAY
 138 to get the host and display number of the screen whose saver is
 139 to be manipulated.
 140 .TP 8
 141 .B PATH
 142 to find the executable to restart (for the \fI\-restart\fP command).
 143 Note that this variable is consulted in the environment of
 144 the \fIxscreensaver\fP process, not the \fIxscreensaver-command\fP process.
 145 .SH UPGRADES
 146 The latest version of
 147 .BR xscreensaver (1)
 148 and \fIxscreensaver\-command\fP can always be found at
 149 http://www.jwz.org/xscreensaver/
 150 .SH "SEE ALSO"
 151 .BR X (1),
 152 .BR xscreensaver (1)
 153 .SH BUGS
 154 Some diagnostics are reported on the stderr of the \fIxscreensaver\fP
 155 process, not this process, so the caller of \fIxscreensaver-command\fP
 156 may not see the error messages.
 157 .SH COPYRIGHT
 158 Copyright \(co 1992, 1993, 1997, 1998
 159 by Jamie Zawinski.  Permission to use, copy, modify, distribute, and sell
 160 this software and its documentation for any purpose is hereby granted without
 161 fee, provided that the above copyright notice appear in all copies and that
 162 both that copyright notice and this permission notice appear in supporting
 163 documentation.  No representations are made about the suitability of this
 164 software for any purpose.  It is provided "as is" without express or implied
 165 warranty.
 166 .SH AUTHOR
 167 Jamie Zawinski <jwz@jwz.org>, 13-aug-92.
 168
 169 Please let me know if you find any bugs or make any improvements.