DeforaOS/Locker
DeforaOS/Locker
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
477 Commits 1 Branch 8 Tags 531 KiB
C 91%
Shell 9%
master
Go to file
Pierre Pronchery 0e87608737 tests: help the clint test pass with -I../include 
It is still unable to find Gtk+ though.
2022-09-21 04:34:47 +02:00
data Rename the desktop files 2021-01-21 04:05:31 +01:00
doc doc/gtkdoc: ignore the files generated 2022-09-21 04:14:27 +02:00
include Code cleanup 2020-02-03 07:18:46 +01:00
po Import the newer scripts from DeforaOS configure 2020-11-19 03:15:47 +01:00
src Update the copyright notice 2022-09-19 21:24:44 +02:00
tests tests: help the clint test pass with -I../include 2022-09-21 04:34:47 +02:00
tools Rely on the compatibility code of libDesktop 2022-09-19 21:24:28 +02:00
.gitignore Register new targets 2022-07-10 07:46:57 +02:00
COPYING Re-license under the BSD 2-clause license 2018-12-30 00:14:45 +01:00
project.conf tests: import the clint, fixme, and xmllint tests 2022-09-21 04:26:18 +02:00
README.md README.md: document how to extend Locker 2022-07-10 07:10:25 +02:00

README.md

DeforaOS Locker

About Locker

Locker is a screensaver.

It can be extended through authentication backends, additional animations, and general-purpose plug-ins.

Locker is part of the DeforaOS Project, found at https://www.defora.org/.

Compiling Locker

Locker depends on the following components:

  • Gtk+ 2.4 or later, or Gtk+ 3.0 or later
  • DeforaOS libDesktop
  • an implementation of make
  • gettext (libintl) for translations
  • DocBook-XSL for the manual pages
  • GTK-Doc for the API documentation

With these installed, the following command should be enough to compile and install Locker on most systems:

$ make install

To install (or package) Locker in a different location, use the PREFIX option as follows:

$ make PREFIX="/another/prefix" install

Locker also supports DESTDIR, to be installed in a staging directory; for instance:

$ make DESTDIR="/staging/directory" PREFIX="/another/prefix" install

The compilation process supports a number of other options, such as OBJDIR for compilation outside of the source tree for instance.

On some systems, the Makefiles shipped may have to be re-generated accordingly. This can be performed with the DeforaOS configure tool.

Documentation

Manual pages for each of the executables installed are available in the doc folder. They are written in the DocBook-XML format, and need libxslt and DocBook-XSL to be installed for conversion to the HTML or man file format.

Likewise, the API reference for Locker (plug-ins) is available in the doc/gtkdoc folder, and is generated using gtk-doc.

Extending Locker

Plug-ins for the Locker program can be written according to the API definitions installed and found in <Desktop/Locker/*.h> (in the source code in the include/Locker/*.h files).

Sample plug-ins can be found in src/auth/template.c, src/demos/template.c, and src/plugins/template.c.

Further plug-ins may also be found in the DeforaOS Integration project.

Distributing Locker

DeforaOS Locker is subject to the terms of the 2-clause BSD license. Please see the COPYING file for more information.