README.md 3.58 KB
Newer Older
Kevin Bowen's avatar
Kevin Bowen committed
1
[![License](https://img.shields.io/badge/License-GPL%20v2-blue.svg)](https://gitlab.xfce.org/apps/xfce4-screensaver/-/blob/master/COPYING)
Perberos's avatar
Perberos committed
2

Kevin Bowen's avatar
Kevin Bowen committed
3 4 5
# xfce4-screensaver

Xfce4-screensaver is a screen saver and locker that aims to have
Perberos's avatar
Perberos committed
6 7
simple, sane, secure defaults and be well integrated with the desktop.

Sean Davis's avatar
Sean Davis committed
8 9 10 11 12
This project is a port of [MATE Screensaver](https://github.com/mate-desktop/mate-screensaver),
itself a port of [GNOME Screensaver](https://gitlab.gnome.org/Archive/gnome-screensaver).
It has been tightly integrated with the Xfce desktop, utilizing Xfce
libraries and the Xfconf configuration backend.

Kevin Bowen's avatar
Kevin Bowen committed
13 14 15 16 17 18 19 20 21 22 23 24 25 26
----

### Features

 - Integration with the Xfce desktop per-monitor wallpaper
 - Locking down of configuration settings via Xfconf
 - Support for XScreensaver screensavers
 - (optional) Integration with ConsoleKit and Systemd
 - DBUS interface for limited control and querying screensaver status
 - Idle time and inhibition state are based on the X11 Screensaver extension
 - Shared styles with LightDM GTK+ Greeter
 - No GNOME or MATE dependencies. Requirements are lightweight and shared with Xfce.
 - Full translation support into many languages
 - User switching
Perberos's avatar
Perberos committed
27

Sean Davis's avatar
Sean Davis committed
28 29 30 31 32 33 34
 - Integration with the Xfce Desktop per-monitor wallpaper
 - Locking down of configuration settings via Xfconf
 - DBUS interface to limited screensaver interaction
 - Full translation support into many languages
 - Shared styles with LightDM GTK+ Greeter
 - Support for XScreensaver screensavers
 - User switching
Perberos's avatar
Perberos committed
35

Kevin Bowen's avatar
Kevin Bowen committed
36
### Known Issues
Perberos's avatar
Perberos committed
37

Sean Davis's avatar
Sean Davis committed
38
 - Allow embedding a keyboard into the window, /embedded-keyboard-enabled, may be non-functional. Onboard crashes when embedded.
Perberos's avatar
Perberos committed
39

Kevin Bowen's avatar
Kevin Bowen committed
40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58
### Homepage

[xfce4-screensaver documentation](https://docs.xfce.org/apps/xfce4-screensaver/start)

### Changelog

See [NEWS](https://gitlab.xfce.org/apps/xfce4-screensaver/-/blob/master/NEWS) for details on changes and fixes made in the current release.

### Source Code Repository

[Xfce4-screensaver source code](https://gitlab.xfce.org/apps/xfce4-screensaver)

### Download a Release Tarball

[Xfce4-screensaver archive](https://archive.xfce.org/src/apps/xfce4-screensaver)
    or
[Xfce4-screensaver tags](https://gitlab.xfce.org/apps/xfce4-screensaver/-/tags)

### Installation
Perberos's avatar
Perberos committed
59 60 61

See the file 'INSTALL'

Kevin Bowen's avatar
Kevin Bowen committed
62 63 64 65 66 67 68 69 70 71 72 73 74 75
From source code repository: 

    % cd xfce4-screensaver
    % ./autogen.sh --prefix=/usr --sysconfdir=/etc
    % make
    % make install

From release tarball:

    % tar xf xfce4-screensaver-<version>.tar.bz2
    % cd xfce4-screensaver-<version>
    % ./configure
    % make
    % make install
Sean Davis's avatar
Sean Davis committed
76

77 78 79 80
You may need to set your PAM auth type if it is not correctly detected.

`--with-pam-auth-type=<auth-type>   specify pam auth type (common or system)`

81 82 83 84 85 86
If you are using bsdauth or shadow auth, then you will need to make sure the
following is done after installation:

    chown root:root $libexecdir/xfce4-screensaver-dialog
    chmod +s $libexecdir/xfce4-screensaver-dialog

Sean Davis's avatar
Sean Davis committed
87 88 89
Example testing configuration:

    ./autogen.sh --disable-static --with-mit-ext --with-console-kit --enable-locking --enable-debug --sysconfdir=/etc
Sean Davis's avatar
Sean Davis committed
90

Kevin Bowen's avatar
Kevin Bowen committed
91
### Reporting Bugs
Perberos's avatar
Perberos committed
92

Kevin Bowen's avatar
Kevin Bowen committed
93
Visit the [reporting bugs](https://docs.xfce.org/apps/xfce4-screensaver/bugs) page to view currently open bug reports and instructions on reporting new bugs or submitting bugfixes.
Perberos's avatar
Perberos committed
94 95 96

In the bug report please include information about your system, if possible:

Simon Steinbeiss's avatar
Simon Steinbeiss committed
97
 - What operating system and version
Simon Steinbeiss's avatar
Simon Steinbeiss committed
98
 - What version of xfce4-screensaver, i.e. the output of the `xfce4-screensaver-command --version` command
Perberos's avatar
Perberos committed
99

Simon Steinbeiss's avatar
Simon Steinbeiss committed
100 101
If you want to debug your installation you may also be able to get meaningful debug output when starting xfce4-screensaver from the debug script:
`./src/debug-screensaver.sh`