
NAME
xscreensaver-command - control a running xscreensaver process
SYNOPSIS
xscreensaver-command
[--display host:display.screen]
[--help |
--quiet |
--verbose |
--activate |
--deactivate |
--cycle |
--next |
--prev |
--select n |
--lock |
--suspend |
--exit |
--restart |
--time |
--watch |
--version]
DESCRIPTION
OPTIONS
xscreensaver-command
accepts the following command-line options:
BLANK Fri Nov 5 01:57:22 1999
RUN 34
RUN 79
RUN 16
LOCK Fri Nov 5 01:57:22 1999
RUN 76
RUN 12
UNBLANK Fri Nov 5 02:05:59 1999
The above shows the screensaver activating, running three different
hacks, then locking (perhaps because the lock-timeout went off) then
unblanking (because the user became active, and typed the correct
password.) The hack numbers are their index in the `programs'
list (starting with 1, not 0, as for the --select command.)
For example, suppose you want to run a program that turns down the volume
on your machine when the screen blanks, and turns it back up when the screen
un-blanks. You could do that by running a Perl program like the following
in the background. The following program tracks the output of
the --watch command and reacts accordingly:
#!/usr/bin/perl
my $blanked = 0;
open (my $in, "xscreensaver-command -watch |") || die;
while (<$in>) {
if (m/^(BLANK|LOCK)/) {
if (!$blanked) {
system ("sound-off");
$blanked = 1;
}
} elsif (m/^UNBLANK/) {
system ("sound-on");
$blanked = 0;
}
}
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.
--version
Prints the version of xscreensaver that is currently running on the display:
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 xscreensaver-command itself, use
the --help option.)
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:
xset dpms force off
See the
xset (1) manual for more info.
You can also use
xscreensaver-settings (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.
DIAGNOSTICS
If an error occurs while communicating with the xscreensaver daemon, or
if the daemon reports an error, a diagnostic message will be printed to
stderr, and xscreensaver-command 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.
ENVIRONMENT
DISPLAY
to get the host and display number of the screen whose saver is
to be manipulated.
PATH
to find the executable to restart (for the --restart command).
Note that this variable is consulted in the environment of
the xscreensaver process, not the xscreensaver-command process.
UPGRADES
SEE ALSO
COPYRIGHT
Copyright © 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
both that copyright notice and this permission notice appear in
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.
AUTHOR