Difference between revisions of "XScreenSaver"

From ArchWiki
Jump to: navigation, search
m (LXDM)
m (xscreensaver-command uses the X convention of a single dash before options, not double dash)
 
(116 intermediate revisions by 31 users not shown)
Line 1: Line 1:
[[Category:X Server]]
+
[[Category:X server]]
XScreenSaver is a screen saver and locker for the X Window System.
+
[[es:XScreenSaver]]
[[es:Xscreensaver]]
+
[[it:XScreenSaver]]
[[it:Xscreensaver]]
+
[[ja:XScreenSaver]]
[[zh-CN:Xscreensaver]]
+
[[zh-hans:XScreenSaver]]
==Installing XScreenSaver==
+
{{Related articles start}}
[[pacman|Install]] the {{Pkg|xscreensaver}} package found in the [[Official Repositories|official repositories]].
+
{{Related|DPMS}}
 +
{{Related|Xresources}}
 +
{{Related|List of applications#Screen lockers}}
 +
{{Related articles end}}
  
Alternatively, there is a patched version with the Arch Linux logo in the [[Arch User Repository|AUR]] named {{AUR|xscreensaver-arch-logo}}. Running this package instead of the one available in the [[Official Repositories|official repositories]] is advantageous for several reasons:
+
[https://www.jwz.org/xscreensaver/ XScreenSaver] is a screen saver and locker for the X Window System.
# Since [[makepkg]] is compiling it from source code, the resulting package will contain processor-specific optimizations unique to ''your'' specific system -- assuming you set up your {{ic|/etc/makepkg.conf}} with the appropriate [http://en.gentoo-wiki.com/wiki/Safe_Cflags#Processor_Specific_CFLAGS CFLAGS] and CXXFLAGS.
 
# This package is Arch-branded (screensavers, lock screen, etc.)
 
# If running [[GNOME]], this package will provide an icon to enter the XScreenSaver preferences under System>Preferences>Screensaver whereas the package in the [[Official Repositories|official repositories]] does not.
 
  
==Configuring XScreenSaver==
+
== Installation ==
Global options are defined in {{ic|/usr/share/X11/app-defaults/XScreenSaver}}.  Under a standard setup, there is likely no need to edit this file.  Instead most options are configured on a user-by-user basis simply by running xscreensaver-demo
 
  
  $ xscreensaver-demo
+
[[Install]] the {{Pkg|xscreensaver}} package.
 +
 
 +
For an Arch Linux branded experience, install the {{AUR|xscreensaver-arch-logo}} package.
 +
 
 +
== Configuration  ==
 +
 
 +
Most options are configured on a user-by-user basis by running ''xscreensaver-demo''. ''xscreensaver-demo'' writes the chosen configuration to {{ic|~/.xscreensaver}}, discarding any manual modifications to the file. Global options are defined in {{ic|/usr/share/X11/app-defaults/XScreenSaver}}.
 +
 
 +
Since at least XScreenSaver 5.22, there is another way to edit XScreenSaver's user configuration, using [[Xresources]]. This includes theming support. See [https://gist.github.com/anonymous/682d8daf5631b588e12e] for the version 5.22 defaults.
 +
 
 +
=== DPMS and blanking settings ===
 +
 
 +
{{Style|"overrides DPMS" is vague - xscreensaver does the equivalent of {{ic|xset s 0 0}}, uses its own timer for the various animations, but sets the DPMS timeout to the values in ''Display Power Management''}}
 +
 
 +
XScreenSaver manages screen blanking and display energy saving ([[DPMS]]) independently of X itself and overrides it. To configure the timings for blanking, standby, display poweroff and such, use ''xscreensaver-demo'' or edit the configuration file manually, e.g. {{ic|~/.xscreensaver}}:
  
===DPMS settings===
 
XScreenSaver manages display energy saving ([[DPMS]]) independently of X itself and overrides it. To configure the timings for standby, display poweroff and such, use xscreensaver-demo or edit the configuration file manually, e.g. {{ic|~/.xscreensaver}},
 
 
{{bc|
 
{{bc|
 
timeout: 1:00:00
 
timeout: 1:00:00
Line 35: Line 46:
 
}}
 
}}
  
==Starting XScreenSaver==
+
DPMS and screen blanking can be disabled by starting ''xscreensaver-demo'' and, for the ''Mode'' setting, choosing ''Disable Screen Saver''.
 +
 
 +
{{Note|If ''Lock Screen After'' in ''xscreensaver-demo'' is ticked and set to 0 minutes, the screen will be locked immediately upon blanking. If ''Power Manager Enabled'' is unticked, DPMS is disabled; it does not mean that XScreenSaver will relinquish control of DPMS settings.}}
 +
 
 +
== Usage ==
 +
 
 +
{{Tip|To start XScreenSaver without the splash screen, use the {{ic|-no-splash}} switch. See {{man|1|xscreensaver}} for a full list of options.}}
 +
 
 +
In the [[Xfce]], [[LXDE]] and [[LXQt]] environments, XScreenSaver is autostarted automatically if it is available - no further action is required. For other environments, see [[Autostarting]].
 +
 
 +
To immediately trigger {{ic|xscreensaver}}, if it is running, and lock the screen, execute the following command:
 +
 
 +
$ xscreensaver-command -lock
 +
 
 +
=== Lock on suspend ===
 +
 
 +
See [[Power management#xss-lock]]. You may want to set XScreenSaver's fade out time to 0.
  
=== Single-User Systems ===
+
=== User switching from the lock screen ===
Simply [[pacman|installing]] the {{Pkg|xscreensaver}} package is not enough to have it run automatically. The {{ic|xscreensaver}} program has to be started, which is commonly done by the desktop environment via a line in {{ic|~/.xinitrc}} as follows:
 
/usr/bin/xscreensaver -no-splash &
 
  
The ampersand {{ic|&}} argument makes the {{ic|xscreensaver}} program run in the background and is required.
+
{{Warning|When switching users using a display manager such as GDM or LightDM, XScreenSaver will not lock the original session - it can be accessed without a password simply by switching TTY's to the session in question. If you are using LightDM, as a workaround, install {{Pkg|light-locker}} and run it alongside XscreenSaver. Alternatively, use a different screen locking program altogether - see [[List of applications/Security#Screen lockers]].}}
  
{{note|XScreenSaver is automatically started by [[Xfce]] in {{ic|/etc/xdg/xfce4/xinitrc}}, to ensure it gets executed use {{ic|startxfce4}} and not {{ic|xfce4-session}}.
+
By default, XScreenSaver's ''New Login'' button in the lock screen will call {{ic|/usr/bin/gdmflexiserver}} to switch users. Other [[display manager]]s than [[GDM]] or KDM that support user switching (such as [[LightDM]]) require a different command.
  exec startxfce4 --with-ck-launch
+
 
}}
+
{{Tip|Adding ''xscreensaver.newLoginCommand:'' to {{ic|~/.Xresources}} whilst leaving the argument blank will make the ''New Login'' button disappear.}}
 +
 
 +
As modifications in {{ic|~/.xscreensaver}} are [[#Configuration|discarded]] by ''xscreensaver-demo'', {{ic|~/.Xresources}} is used in this section.
 +
 
 +
==== LXDM ====
 +
 
 +
To use LXDM's switching mode:
 +
 
 +
  xscreensaver.newLoginCommand: lxdm -c USER_SWITCH
 +
 
 +
==== LightDM ====
 +
 
 +
To use [[LightDM]]'s switching mode:
  
=== Multi-User Systems ===
+
xscreensaver.newLoginCommand: dm-tool switch-to-greeter
  
If operating with multiple users with a [[Display Manager|display manager]] (e.g. [[SLiM]], [[GDM]], [[KDM]]) it is best to start XScreenSaver via the desktop manager's native screensaver interface. This allows full management of user switching. For example, if using [[GNOME]], install {{Pkg|gnome-screensaver}} and {{Pkg|xscreensaver}} but only have {{ic|gnome-screensaver}} active. This allows for all the screensavers to be selected, and keep the ability for user switching in the event that one user has the screen locked, and another user wants to "switch users" to he/she can access to the box.
+
{{Note|If you use this to switch to an already-logged-in user, you might have to enter the password twice (once for LightDM, and once for the XScreenSaver dialog of the user you logged in to).}}
  
{{Note|Some XScreenSaver native functionality will be lost such as the ability to capture a screen, use photos in a pre-defined path, and/or display custom texts when running the DM's native screensaver with a subset of XScreenSaver's offerings (for example, Flipscreen3D, photopile, etc.)}}
+
== Tips and tricks ==
 +
=== Disable during media playback ===
  
Another option to retain multi-user support, without having to install a second screensaver, is to modify either {{ic|~/.xscreensaver}} for per-user settings, or {{ic|/usr/share/X11/app-defaults/XScreenSaver}} for global settings, and add the following line.
+
==== mplayer/mpv ====
{{bc|newLoginCommand: /usr/bin/gdmflexiserver}}
 
{{Note|The command given is for [[GDM]]; if you are using a different login manager, you will need to replace it with your preferred login manager's command.}}
 
  
==Lock Screen==
+
Add the following to {{ic|~/.mplayer/config}} or {{ic|~/.mpv/config}}:
You may immediately trigger {{ic|xscreensaver}}, if it is running, and lock the screen with the following command:
 
$ xscreensaver-command --lock
 
  
==Disabling XScreenSaver for Media Applications==
 
===MPlayer===
 
Add the following to {{ic|~/.mplayer/config}}
 
 
  heartbeat-cmd="xscreensaver-command -deactivate >&- 2>&- &"
 
  heartbeat-cmd="xscreensaver-command -deactivate >&- 2>&- &"
  
===XBMC===
+
==== Kodi ====
There is no native support within XBMC to disable XScreenSaver (although XBMC does come with its own screensaver). A 3rd party application available in the [[Arch User Repository|AUR]] called {{AUR|caffeine}} does just this. Once running, simply add {{ic|xbmc.bin}} to the list of apps for automatic activation.
 
  
===Adobe Flash/MPlayer/VLC===
+
[[Kodi]] has no native support to disable XScreenSaver (it uses its own screensaver). [[Install]] the {{AUR|kodi-prevent-xscreensaver}} package as a workaround.
There is no native way to disable XScreenSaver for flash, but there is script named [https://github.com/iye/lightsOn lightsOn] that works great and has support for Firefox's Flash plugin, Chromium's Flash plugin, MPlayer, and VLC.
+
 
 +
==== Flash ====
 +
 
 +
There is no native way to disable XScreenSaver for [[Flash]], but there is script named [https://github.com/kodx/lightsOn lightsOn] with support for Firefox's Flash plugin, Chromium's Flash plugin, MPlayer, and VLC.
 +
 
 +
=== Animated wallpaper ===
 +
 
 +
One can run {{ic|xscreensaver}} in the background, just like a wallpaper. First, kill any process that is controlling the background (the root window).
 +
 
 +
Then, locate the desired XScreenSaver executable (typically in {{ic|/usr/lib/xscreensaver/}}) and run it with the {{ic|-root}} flag, for example:
  
==Using XScreenSaver as animated wallpaper==
 
You can run {{ic|xscreensaver}} in the background, just like a wallpaper.
 
First, kill any process that is controlling the background (the root window).
 
Locate the desired XScreenSaver executable (they are usually on {{ic|/usr/lib/xscreensaver/}}) and run it with the {{ic|-root}} flag, like this
 
 
  $ /usr/lib/xscreensaver/glslideshow -root &
 
  $ /usr/lib/xscreensaver/glslideshow -root &
  
===XScreenSaver as wallpaper under xcompmgr===
+
{{Note|If [[xcompmgr]] causes problems, [[install]] the {{AUR|shantz-xwinwrap-bzr}} package, and run:
xcompmgr may cause problems, so you need to use xwinwrap to run it in order to use it as wallpaper. You can find it as {{AUR|shantz-xwinwrap-bzr}} in the [[Arch User Repository|AUR]].
 
  
Run it with the following command:
 
 
  $ xwinwrap -b -fs -sp -fs -nf -ov  -- /usr/lib/xscreensaver/glslideshow -root -window-id WID &
 
  $ xwinwrap -b -fs -sp -fs -nf -ov  -- /usr/lib/xscreensaver/glslideshow -root -window-id WID &
 +
}}
  
==Theming==
+
== Troubleshooting ==
XScreenSaver's unlock screen can be themed with [[X resources]] (see: [[X resources#XScreenSaver_resources|XScreenSaver resources]]).
 
 
 
== User switching from the lock screen ==
 
By default, xscreensaver's "New Login" button in the lock screen will call {{ic|/usr/bin/gdmflexiserver}} to allow for user switching.  This is fine if using gdm or kdm.  Other display managers such as lightdm and lxdm support this functionality as well.
 
 
 
=== LXDM ===
 
Simply paste the following into {{ic|~/.xscreensaver}} to use LXDM's switching mode:
 
  
newLoginCommand: lxdm -c USER_SWITCH
+
You can configure xscreensaver to write to a log file by creating the logfile {{ic|# touch /var/log/xscreensaver.log}} and then specifying its X resource ''logFile''.
 +
{{hc|~/.Xresources|xscreensaver.logFile:/var/log/xscreensaver.log}}
  
=== Lightdm ===
+
To log verbose debugging information to the logFile as well start xscreensaver with the {{ic|-verbose}} command line option, or add this to {{ic|~/.Xresources}}
Simply paste the following into {{ic|~/.xscreensaver}} to use lightdm's switching mode:
+
{{hc|~/.Xresources|<nowiki>xscreensaver.logFile:/var/log/xscreensaver.log
 +
xscreensaver.verbose:true</nowiki>}}
  
newLoginCommand: dm-tool switch-to-greeter
+
== See also ==
  
==See Also==
+
* [http://www.jwz.org/xscreensaver/ Homepage for XScreenSaver]
[http://wiki.gotux.net/downloads/paniclock PanicLock] -- Lock your screen and close any selected programs in background.
 

Latest revision as of 17:05, 20 October 2017

XScreenSaver is a screen saver and locker for the X Window System.

Installation

Install the xscreensaver package.

For an Arch Linux branded experience, install the xscreensaver-arch-logoAUR package.

Configuration

Most options are configured on a user-by-user basis by running xscreensaver-demo. xscreensaver-demo writes the chosen configuration to ~/.xscreensaver, discarding any manual modifications to the file. Global options are defined in /usr/share/X11/app-defaults/XScreenSaver.

Since at least XScreenSaver 5.22, there is another way to edit XScreenSaver's user configuration, using Xresources. This includes theming support. See [1] for the version 5.22 defaults.

DPMS and blanking settings

Tango-edit-clear.pngThis article or section needs language, wiki syntax or style improvements.Tango-edit-clear.png

Reason: "overrides DPMS" is vague - xscreensaver does the equivalent of xset s 0 0, uses its own timer for the various animations, but sets the DPMS timeout to the values in Display Power Management (Discuss in Talk:XScreenSaver#)

XScreenSaver manages screen blanking and display energy saving (DPMS) independently of X itself and overrides it. To configure the timings for blanking, standby, display poweroff and such, use xscreensaver-demo or edit the configuration file manually, e.g. ~/.xscreensaver:

timeout:	1:00:00
cycle:		0:05:00
lock:		False
lockTimeout:	0:00:00
passwdTimeout:	0:00:30
fade:		True
unfade:		False
fadeSeconds:	0:00:03
fadeTicks:	20
dpmsEnabled:	True
dpmsStandby:	2:00:00
dpmsSuspend:	2:00:00
dpmsOff:	4:00:00

DPMS and screen blanking can be disabled by starting xscreensaver-demo and, for the Mode setting, choosing Disable Screen Saver.

Note: If Lock Screen After in xscreensaver-demo is ticked and set to 0 minutes, the screen will be locked immediately upon blanking. If Power Manager Enabled is unticked, DPMS is disabled; it does not mean that XScreenSaver will relinquish control of DPMS settings.

Usage

Tip: To start XScreenSaver without the splash screen, use the -no-splash switch. See xscreensaver(1) for a full list of options.

In the Xfce, LXDE and LXQt environments, XScreenSaver is autostarted automatically if it is available - no further action is required. For other environments, see Autostarting.

To immediately trigger xscreensaver, if it is running, and lock the screen, execute the following command:

$ xscreensaver-command -lock

Lock on suspend

See Power management#xss-lock. You may want to set XScreenSaver's fade out time to 0.

User switching from the lock screen

Warning: When switching users using a display manager such as GDM or LightDM, XScreenSaver will not lock the original session - it can be accessed without a password simply by switching TTY's to the session in question. If you are using LightDM, as a workaround, install light-locker and run it alongside XscreenSaver. Alternatively, use a different screen locking program altogether - see List of applications/Security#Screen lockers.

By default, XScreenSaver's New Login button in the lock screen will call /usr/bin/gdmflexiserver to switch users. Other display managers than GDM or KDM that support user switching (such as LightDM) require a different command.

Tip: Adding xscreensaver.newLoginCommand: to ~/.Xresources whilst leaving the argument blank will make the New Login button disappear.

As modifications in ~/.xscreensaver are discarded by xscreensaver-demo, ~/.Xresources is used in this section.

LXDM

To use LXDM's switching mode:

xscreensaver.newLoginCommand: lxdm -c USER_SWITCH

LightDM

To use LightDM's switching mode:

xscreensaver.newLoginCommand: dm-tool switch-to-greeter
Note: If you use this to switch to an already-logged-in user, you might have to enter the password twice (once for LightDM, and once for the XScreenSaver dialog of the user you logged in to).

Tips and tricks

Disable during media playback

mplayer/mpv

Add the following to ~/.mplayer/config or ~/.mpv/config:

heartbeat-cmd="xscreensaver-command -deactivate >&- 2>&- &"

Kodi

Kodi has no native support to disable XScreenSaver (it uses its own screensaver). Install the kodi-prevent-xscreensaverAUR package as a workaround.

Flash

There is no native way to disable XScreenSaver for Flash, but there is script named lightsOn with support for Firefox's Flash plugin, Chromium's Flash plugin, MPlayer, and VLC.

Animated wallpaper

One can run xscreensaver in the background, just like a wallpaper. First, kill any process that is controlling the background (the root window).

Then, locate the desired XScreenSaver executable (typically in /usr/lib/xscreensaver/) and run it with the -root flag, for example:

$ /usr/lib/xscreensaver/glslideshow -root &
Note: If xcompmgr causes problems, install the shantz-xwinwrap-bzrAUR package, and run:
$ xwinwrap -b -fs -sp -fs -nf -ov  -- /usr/lib/xscreensaver/glslideshow -root -window-id WID &

Troubleshooting

You can configure xscreensaver to write to a log file by creating the logfile # touch /var/log/xscreensaver.log and then specifying its X resource logFile.

~/.Xresources
xscreensaver.logFile:/var/log/xscreensaver.log

To log verbose debugging information to the logFile as well start xscreensaver with the -verbose command line option, or add this to ~/.Xresources

~/.Xresources
xscreensaver.logFile:/var/log/xscreensaver.log
xscreensaver.verbose:true

See also