summaryrefslogtreecommitdiffstats
path: root/driver/xscreensaver-command.man
diff options
context:
space:
mode:
authorSimon Rettberg2024-09-06 14:42:37 +0200
committerSimon Rettberg2024-09-06 14:42:37 +0200
commitbadef32037f52f79abc1f1440b786cd71afdf270 (patch)
tree412b792d4cab4a7a110db82fcf74fe8a1ac55ec1 /driver/xscreensaver-command.man
parentDelete pre-6.00 files (diff)
downloadxscreensaver-master.tar.gz
xscreensaver-master.tar.xz
xscreensaver-master.zip
Diffstat (limited to 'driver/xscreensaver-command.man')
-rw-r--r--driver/xscreensaver-command.man47
1 files changed, 8 insertions, 39 deletions
diff --git a/driver/xscreensaver-command.man b/driver/xscreensaver-command.man
index 6d52d2a..c0301d4 100644
--- a/driver/xscreensaver-command.man
+++ b/driver/xscreensaver-command.man
@@ -24,39 +24,23 @@ xscreensaver-command - control a running xscreensaver process
The \fIxscreensaver\-command\fP program controls a running
.BR xscreensaver (1)
daemon.
-
.SH OPTIONS
.I xscreensaver-command
accepts the following command-line options:
-
.TP 8
.B \-\-help
Prints a brief summary of command-line options.
-
.TP 8
.B \-\-quiet
Only print output if an error occurs.
-
.TP 8
.B \-\-verbose
Opposite of \-\-quiet. Default.
-
.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
soon as there is any user activity, as usual.
-
-It is useful to run this from a menu; you may wish to run it as
-.nf
-.sp
- sleep 5 ; xscreensaver-command -activate
-.sp
-.fi
-to be sure that you have time to take your hand off the mouse before
-the screensaver comes on. (Because if you jiggle the mouse, xscreensaver
-will notice, and deactivate.)
-
.TP 8
.B \-\-deactivate
This tells xscreensaver to pretend that there has just been user activity.
@@ -67,32 +51,27 @@ 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
graphics demo and run a new one (chosen randomly.)
-
.TP 8
.B \-\-next
This is like either \fI\-\-activate\fP or \fI\-\-cycle\fP, depending on which
is more appropriate, except that the graphics hack that will be run is the
next one in the list, instead of a randomly-chosen one. In other words,
-repeatedly executing -next will cause the xscreensaver process to invoke each
-graphics demo sequentially. (Though using the \fI\-\-settings\fP option is
-probably an easier way to accomplish that.)
-
+repeatedly executing \-\-next will cause the xscreensaver process to invoke
+each graphics demo sequentially. (Though using the \fI\-\-settings\fP option
+is probably an easier way to accomplish that.)
.TP 8
.B \-\-prev
This is like \fI\-\-next\fP, but cycles in the other direction.
-
.TP 8
-.B \-\-select \fInumber\fP
+.B \-\-select\fP \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 \-\-lock
Tells the running xscreensaver process to lock the screen immediately.
@@ -104,39 +83,31 @@ Note that locking doesn't work unless the \fIxscreensaver\fP process is
running as you. See
.BR xscreensaver (1)
for details.
-
.TP 8
.B \-\-suspend
Like \fI\-\-activate\fP, but ignores \fIlockTimeout\fP and immediately
powers off the screen without fading out. This is intended to be run
just after your laptop's lid is closed, and just before the CPU halts,
to lock things down quickly.
-
.TP 8
.B \-\-exit
Causes the xscreensaver process to exit gracefully.
This does nothing if the display is currently locked.
-
.B Warning:
-never use \fIkill -9\fP with \fIxscreensaver\fP while the screensaver is
-active. If you are using a virtual root window manager, that can leave
-things in an inconsistent state, and you may need to restart your window
-manager to repair the damage.
-
+never use \fIkill -9\fP with \fIxscreensaver\fP. That can leave things in an
+inconsistent state, and you may need to log out to repair the damage.
.TP 8
.B \-\-restart
Causes the screensaver process to exit and then restart with the same command
line arguments as last time. You shouldn't really need to do this,
since xscreensaver notices when the \fI.xscreensaver\fP file has
changed and re-reads it as needed.
-
.TP 8
.B \-\-time
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.)
-
.TP 8
.B \-\-watch
Prints a line each time the screensaver changes state: when the screen
@@ -188,7 +159,6 @@ the \fI\-\-watch\fP command and reacts accordingly:
Note that LOCK might come either with or without a preceding BLANK
(depending on whether the lock-timeout is non-zero), so the above program
keeps track of both of them.
-
.TP 8
.B \-\-version
Prints the version of xscreensaver that is currently running on the display:
@@ -196,7 +166,6 @@ that is, the actual version number of the running xscreensaver background
process, rather than the version number of xscreensaver-command. (To see
the version number of \fIxscreensaver-command\fP itself, use
the \fI\-\-help\fP option.)
-
.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
@@ -246,7 +215,7 @@ and related tools can always be found at https://www.jwz.org/xscreensaver/
.BR xscreensaver\-settings (1),
.BR xset (1)
.SH COPYRIGHT
-Copyright \(co 1992-2021 by Jamie Zawinski.
+Copyright \(co 1992-2022 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
@@ -255,6 +224,6 @@ supporting 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
-Jamie Zawinski <jwz@jwz.org>, 13-aug-1992.
+Jamie Zawinski <jwz@jwz.org>.
Please let me know if you find any bugs or make any improvements.