http://ftp.x.org/contrib/applications/xscreensaver-2.34.tar.gz
[xscreensaver] / driver / xscreensaver-command.man
index a542d552bd56f789af1a3153ded2f49290b12b9a..a3a92fa3fecc69fd53ef94290a5979a4ee528cc7 100644 (file)
 .if n .sp 1
 .if t .sp .5
 ..
 .if n .sp 1
 .if t .sp .5
 ..
-.TH XScreenSaver 1 "30-Jun-98 (2.24)" "X Version 11"
+.TH XScreenSaver 1 "08-Oct-98 (2.34)" "X Version 11"
 .SH NAME
 xscreensaver-command - control a running xscreensaver process
 .SH SYNOPSIS
 .B xscreensaver-command
 [\-help] \
 [\-demo] \
 .SH NAME
 xscreensaver-command - control a running xscreensaver process
 .SH SYNOPSIS
 .B xscreensaver-command
 [\-help] \
 [\-demo] \
+[\-prefs] \
 [\-activate] \
 [\-deactivate] \
 [\-cycle] \
 [\-next] \
 [\-prev] \
 [\-activate] \
 [\-deactivate] \
 [\-cycle] \
 [\-next] \
 [\-prev] \
+[\-select \fIn\fP] \
 [\-exit] \
 [\-restart] \
 [\-lock] \
 [\-exit] \
 [\-restart] \
 [\-lock] \
@@ -49,6 +51,13 @@ can experiment with the various graphics hacks available.  See
 .BR xscreensaver (1)
 for details.
 .TP 8
 .BR xscreensaver (1)
 for details.
 .TP 8
+.B \-prefs
+Cause the screensaver to enter its interactive demo mode, and bring up
+the Preferences control panel, in which one can change most of the settings
+that control the xscreensaver daemon's behavior.  See
+.BR xscreensaver (1)
+for details.
+.TP 8
 .B \-activate
 Tell xscreensaver to turn on immediately (that is, blank the screen, as if
 the user had been idle for long enough.)  The screensaver will deactivate as
 .B \-activate
 Tell xscreensaver to turn on immediately (that is, blank the screen, as if
 the user had been idle for long enough.)  The screensaver will deactivate as
@@ -83,6 +92,12 @@ an easier way to accomplish that.)
 .B \-prev
 This is like \fI\-next\fP, but cycles in the other direction.
 .TP 8
 .B \-prev
 This is like \fI\-next\fP, but cycles in the other direction.
 .TP 8
+.B \-select \fInumber\fP
+Like \fI\-activate\fP, but runs the \fIN\fPth element in the list of hacks.
+By knowing what is in the \fIprograms\fP list, and in what order, you can use
+this to activate the screensaver with a particular graphics demo.  (The first
+element in the list is numbered 1, not 0.)
+.TP 8
 .B \-exit
 Causes the xscreensaver process to exit gracefully.  This is roughly the same
 as killing the process with
 .B \-exit
 Causes the xscreensaver process to exit gracefully.  This is roughly the same
 as killing the process with
@@ -123,6 +138,12 @@ Prints the time at which the screensaver last activated or
 deactivated (roughly, how long the user has been idle or non-idle: but 
 not quite, since it only tells you when the screen became blanked or
 un-blanked.)
 deactivated (roughly, how long the user has been idle or non-idle: but 
 not quite, since it only tells you when the screen became blanked or
 un-blanked.)
+.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
+stderr, and \fIxscreensaver-command\fP will exit with a non-zero value.  If
+the command is accepted, an indication of this will be printed to stdout, and
+the exit value will be zero.
 .SH ENVIRONMENT
 .PP
 .TP 8
 .SH ENVIRONMENT
 .PP
 .TP 8
@@ -138,14 +159,10 @@ the \fIxscreensaver\fP process, not the \fIxscreensaver-command\fP process.
 The latest version of
 .BR xscreensaver (1)
 and \fIxscreensaver\-command\fP can always be found at 
 The latest version of
 .BR xscreensaver (1)
 and \fIxscreensaver\-command\fP can always be found at 
-http://people.netscape.com/jwz/xscreensaver/
+http://www.jwz.org/xscreensaver/
 .SH "SEE ALSO"
 .BR X (1),
 .BR xscreensaver (1)
 .SH "SEE ALSO"
 .BR X (1),
 .BR xscreensaver (1)
-.SH BUGS
-Some diagnostics are reported on the stderr of the \fIxscreensaver\fP
-process, not this process, so the caller of \fIxscreensaver-command\fP
-may not see the error messages.
 .SH COPYRIGHT
 Copyright \(co 1992, 1993, 1997, 1998
 by Jamie Zawinski.  Permission to use, copy, modify, distribute, and sell
 .SH COPYRIGHT
 Copyright \(co 1992, 1993, 1997, 1998
 by Jamie Zawinski.  Permission to use, copy, modify, distribute, and sell
@@ -156,6 +173,6 @@ documentation.  No representations are made about the suitability of this
 software for any purpose.  It is provided "as is" without express or implied
 warranty.
 .SH AUTHOR
 software for any purpose.  It is provided "as is" without express or implied
 warranty.
 .SH AUTHOR
-Jamie Zawinski <jwz@netscape.com>, 13-aug-92.
+Jamie Zawinski <jwz@jwz.org>, 13-aug-92.
 
 Please let me know if you find any bugs or make any improvements.
 
 Please let me know if you find any bugs or make any improvements.