xscreensaver - Man Page

xscreensaver [--display host:display.screen] [--verbose] [--version] [--no-splash] [--log filename]

XScreenSaver waits until the user is idle, and then runs graphics demos chosen at random.  It can also lock your screen, and provides configuration and control of display power management.

XScreenSaver is also available on macOS, iOS and Android.

XScreenSaver is a daemon that runs in the background.  You configure it with the xscreensaver-settings(1) program.

	xscreensaver &
	xscreensaver-settings

When it is time to activate the screensaver, a full-screen black window is created that covers each monitor.  A sub-process is launched for each one running a graphics demo, pointed at the appropriate window.  Because of this, any program which can draw on a provided window can be used as a screensaver. The various graphics demos are, in fact, just standalone programs that do that.

When the user becomes active again, the screensaver windows are unmapped, and the running subprocesses are killed.

The display modes are run at a low process priority, and spend most of their time sleeping/idle by default, so they should not consume significant system resources.

--display host:display.screen

The X display to use.  For displays with multiple screens, XScreenSaver will manage all screens on the display simultaneously.

--verbose

Print diagnostics to stderr.

--version

Print the version number and exit.

--log filename

Append all diagnostic output to the given file.  This also  implies --verbose.  Use this when reporting bugs.

--no-splash

Don't display the splash screen at startup.

The xscreensaver-settings(1) program is where you configure if and when your monitor should power off. It saves the settings in your ~/.xscreensaver file. Do not use xset(1) to manually change the power management settings, that won't work.

When the monitor is powered down, the display hacks will stop running (though it may take a minute or two for XScreenSaver to notice).

If your system uses systemd(1) or elogind(8), then closing the lid of your laptop will cause the screen to lock immediately.

If not, then the screen might not lock until a few seconds after you re-open the lid.  Which is less than ideal.  So if you do not have systemd(1), you might want to get in the habit of manually locking your screen before closing the lid (xscreensaver-command --lock).

Likewise, if you have systemd(1) or elogind(8), then all of the popular video players and web browsers will prevent XScreenSaver from blanking the screen while video is playing.

Both of these features require that xscreensaver-systemd(6) be able connect to D-Bus.

Each desktop environment has its own system for launching long-running daemons like XScreenSaver, and since many of them come bundled with their own (buggy, insecure, inferior) screen-locking frameworks, it is also necessary to disable those other frameworks before XScreenSaver can work.

	systemctl --user enable xscreensaver

	Name: XScreenSaver
	Command: xscreensaver
	Comment: XScreenSaver

	Greeter=/usr/bin/gdmlogin
	BackgroundProgram=xscreensaver --no-splash
	RunBackgroundProgramAlways=true

Wayland is a completely different window system that is intended to replace X11.  After 14+ years of trying, some Linux distros have finally begun enabling it by default.  Most deployments of it also include XWayland, which is a compatibility layer that allows some X11 programs to continue to work within a Wayland environment.

Unfortunately, XScreenSaver is not one of those programs.

If your system is running XWayland, XScreenSaver will malfunction in two ways:

1: It will be unable to detect user activity in non-X11 programs.

This means that while a native Wayland program is selected, XScreenSaver will think that you are idle, and may blank the screen prematurely.

2: It will be unable to lock the screen.

This is because X11 grabs don't work properly under XWayland, so there is no way for XScreenSaver to prevent the user from switching away from the screen locker to another application.

In short, for XScreenSaver to work properly, you will need to switch off Wayland and use the X Window System like in the "good old days".

	WaylandEnable=false

	SessionDir=/dev/null

XScreenSaver has a decades-long track record of securely locking your screen. However, there are many things that can go wrong.  X11 is a very old system, and has a number of design flaws that make it susceptible to foot-shooting.

	echo 2 > /proc/sys/vm/overcommit_memory
	echo vm.overcommit_memory = 2 >> /etc/sysctl.conf

	sudo systemctl disable --now systemd-oomd
	sudo systemctl mask systemd-oomd

For a single user, the proper way to configure XScreenSaver is to simply run the xscreensaver-settings(1) program, and change the settings through the GUI.  Changes are written to the ~/.xscreensaver file.

If you want to set the system-wide defaults, then make your edits to /etc/X11/app-defaults/XScreenSaver instead.  The two files have similar (but not identical) syntax.

You can also make changes via the X Resource Database and xrdb(1), but that can be very confusing and is not really recommended.

Options in ~/.xscreensaver override any settings in the resource database or app-defaults file.

If you change a setting in the .xscreensaver file while XScreenSaver is already running, it will notice this, and reload the file as needed. But if you change a setting in the X Resource Database, you will need to restart XScreenSaver for those changes to take effect:

	xrdb < ~/.Xdefaults
	xscreensaver-command --restart

These are the X resources use by XScreenSaver program.  You probably won't need to change these manually: that's what the xscreensaver-settings(1) program is for.

timeout (class Time)

The screensaver will activate (blank the screen) after the keyboard and mouse have been idle for this many minutes.  Default 10 minutes.

cycle (class Time)

After the screensaver has been running for this many minutes, the currently running graphics-hack sub-process will be killed (with SIGTERM), and a new one started.  If this is 0, then the graphics hack will never be changed: only one demo will run until the screensaver is deactivated by user activity. Default 10 minutes.

If there are multiple screens, the savers are staggered slightly so that while they all change every cycle minutes, they don't all change at the same time.

lock (class Boolean)

Enable locking: before the screensaver will turn off, it will require you  to type the password of the logged-in user.

lockTimeout (class Time)

If locking is enabled, this controls the length of the "grace period" between when the screensaver activates, and when the screen becomes locked. For example, if this is 5, and timeout is 10, then after 10 minutes, the screen would blank.  If there was user activity at 12 minutes, no password would be required to un-blank the screen.  But, if there was user activity at 15 minutes or later (that is, lockTimeout minutes after  activation) then a password would be required.  The default is 0, meaning that if locking is enabled, then a password will be required as soon as the  screen blanks.

passwdTimeout (class Time)

If the screen is locked, then this is how many seconds the password dialog box should be left on the screen before giving up (default 30 seconds).  A few seconds are added each time you type a character.

dpmsEnabled (class Boolean)

Whether power management is enabled.

dpmsStandby (class Time)

If power management is enabled, how long until the monitor goes solid black.

dpmsSuspend (class Time)

If power management is enabled, how long until the monitor goes into power-saving mode.

dpmsOff (class Time)

If power management is enabled, how long until the monitor powers down completely.  Note that these settings will have no effect unless both the X server and the display hardware support power management; not  all do.  See the Power Management section, below, for more  information.

dpmsQuickOff (class Boolean)

If mode is blank and this is true, then the screen will be powered down immediately upon blanking, regardless of other power-management settings.

verbose (class Boolean)

Whether to print diagnostics.  Default false.

splash (class Boolean)

Whether to display a splash screen at startup.  Default true.

splashDuration (class Time)

How long the splash screen should remain visible; default 5 seconds.

helpURL (class URL)

The splash screen has a Help button on it.  When you press it, it will display the web page indicated here in your web browser.

loadURL (class LoadURL)

This is the shell command used to load a URL into your web browser.

demoCommand (class DemoCommand)

This is the shell command run when the Demo button on the splash window is pressed.  It defaults to xscreensaver-settings(1).

newLoginCommand (class NewLoginCommand)

If set, this is the shell command that is run when the "New Login" button is pressed on the unlock dialog box, in order to create a new desktop session without logging out the user who has locked the screen. Typically this will be some variant of gdmflexiserver(1), kdmctl(1), lxdm(1) or dm-tool(1).

nice (class Nice)

The sub-processes launched by XScreenSaver will be "niced" to this level, so that they are given lower priority than other processes on the system, and don't increase the load unnecessarily.  The default is 10.  (Higher numbers mean lower priority; see nice(1) for details.)

fade (class Boolean)

If this is true, then when the screensaver activates, the desktop will fade to black instead of simply winking out.  Default: true.

unfade (class Boolean)

If this is true, then when the screensaver deactivates, desktop will fade back ininstead of appearing immediately.  This is only done if fade is true as well.  Default: true.

fadeSeconds (class Time)

If fade is true, this is how long the fade will be in  seconds. Default 3 seconds.

ignoreUninstalledPrograms (class Boolean)

There may be programs in the list that are not installed on the system, yet are marked as "enabled".  If this preference is true, then such  programs will simply be ignored.  If false, then a warning will be printed if an attempt is made to run the nonexistent program.  Also, the xscreensaver-settings(1) program will suppress the non-existent programs from the list if this is true.  Default: false.

authWarningSlack (class Integer)

After you successfully unlock the screen, a dialog may pop up informing you of previous failed login attempts.  If all of those login attemps were within this amount of time, they are ignored.  The assumption is that incorrect passwords entered within a few seconds of a correct one are user error, rather than hostile action.  Default 20 seconds.

mode (class Mode)

Controls the screen-saving behavior.  Valid values are:

random

When blanking the screen, select a random display mode from among those that are enabled and applicable.  This is the default.

random-same

Like random, but if there are multiple screens, each screen will run the same random display mode, instead of each screen running a different one.

one

When blanking the screen, only ever use one particular display mode (the one indicated by the selected setting).

blank

When blanking the screen, just go black: don't run any graphics hacks.

off

Don't ever blank the screen, and don't ever allow the monitor to power down.

selected (class Integer)

When mode is set to one, this is the one, indicated by its index in the programs list.  You're crazy if you count them and set this number by hand: let xscreensaver-settings(1) do it for you!

programs (class Programs)

The graphics hacks which XScreenSaver runs when the user is idle. The value of this resource is a multi-line string, one sh-syntax command per line.  Each line must contain exactly one command: no semicolons, no ampersands.

When the screensaver starts up, one of these is selected (according to the mode setting), and run.  After the cycle period expires, it is killed, and another is selected and run.

If a line begins with a dash (-) then that particular program is disabled: it won't be selected at random (though you can still select it explicitly using the xscreensaver-settings(1) program).

If all programs are disabled, then the screen will just be made blank, as when mode is set to blank.

To disable a program, you must mark it as disabled with a dash instead of removing it from the list.  This is because the system-wide (app-defaults) and per-user (.xscreensaver) settings are merged together, and if a user just deletes an entry from their programs list, but that entry still exists in the system-wide list, then it will come back.  However, if the user disables it, then their setting takes precedence.

The default XScreenSaver hacks directory (typically /usr/libexec/xscreensaver/) is prepended to $PATH before searching for these programs.

To use a program as a screensaver, it must be able to render onto the window provided to it in the $XSCREENSAVER_WINDOW environment variable.  If it creates and maps its own window instead, it won't work. It must render onto the provided window.

Visuals:

Because XScreenSaver was created back when dinosaurs roamed the earth, it still contains support for some things you've probably never seen, such as 1-bit monochrome monitors, grayscale monitors, and monitors capable of displaying only 8-bit colormapped images.

If there are some programs that you want to run only when using a color display, and others that you want to run only when using a monochrome display, you can specify that like this:

	mono:   mono-program  -root        \n\
	color:  color-program -root        \n\

More generally, you can specify the kind of visual that should be used for the window on which the program will be drawing.  For example, if one  program works best if it has a colormap, but another works best if it has a 24-bit visual, both can be accommodated:

	PseudoColor: cmap-program  -root   \n\
	TrueColor:   24bit-program -root   \n\

In addition to the symbolic visual names described above (in the discussion of the visualID resource) one other visual name is supported in the programs list:

default-n

This is like default, but also requests the use of the default colormap, instead of a private colormap.

If you specify a particular visual for a program, and that visual does not exist on the screen, then that program will not be chosen to run.  This means that on displays with multiple screens of different depths, you can arrange for appropriate hacks to be run on each.  For example, if one screen is color and the other is monochrome, hacks that look good in mono can be  run on one, and hacks that only look good in color will show up on the other.

visualID (class VisualID)

This is an historical artifact left over from when 8-bit displays were still common.  You should probably ignore this.

Specify which X visual to use by default.  (Note carefully that this resource is called visualID, not merely visual; if you set the visual resource instead, things will malfunction in obscure ways for obscure reasons.)

Valid values for the VisualID resource are:

default

Use the screen's default visual (the visual of the root window).   This is the default.

best

Use the visual which supports the most colors.  Note, however, that the visual with the most colors might be a TrueColor visual, which does not support colormap animation.  Some programs have more interesting behavior when run on PseudoColor visuals than on TrueColor.

mono

Use a monochrome visual, if there is one.

gray

Use a grayscale or staticgray visual, if there is one and it has more than one plane (that is, it's not monochrome).

color

Use the best of the color visuals, if there are any.

GL

Use the visual that is best for OpenGL programs.  (OpenGL programs have somewhat different requirements than other X programs.)

class

where class is one of StaticGray, StaticColor,  TrueColor, GrayScale, PseudoColor, or DirectColor. Selects the deepest visual of the given class.

N

where number (decimal or hex) is interpreted as a visual id number,  as reported by the xdpyinfo(1) program; in this way you can have finer control over exactly which visual gets used, for example, to select a shallower one than would otherwise have been chosen.

Note that this option specifies only the default visual that will be used: the visual used may be overridden on a program-by-program basis. See the description of the programs resource, above.

installColormap (class Boolean)

This is an historical artifact left over from when 8-bit displays were still common.  On PseudoColor (8-bit) displays, install a private colormap while the screensaver is active, so that the graphics hacks can get as many colors as possible.  This is the default.  (This only applies when the screen's default visual is being used, since non-default visuals get their own colormaps automatically.)  This can also be overridden on a per-hack basis: see the discussion of the default-n name in the section about the programs resource.

This does nothing if you have a TrueColor (16-bit or deeper) display. (Which, in this century, you do.)

pointerHysteresis (class Integer)

If the mouse moves less than this-many pixels in a second, ignore it (do not consider that to be "activity").  This is so that the screen doesn't un-blank (or fail to blank) just because you bumped the desk. Default: 10 pixels.

A single pixel of motion will still cause the monitor to power back on, but not un-blank. This is because the X11 server itself unfortunately handles power-management-related activity detection rather than XScreenSaver.

https://www.jwz.org/xscreensaver/bugs.html explains how to write the most useful bug reports.  If you find a bug, please let me know!

DISPLAY

to get the default host and display number, and to inform the sub-programs of the screen on which to draw.

XSCREENSAVER_WINDOW

Passed to sub-programs to indicate the ID of the window on which they should draw.

PATH

to find the sub-programs to run, including the display modes.

HOME

for the directory in which to read the .xscreensaver file.

XENVIRONMENT

to get the name of a resource file that overrides the global resources stored in the RESOURCE_MANAGER property.

The latest version of XScreenSaver, an online version of this manual, and a FAQ can always be found at https://www.jwz.org/xscreensaver/

X(1), Xsecurity(1), xauth(1), xdm(1), gdm(1), xhost(1), systemd(1), elogind(8), xscreensaver-settings(1), xscreensaver-command(1), xscreensaver-systemd(6), xscreensaver-gl-helper(6), xscreensaver-getimage(6), xscreensaver-text(6).

Copyright © 1991-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.

Jamie Zawinski <jwz@jwz.org>

Please let me know if you find any bugs or make any improvements.

And a huge thank you to the hundreds of people who have contributed, in large ways and small, to the XScreenSaver collection over the past three decades!

abstractile(6), anemone(6), anemotaxis(6), antinspect(6), antmaze(6), antspotlight(6), apollonian(6), apple2(6), atlantis(6), attraction(6), atunnel(6), barcode(6), beats(6), binaryhorizon(6), binaryring(6), blaster(6), blinkbox(6), blitspin(6), blocktube(6), boing(6), bouboule(6), bouncingcow(6), boxed(6), boxfit(6), braid(6), bsod(6), bubble3d(6), bumps(6), cage(6), carousel(6), ccurve(6), celtic(6), chompytower(6), circuit(6), cityflow(6), cloudlife(6), companioncube(6), compass(6), coral(6), covid19(6), crackberg(6), crumbler(6), crystal(6), cube21(6), cubenetic(6), cubestack(6), cubestorm(6), cubetwist(6), cubicgrid(6), cubocteversion(6), cwaves(6), cynosure(6), dangerball(6), decayscreen(6), deco(6), deepstars(6), deluxe(6), demon(6), discoball(6), discrete(6), distort(6), drift(6), droste(6), dymaxionmap(6), endgame(6), energystream(6), engine(6), epicycle(6), eruption(6), esper(6), etruscanvenus(6), euler2d(6), extrusion(6), fadeplot(6), fiberlamp(6), filmleader(6), fireworkx(6), flame(6), flipflop(6), flipscreen3d(6), fliptext(6), flow(6), fluidballs(6), flurry(6), flyingtoasters(6), fontglide(6), fuzzyflakes(6), galaxy(6), gears(6), geodesic(6), geodesicgears(6), gflux(6), gibson(6), glblur(6), glcells(6), gleidescope(6), glhanoi(6), glitchpeg(6), glknots(6), glmatrix(6), glplanet(6), glschool(6), glslideshow(6), glsnake(6), gltext(6), goop(6), grav(6), gravitywell(6), greynetic(6), halftone(6), halo(6), handsy(6), headroom(6), helix(6), hexadrop(6), hexstrut(6), hextrail(6), highvoltage(6), hilbert(6), hopalong(6), hydrostat(6), hypertorus(6), hypnowheel(6), ifs(6), imsmap(6), interaggregate(6), interference(6), intermomentary(6), jigglypuff(6), jigsaw(6), juggler3d(6), julia(6), kaleidocycle(6), kallisti(6), klein(6), kumppa(6), lament(6), lavalite(6), lcdscrub(6), lockward(6), loop(6), m6502(6), mapscroller(6), marbling(6), maze(6), maze3d(6), memscroller(6), menger(6), metaballs(6), mirrorblob(6), moebius(6), moebiusgears(6), moire(6), moire2(6), molecule(6), morph3d(6), mountain(6), munch(6), nakagin(6), nerverot(6), noof(6), noseguy(6), pacman(6), papercube(6), pedal(6), peepers(6), penetrate(6), penrose(6), petri(6), phosphor(6), photopile(6), piecewise(6), pinion(6), pipes(6), polyhedra(6), polyominoes(6), polytopes(6), pong(6), popsquares(6), projectiveplane(6), providence(6), pulsar(6), pyro(6), qix(6), quasicrystal(6), queens(6), raverhoop(6), razzledazzle(6), rdbomb(6), ripples(6), rocks(6), romanboy(6), rorschach(6), rotzoomer(6), rubik(6), rubikblocks(6), sballs(6), scooter(6), shadebobs(6), sierpinski(6), sierpinski3d(6), skulloop(6), skytentacles(6), slidescreen(6), slip(6), sonar(6), speedmine(6), sphereeversion(6), spheremonics(6), splitflap(6), splodesic(6), spotlight(6), sproingies(6), squiral(6), squirtorus(6), stairs(6), starfish(6), starwars(6), stonerview(6), strange(6), substrate(6), superquadrics(6), surfaces(6), swirl(6), tangram(6), tessellimage(6), timetunnel(6), topblock(6), triangle(6), tronbit(6), truchet(6), twang(6), unicrud(6), unknownpleasures(6), vermiculate(6), vfeedback(6), vidwhacker(6), vigilance(6), voronoi(6), wander(6), webcollage(6), whirlwindwarp(6), winduprobot(6), wormhole(6), xanalogtv(6), xautolock.1x(1), xdaliclock(1), xflame(6), xjack(6), xlyap(6), xmatrix(6), xrayswarm(6), xscreensaver-auth(6), xscreensaver-command(1), xscreensaver-getimage(6), xscreensaver-getimage-file(6), xscreensaver-getimage-video(6), xscreensaver-gfx(6), xscreensaver-gl-visual(6), xscreensaver-settings(1), xscreensaver-systemd(6), xscreensaver-text(6), xspirograph(6), zoom(6).