~ubuntu-branches/ubuntu/dapper/xscreensaver/dapper-updates

« back to all changes in this revision

Viewing changes to driver/xscreensaver-command.man

  • Committer: Bazaar Package Importer
  • Author(s): Ralf Hildebrandt
  • Date: 2005-04-09 00:06:43 UTC
  • mfrom: (1.1.1 upstream)
  • mto: This revision was merged to the branch mainline in revision 3.
  • Revision ID: james.westby@ubuntu.com-20050409000643-z0abtifbt9s20pcc
Tags: 4.21-3
Patch by Joachim Breitner to check more frequently if DPMS kicked in (closes: #303374, #286664).

Show diffs side-by-side

added added

removed removed

Lines of Context:
11
11
.if n .sp 1
12
12
.if t .sp .5
13
13
..
14
 
.TH XScreenSaver 1 "25-Oct-2001 (3.34)" "X Version 11"
 
14
.TH XScreenSaver 1 "20-Mar-2005 (4.21)" "X Version 11"
15
15
.SH NAME
16
16
xscreensaver-command - control a running xscreensaver process
17
17
.SH SYNOPSIS
18
18
.B xscreensaver-command
19
19
[\-display \fIhost:display.screen\fP] \
20
 
[\-help] \
21
 
[\-demo] \
22
 
[\-prefs] \
23
 
[\-activate] \
24
 
[\-deactivate] \
25
 
[\-cycle] \
26
 
[\-next] \
27
 
[\-prev] \
28
 
[\-select \fIn\fP] \
29
 
[\-exit] \
30
 
[\-restart] \
31
 
[\-lock] \
32
 
[\-throttle] \
33
 
[\-unthrottle] \
34
 
[\-version] \
35
 
[\-time] \
36
 
[\-watch]
 
20
[\-help | \
 
21
\-demo | \
 
22
\-prefs | \
 
23
\-activate | \
 
24
\-deactivate | \
 
25
\-cycle | \
 
26
\-next | \
 
27
\-prev | \
 
28
\-select \fIn\fP | \
 
29
\-exit | \
 
30
\-restart | \
 
31
\-lock | \
 
32
\-version | \
 
33
\-time | \
 
34
\-watch]
37
35
.SH DESCRIPTION
38
36
The \fIxscreensaver\-command\fP program controls a running \fIxscreensaver\fP
39
37
process by sending it client-messages.
88
86
will notice, and deactivate.)
89
87
.TP 8
90
88
.B \-deactivate
91
 
If the screensaver is active (the screen is blanked), this command will
92
 
deactivate it just as if there had been keyboard or mouse activity.  
93
 
If locking is enabled, then the screensaver will prompt for a password
94
 
as usual.
 
89
This tells xscreensaver to pretend that there has just been user activity.
 
90
This means that if the screensaver is active (the screen is blanked),
 
91
then this command will cause the screen to un-blank as if there had been
 
92
keyboard or mouse activity.  If the screen is locked, then the password
 
93
dialog will pop up first, as usual.  If the screen is not blanked, then
 
94
this simulated user activity will re-start the countdown (so, issuing
 
95
the \fI\-deactivate\fP command periodically is \fIone\fP way to prevent
 
96
the screen from blanking.)
95
97
.TP 8
96
98
.B \-cycle
97
99
If the screensaver is active (the screen is blanked), then stop the current
137
139
.BR xscreensaver (1)
138
140
for details.
139
141
.TP 8
140
 
.B \-throttle
141
 
Temporarily switch to ``blank screen'' mode, and don't run any display modes
142
 
at all, until the screensaver is next de-activated.  This is useful if you're
143
 
using a machine remotely, and you find that some display modes are using too
144
 
much CPU.  
145
 
 
146
 
(If you want to do this \fIpermanently\fP, that is, you want the screen saver
147
 
to only blank the screen and not run demos at all, then set the \fIprograms\fP
148
 
resource to an empty list:  See
149
 
.BR xscreensaver (1)
150
 
for details.)
151
 
.TP 8
152
 
.B \-unthrottle
153
 
Turn `-throttle' mode off and resume normal behavior.
154
 
.TP 8
155
142
.B \-version
156
143
Prints the version of xscreensaver that is currently running on the display:
157
144
that is, the actual version number of the running xscreensaver background 
226
213
Note that LOCK might come either with or without a preceeding BLANK
227
214
(depending on whether the lock-timeout is non-zero), so the above program
228
215
keeps track of both of them.
 
216
.SH STOPPING GRAPHICS
 
217
If xscreensaver is running, but you want it to stop running screen hacks
 
218
(e.g., if you are logged in remotely, and you want the console to remain
 
219
locked but just be black, with no graphics processes running) you can 
 
220
accomplish that by simply powering down the monitor remotely.  In a
 
221
minute or so, xscreensaver will notice that the monitor is off, and
 
222
will stop running screen hacks.  You can power off the monitor like so:
 
223
.EX
 
224
xset dpms force off
 
225
.EE
 
226
See the
 
227
.BR xset (1)
 
228
manual for more info.
 
229
 
 
230
You can also use
 
231
.BR xscreensaver-demo (1)
 
232
to make the monitor power down after a few hours, meaning that xscreensaver
 
233
will run graphics until it has been idle for the length of time you
 
234
specified; and after that, the monitor will power off, and screen hacks
 
235
will stop being run.
229
236
.SH DIAGNOSTICS
230
237
If an error occurs while communicating with the \fIxscreensaver\fP daemon, or
231
238
if the daemon reports an error, a diagnostic message will be printed to
249
256
and related tools can always be found at http://www.jwz.org/xscreensaver/
250
257
.SH "SEE ALSO"
251
258
.BR X (1),
252
 
.BR xscreensaver (1)
253
 
.BR xscreensaver\-demo (1)
 
259
.BR xscreensaver (1),
 
260
.BR xscreensaver\-demo (1),
 
261
.BR xset (1)
254
262
.SH COPYRIGHT
255
 
Copyright \(co 1992, 1993, 1997, 1998, 1999, 2000, 2001
 
263
Copyright \(co 1992, 1993, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005
256
264
by Jamie Zawinski.  Permission to use, copy, modify, distribute, and sell
257
265
this software and its documentation for any purpose is hereby granted without
258
266
fee, provided that the above copyright notice appear in all copies and that