4 XScreenSaver(1) XScreenSaver(1)
8 xscreensaver-command - control a running xscreensaver pro-
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-c
\bco
\bom
\bmm
\bma
\ban
\bnd
\bd [-help] [-demo] [-activate] [-deacti-
13 vate] [-lock] [-cycle] [-next] [-prev] [-exit] [-restart]
16 D
\bDE
\bES
\bSC
\bCR
\bRI
\bIP
\bPT
\bTI
\bIO
\bON
\bN
17 The _
\bx_
\bs_
\bc_
\br_
\be_
\be_
\bn_
\bs_
\ba_
\bv_
\be_
\br_
\b-_
\bc_
\bo_
\bm_
\bm_
\ba_
\bn_
\bd program controls a running
18 _
\bx_
\bs_
\bc_
\br_
\be_
\be_
\bn_
\bs_
\ba_
\bv_
\be_
\br process by sending it client-messages.
20 O
\bOP
\bPT
\bTI
\bIO
\bON
\bNS
\bS
21 _
\bx_
\bs_
\bc_
\br_
\be_
\be_
\bn_
\bs_
\ba_
\bv_
\be_
\br_
\b-_
\bc_
\bo_
\bm_
\bm_
\ba_
\bn_
\bd accepts the following options:
23 -
\b-h
\bhe
\bel
\blp
\bp Prints a brief summary of command-line options.
25 -
\b-d
\bde
\bem
\bmo
\bo Cause the screensaver to enter its interactive
26 demo mode, in which one can experiment with the
27 various graphics hacks available. See x
\bxs
\bsc
\bcr
\bre
\bee
\ben
\bn-
\b-
28 s
\bsa
\bav
\bve
\ber
\br(1) for details.
30 -
\b-a
\bac
\bct
\bti
\biv
\bva
\bat
\bte
\be
31 Tell the screensaver to turn on immediately (that
32 is, pretend that the user been idle for long
33 enough.) It will turn off as soon as there is any
34 user activity, as usual.
36 It is useful to run this from a menu; you may wish
39 sleep 5 ; xscreensaver-command -activate
41 to be sure that you have time to remove your hand
42 from the mouse before the screensaver comes on.
44 -
\b-d
\bde
\bea
\bac
\bct
\bti
\biv
\bva
\bat
\bte
\be
45 Tell the screensaver to turn off, as if there had
46 been user activity. If locking is enabled, then
47 the screensaver will prompt for a password as
50 -
\b-l
\blo
\boc
\bck
\bk Like _
\b-_
\ba_
\bc_
\bt_
\bi_
\bv_
\ba_
\bt_
\be, but a password will be required
51 before the screensaver turns off, even if the
52 screensaver's _
\bl_
\bo_
\bc_
\bk resource is false. The display
53 will be locked immediately even if the screen-
54 saver's _
\bl_
\bo_
\bc_
\bk_
\bT_
\bi_
\bm_
\be_
\bo_
\bu_
\bt resource is non-zero.
56 -
\b-c
\bcy
\byc
\bcl
\ble
\be Tell the screensaver to change which graphics hack
57 it is running, just as if the ``cycle'' timer had
58 expired. A new hack will be chosen randomly.
60 -
\b-n
\bne
\bex
\bxt
\bt This is like either _
\b-_
\ba_
\bc_
\bt_
\bi_
\bv_
\ba_
\bt_
\be or _
\b-_
\bc_
\by_
\bc_
\bl_
\be, depending
64 X Version 11 31-May-97 1
70 XScreenSaver(1) XScreenSaver(1)
73 on which is more appropriate, except that the
74 screenhack that will be run is the next one in the
75 list of programs, instead of a randomly-chosen
76 one. Repeatedly executing this will cycle through
77 each hack in turn (though using the _
\b-_
\bd_
\be_
\bm_
\bo option
78 is probably an easier way to accomplish that.)
80 -
\b-p
\bpr
\bre
\bev
\bv This is like _
\b-_
\bn_
\be_
\bx_
\bt, but cycles in the other direc-
83 -
\b-e
\bex
\bxi
\bit
\bt Causes the screensaver process to exit gracefully.
84 This is a safer and easier way to kill the screen-
85 saver than by using _
\bk_
\bi_
\bl_
\bl.
87 W
\bWa
\bar
\brn
\bni
\bin
\bng
\bg:
\b: never use _
\bk_
\bi_
\bl_
\bl _
\b-_
\b9 with _
\bx_
\bs_
\bc_
\br_
\be_
\be_
\bn_
\bs_
\ba_
\bv_
\be_
\br while
88 the screensaver is active. If you are using a
89 virtual root window manager, that can leave things
90 in an inconsistent state, and you may need to
91 restart your window manager to repair the damage.
93 -
\b-r
\bre
\bes
\bst
\bta
\bar
\brt
\bt
94 Causes the screensaver process to exit and then
95 restart with the same command line arguments.
96 This is a good way of causing the screensaver to
97 re-read the resource database.
99 If the screensaver is run from _
\bx_
\bd_
\bm_
\b(_
\b1_
\b) (that is, it
100 is already running before you log in) then you may
101 want to issue the ``restart'' command from one of
102 your startup scripts, so that the screensaver gets
103 your resource settings instead of the default
106 -
\b-v
\bve
\ber
\brs
\bsi
\bio
\bon
\bn
107 Print (on stdout) the version number of the
108 xscreensaver program that is running on $DISPLAY.
109 (To see the version number of _
\bx_
\bs_
\bc_
\br_
\be_
\be_
\bn_
\bs_
\ba_
\bv_
\be_
\br_
\b-_
\bc_
\bo_
\bm_
\bm_
\ba_
\bn_
\bd
110 itself, use the _
\b-_
\bh_
\be_
\bl_
\bp option.)
112 -
\b-t
\bti
\bim
\bme
\be This option prints on stdout the time at which the
113 screensaver last activated (blanked the screen) or
114 deactivated (restored the screen.) Note that the
115 activation-time is not the last time at which the
116 user was active, but is some time later (it is the
117 time at which either: xscreensaver decided that
118 the user has been idle long enough; or, the user
119 explicitly activated the screensaver or locker.)
121 E
\bEN
\bNV
\bVI
\bIR
\bRO
\bON
\bNM
\bME
\bEN
\bNT
\bT
122 D
\bDI
\bIS
\bSP
\bPL
\bLA
\bAY
\bY to get the host and display number of the screen
123 whose saver is to be manipulated.
125 P
\bPA
\bAT
\bTH
\bH to find the executable to restart (for the
126 _
\b-_
\br_
\be_
\bs_
\bt_
\ba_
\br_
\bt command). Note that this variable is
130 X Version 11 31-May-97 2
136 XScreenSaver(1) XScreenSaver(1)
139 consulted in the environment of the _
\bx_
\bs_
\bc_
\br_
\be_
\be_
\bn_
\bs_
\ba_
\bv_
\be_
\br
140 process, not the _
\bx_
\bs_
\bc_
\br_
\be_
\be_
\bn_
\bs_
\ba_
\bv_
\be_
\br_
\b-_
\bc_
\bo_
\bm_
\bm_
\ba_
\bn_
\bd process.
142 S
\bSE
\bEE
\bE A
\bAL
\bLS
\bSO
\bO
143 X
\bX(1), x
\bxs
\bsc
\bcr
\bre
\bee
\ben
\bns
\bsa
\bav
\bve
\ber
\br(1)
146 Some diagnostics are reported on the stderr of the
147 _
\bx_
\bs_
\bc_
\br_
\be_
\be_
\bn_
\bs_
\ba_
\bv_
\be_
\br process, not this process, so the caller of
148 _
\bx_
\bs_
\bc_
\br_
\be_
\be_
\bn_
\bs_
\ba_
\bv_
\be_
\br_
\b-_
\bc_
\bo_
\bm_
\bm_
\ba_
\bn_
\bd may not see the error messages.
150 C
\bCO
\bOP
\bPY
\bYR
\bRI
\bIG
\bGH
\bHT
\bT
151 Copyright (C) 1992, 1993, 1997 by Jamie Zawinski. Permis-
152 sion to use, copy, modify, distribute, and sell this soft-
153 ware and its documentation for any purpose is hereby
154 granted without fee, provided that the above copyright
155 notice appear in all copies and that both that copyright
156 notice and this permission notice appear in supporting
157 documentation. No representations are made about the
158 suitability of this software for any purpose. It is pro-
159 vided "as is" without express or implied warranty.
161 A
\bAU
\bUT
\bTH
\bHO
\bOR
\bR
162 Jamie Zawinski <jwz@netscape.com>, 13-aug-92.
196 X Version 11 31-May-97 3