http://ftp.ksu.edu.tw/FTP/FreeBSD/distfiles/xscreensaver-4.20.tar.gz
[xscreensaver] / driver / xscreensaver-command.man
index 25befb7e43d4ebccc7adcfb05eccc1a2d79c54e7..9c30af47251430b8e64d182ab8e38853a57d1d70 100644 (file)
 .if n .sp 1
 .if t .sp .5
 ..
-.TH XScreenSaver 1 "15-Apr-2001 (3.32)" "X Version 11"
+.TH XScreenSaver 1 "23-Feb-2005 (4.20)" "X Version 11"
 .SH NAME
 xscreensaver-command - control a running xscreensaver process
 .SH SYNOPSIS
 .B xscreensaver-command
 [\-display \fIhost:display.screen\fP] \
-[\-help] \
-[\-demo] \
-[\-prefs] \
-[\-activate] \
-[\-deactivate] \
-[\-cycle] \
-[\-next] \
-[\-prev] \
-[\-select \fIn\fP] \
-[\-exit] \
-[\-restart] \
-[\-lock] \
-[\-throttle] \
-[\-unthrottle] \
-[\-version] \
-[\-time] \
-[\-watch]
+[\-help | \
+\-demo | \
+\-prefs | \
+\-activate | \
+\-deactivate | \
+\-cycle | \
+\-next | \
+\-prev | \
+\-select \fIn\fP | \
+\-exit | \
+\-restart | \
+\-lock | \
+\-version | \
+\-time | \
+\-watch]
 .SH DESCRIPTION
 The \fIxscreensaver\-command\fP program controls a running \fIxscreensaver\fP
 process by sending it client-messages.
@@ -88,10 +86,14 @@ the screensaver comes on.  (Because if you jiggle the mouse, xscreensaver
 will notice, and deactivate.)
 .TP 8
 .B \-deactivate
-If the screensaver is active (the screen is blanked), this command will
-deactivate it just as if there had been keyboard or mouse activity.  
-If locking is enabled, then the screensaver will prompt for a password
-as usual.
+This tells xscreensaver to pretend that there has just been user activity.
+This means that if the screensaver is active (the screen is blanked),
+then this command will cause the screen to un-blank as if there had been
+keyboard or mouse activity.  If the screen is locked, then the password
+dialog will pop up first, as usual.  If the screen is not blanked, then
+this simulated user activity will re-start the countdown (so, issuing
+the \fI\-deactivate\fP command periodically is \fIone\fP way to prevent
+the screen from blanking.)
 .TP 8
 .B \-cycle
 If the screensaver is active (the screen is blanked), then stop the current
@@ -137,21 +139,6 @@ running as you.  See
 .BR xscreensaver (1)
 for details.
 .TP 8
-.B \-throttle
-Temporarily switch to ``blank screen'' mode, and don't run any display modes
-at all, until the screensaver is next de-activated.  This is useful if you're
-using a machine remotely, and you find that some display modes are using too
-much CPU.  
-
-(If you want to do this \fIpermanently\fP, that is, you want the screen saver
-to only blank the screen and not run demos at all, then set the \fIprograms\fP
-resource to an empty list:  See
-.BR xscreensaver (1)
-for details.)
-.TP 8
-.B \-unthrottle
-Turn `-throttle' mode off and resume normal behavior.
-.TP 8
 .B \-version
 Prints the version of xscreensaver that is currently running on the display:
 that is, the actual version number of the running xscreensaver background 
@@ -226,6 +213,26 @@ while (<IN>) {
 Note that LOCK might come either with or without a preceeding BLANK
 (depending on whether the lock-timeout is non-zero), so the above program
 keeps track of both of them.
+.SH STOPPING GRAPHICS
+If xscreensaver is running, but you want it to stop running screen hacks
+(e.g., if you are logged in remotely, and you want the console to remain
+locked but just be black, with no graphics processes running) you can 
+accomplish that by simply powering down the monitor remotely.  In a
+minute or so, xscreensaver will notice that the monitor is off, and
+will stop running screen hacks.  You can power off the monitor like so:
+.EX
+xset dpms force off
+.EE
+See the
+.BR xset (1)
+manual for more info.
+
+You can also use
+.BR xscreensaver-demo (1)
+to make the monitor power down after a few hours, meaning that xscreensaver
+will run graphics until it has been idle for the length of time you
+specified; and after that, the monitor will power off, and screen hacks
+will stop being run.
 .SH DIAGNOSTICS
 If an error occurs while communicating with the \fIxscreensaver\fP daemon, or
 if the daemon reports an error, a diagnostic message will be printed to
@@ -249,10 +256,11 @@ The latest version of
 and related tools can always be found at http://www.jwz.org/xscreensaver/
 .SH "SEE ALSO"
 .BR X (1),
-.BR xscreensaver (1)
-.BR xscreensaver\-demo (1)
+.BR xscreensaver (1),
+.BR xscreensaver\-demo (1),
+.BR xset (1)
 .SH COPYRIGHT
-Copyright \(co 1992, 1993, 1997, 1998, 1999, 2000, 2001
+Copyright \(co 1992, 1993, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005
 by Jamie Zawinski.  Permission to use, copy, modify, distribute, and sell
 this software and its documentation for any purpose is hereby granted without
 fee, provided that the above copyright notice appear in all copies and that