README.md 1.92 KB
Newer Older
Sean Davis's avatar
Sean Davis committed
1 2
Xfce Screensaver
================
Perberos's avatar
Perberos committed
3

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

Sean Davis's avatar
Sean Davis committed
7 8 9 10 11 12 13
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.

Features
========
Perberos's avatar
Perberos committed
14

Sean Davis's avatar
Sean Davis committed
15 16 17 18 19 20 21
 - 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
22 23 24 25

Known Issues
============

Sean Davis's avatar
Sean Davis committed
26
 - Allow embedding a keyboard into the window, /embedded-keyboard-enabled, may be non-functional. Onboard crashes when embedded.
Perberos's avatar
Perberos committed
27 28 29 30 31 32

Installation
============

See the file 'INSTALL'

Simon Steinbeiss's avatar
Simon Steinbeiss committed
33
`./autogen.sh --prefix=/usr --sysconfdir=/etc`
Sean Davis's avatar
Sean Davis committed
34

35 36 37 38
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)`

Sean Davis's avatar
Sean Davis committed
39
(For testing, we are using:
Simon Steinbeiss's avatar
Simon Steinbeiss committed
40
 `./autogen.sh --disable-static --with-mit-ext --with-console-kit --enable-locking --enable-debug --sysconfdir=/etc`
Sean Davis's avatar
Sean Davis committed
41 42
)

Sean Davis's avatar
Sean Davis committed
43
`make && sudo make install`
Perberos's avatar
Perberos committed
44

Perberos's avatar
Perberos committed
45 46 47 48

How to report bugs
==================

49 50
Report bugs on the Xfce Bug Tracker:
    https://bugzilla.xfce.org
Perberos's avatar
Perberos committed
51 52 53 54 55

You will need to create an account if you don't have one already.

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

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

Simon Steinbeiss's avatar
Simon Steinbeiss committed
59 60
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`