tschwery/alock
Archived
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

* updated documentation

Browse source 
* 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
This commit is contained in:
mathias 2005-05-24 09:00:26 +00:00
parent c8a3e4fb82
commit 4d645e3464
4 changed files with 134 additions and 79 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
CHANGELOG
View file

@ -2,6 +2,9 @@ Version 1.0
2005-05-24:
* updated documentation
* updated buildsystem, scons install works
* rewritten README to be also in asciidoc-format
* more consistency in the ui, updated documentation
* added -auth md5:file=<filename>
* added -auth sha1:file=<filename>

113
README
View file

@ -1,77 +1,76 @@
-+------------------------------------------------------------------+-
alock - a slim screenlocker for X
-+------------------------------------------------------------------+-
alock - README
==============
Mathias Gumz <akira@fluxbox.org>
v1.0, 24 May 2005
1. about
2. installation
3. usage
4. todo
5. author
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':
1. about
--------
* link:http://www.scons.org[scons]
'alock' locks your current session in X. its not a fullfeatured
screensaver-distribution like 'xlockmore' or 'xscreensaver' but just a
tiny locker: "uh, i need coffee .. so i need a lock" .. speaking of size:
binary takes only 11kb. 'alock' shows the content of the locked screen .. so you can
see whats going on, even when you are not able to modify what you see.
this is pretty usefull for public terminals where a demo should run which
shouldnt interupted (you know those little kids who press every button and
click everywhere ...).
It's a clever buildsystem which i prefer over make/autotools.
After installing 'scons' you just type:
an irc-friend of mine (izhirahider) is using 'xtrlock' and had some
problems with it .. no wonder, development stopped some years ago
and it doesnt support pam. since i like the minimalism of 'xtrlock'
but wanted to add some minor things to it i "forked" 'alock' from
'xtrlock' and modified it a bit :)
$> scons
2. installation
---------------
and it should build your personal version of 'alock'.
You can influence the build-process by some variables, check
to install / compile 'alock' you need 'scons':
$> scons -h
http://www.scons.org
To install it finally to your system use:
its a clever buildsystem which i prefer over make/autotools.
after installing 'scons' you just type:
$> scons install
$> scons
and thats it.
If you grabed a svn-version (not a release-tarball) you also need
'asciidoc' and 'xmlto' to create the documentation-files:
and it should build your personal version of 'alock'
you can influence the build-process by some variables, check
* link:http://www.methods.co.nz/asciidoc/[AsciiDoc]
* link:http://cyberelk.net/tim/xmlto/[xmlto]
$> scons -h
Tested platforms (so far):
to finally install it to your system use:
* gentoo-linux (pc and ppc with gcc3.4.3)
* freebsd5.3 (pc gcc3.4.2)
* slackware (pc, gcc3.3.5, shadow)
$> scons install
Usage
-----
You find more info about how to use 'alock' in the alock-documentation:
and thats it.
$> less alock.txt
$> man alock
$> firefox alock.html
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)
3. usage
--------
you find more info about how to use 'alock' in the alock.txt-file. that
file is used to create all the other documentation-formats provided.
4. todo
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.
- better documentation, updated manpage
- check on irix, sun, hp etc etc
Author / Contributors
---------------------
* 2005 Mathias Gumz aka akira <akira@fluxbox.org> (code)
* 1993 - 1994 Ian Jackson (xtrlock)
5. author
---------
* 2005 Tenner (alock-logo)
* 2001-2005 Fluxbox-Team (fluxbox-logo)
* 2005 Pekwm-Team (pekwm-logo)
2005 mathias gumz aka akira < akira at fluxbox dot org>
1993 - 1994 ian jackson (xtrlock)

79
SConstruct
View file

@ -6,13 +6,31 @@
##########################################################
import sys
import os
alock_version = '0.9'
alock_name = 'alock'
alock_version = '1.0'
alock_optfile = [ 'scons.opts', 'user.opts' ]
alock_target = 'src/alock'
alock_meta_files = [
'README',
'CHANGELOG',
'LICENSE',
'alock.txt',
'alock.html' ]
alock_contrib_files = [
'contrib/README',
'contrib/xcursor-fluxbox',
'contrib/xcursor-pekwm' ]
alock_manpage = 'alock.1'
alock_doc_files = [
'alock.html',
'alock.1' ]
Default(alock_target)
SConsignFile()
alock_options = Options(alock_optfile)
alock_options.AddOptions(
@ -31,7 +49,8 @@ alock_options.AddOptions(
BoolOption('amd5', 'build a little md5-helper', 0),
BoolOption('asha1', 'build a little sha1-helper', 0),
PathOption('prefix', 'install-path base', '/usr/local')
PathOption('PREFIX', 'install-path base', '/usr/local'),
PathOption('DESTDIR', 'install to $DESTDIR/$PREFIX', '/')
)
alock_env = Environment(options = alock_options,
@ -42,7 +61,17 @@ Help(alock_options.GenerateHelpText(alock_env))
###########################################################
#
# installpaths
alock_instdir = os.path.join('$DESTDIR','$PREFIX')
alock_instdir_bin = os.path.join(alock_instdir,'bin')
alock_instdir_data = os.path.join(alock_instdir,'share')
alock_instdir_meta = os.path.join(alock_instdir_data, alock_name + '-' + alock_version)
alock_instdir_meta_contrib = os.path.join(alock_instdir_meta, 'contrib')
alock_instdir_man = os.path.join(alock_instdir_data, os.path.join('man', 'man1'))
###########################################################
#
# configuring
if sys.platform == "linux2" or sys.platform == "linux-i386":
alock_env.AppendUnique(
@ -152,23 +181,45 @@ Default(default_targets)
alock_options.Save('scons.opts', alock_env)
alock_program = SConscript(
'src/SConscript',
exports = ['alock_env']
)
alock_env.Install(
alock_env['prefix']+'/bin',
alock_program
)
############################################################################
#
# building
alock_env.Alias(
'install',
alock_env['prefix']+'/bin'
)
alock_program = SConscript( 'src/SConscript', exports = ['alock_env'])
def createManPage(target, source, env):
os.system('asciidoc -d manpage -b docbook -o alock.xml ' + str(source[0]))
os.system('xmlto man alock.xml')
os.remove('alock.xml')
return None
def createHtml(target, source, env):
os.system('asciidoc -d manpage -b xhtml -o ' + str(target[0]) + ' ' +
str(source[0]))
alock_env.Command('alock.1', 'alock.txt', createManPage)
alock_env.Command('alock.html', 'alock.txt', createHtml)
############################################################################
#
# installing
alock_env.Install(alock_instdir_bin, alock_target)
alock_env.Install(alock_instdir_meta, alock_meta_files)
alock_env.Install(alock_instdir_man, alock_manpage)
alock_env.Install(alock_instdir_meta_contrib, alock_contrib_files)
# TODO: add a "scons dist" command which builds a propper tarball
#alock_env.Alias('dist', alock_env.Tar(alock_target + '-' + alock_version,
# alock_distfiles))
############################################################################
#
# aliases
alock_env.Alias('docs', alock_doc_files)
alock_env.Alias('install', alock_instdir)
# vim:ft=python

18
alock.txt
View file

@ -84,15 +84,17 @@ Written by Mathias Gumz <akira at fluxbox dot org>
RESOURCES
---------
Web site: http://darkshed.net
Other lockers ::
- xlockmore http://www.tux.org/~bagleyd/xlockmore.html
- xscreensaver http://www.jwz.org/xscreensaver/
- xtrlock ftp://ftp.debian.org/debian/dists/stable/main/source/x11/
- vlock ftp://ftp.ibiblio.org/pub/Linux/utils/console/
- lockvc ftp://ftp.ibiblio.org/pub/Linux/utils/console/
link:http://darkshed.net[Home]
Other Lockers ::
- link:http://www.tux.org/~bagleyd/xlockmore.html[xlockmore]
- link:http://www.jwz.org/xscreensaver/[xscreensaver]
- link:ftp://ftp.debian.org/debian/dists/stable/main/source/x11/[xtrlock]
- link:ftp://ftp.ibiblio.org/pub/Linux/utils/console/[vlock]
- link:ftp://ftp.ibiblio.org/pub/Linux/utils/console/[lockvc]
COPYING
-------
Copyright (C) 2005 Mathias Gumz. Free use of this software is
granted under the terms of the GNU General Public License (GPL).
granted under the terms of the MIT. See LICENSE provided in the
distribution.