This repository has been archived on 2025-02-01. You can view files and clone it, but cannot push or open issues or pull requests.
alock/README
mathias 4d645e3464 * updated documentation
* updated buildsystem, scons install works
* rewritten README to be also in asciidoc-format

--HG--
extra : convert_revision : svn%3Aeebe1cee-a9af-4fe4-bd26-ad572b19c5ab/trunk%4029
2005-05-24 09:00:26 +00:00

76 lines
2.2 KiB
Text

alock - README
==============
Mathias Gumz <akira@fluxbox.org>
v1.0, 24 May 2005
About
-----
'alock' locks your current session in X. It's not a full featured
screensaver distribution like 'xlockmore' or 'xscreensaver', but just a
tiny locker: "uh, i need coffee .. so i need a lock" ..
You can modify the way you have to authenitificate yourself, the way the
mousepointer looks when you locked the display and the way the content of
the display is handled. Eg: with -bg none you can see whats going on,
even when you are not able to modify what you see, which might be pretty
usefull for public terminals where a demo should run but noone should
press any buttons or keys (you know those little kids ... )
Installation
------------
To install / compile 'alock' you need 'scons':
* link:http://www.scons.org[scons]
It's a clever buildsystem which i prefer over make/autotools.
After installing 'scons' you just type:
$> scons
and it should build your personal version of 'alock'.
You can influence the build-process by some variables, check
$> scons -h
To install it finally to your system use:
$> scons install
and thats it.
If you grabed a svn-version (not a release-tarball) you also need
'asciidoc' and 'xmlto' to create the documentation-files:
* link:http://www.methods.co.nz/asciidoc/[AsciiDoc]
* link:http://cyberelk.net/tim/xmlto/[xmlto]
Tested platforms (so far):
* gentoo-linux (pc and ppc with gcc3.4.3)
* freebsd5.3 (pc gcc3.4.2)
* slackware (pc, gcc3.3.5, shadow)
Usage
-----
You find more info about how to use 'alock' in the alock-documentation:
$> less alock.txt
$> man alock
$> firefox alock.html
History
-------
An irc-buddy of mine (izhirahider) was using 'xtrlock' and had some
problems with it .. no wonder, development stopped some years ago
and it doesnt support 'pam'. Since i liked the minimalism of 'xtrlock'
but wanted to add some minor things to it i forked 'alock' from
'xtrlock' and modified it a bit :) At the moment there is almost no code
from 'xtrlock' left.
Author / Contributors
---------------------
* 2005 Mathias Gumz aka akira <akira@fluxbox.org> (code)
* 1993 - 1994 Ian Jackson (xtrlock)
* 2005 Tenner (alock-logo)
* 2001-2005 Fluxbox-Team (fluxbox-logo)
* 2005 Pekwm-Team (pekwm-logo)