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

* updated documention

Browse source 
--HG--
extra : convert_revision : svn%3Aeebe1cee-a9af-4fe4-bd26-ad572b19c5ab/trunk%4012
This commit is contained in:
mathias 2005-05-16 17:47:50 +00:00
parent eec4b8f3d7
commit 9caf7ba1f2
3 changed files with 27 additions and 29 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
CHANGELOG
View file

@ -1,5 +1,9 @@
Version 0.5
2005-05-16:
* updated documention
2005-05-14:
* started documention, using asciidoc

15
README
View file

@ -59,19 +59,8 @@
3. usage
--------
alock [-vh] [-blank] [-cursor <theme|xcursor:file>]
[-auth list|<none|passwd|pam|md5:pwdhash>]
-h displays a little help
-v displays version number
-blank hides the content of the screen with a big, black area
-cursor choose between multiple cursors
-auth choose between different authmethods.
after locking 'alock' will show a modified mousecursor. you have to
enter your password blindly. if its the correct password the screen will
unlock.
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
-------

37
alock.txt
View file

@ -14,10 +14,10 @@ SYNOPSIS
DESCRIPTION
-----------
alock locks the X server till the user enters a password at the
keyboard. If the authentification was successful the X server is
keyboard. If the authentification was successful the X server is
unlocked and the user can continue to work.
alock does not provide fancy animations like 'xlock' and 'xscreensaver'
alock does not provide fancy animations like 'xlock' and 'xscreensaver'
and never will. Its just for locking the current X session.
OPTIONS
@ -30,25 +30,30 @@ OPTIONS
-auth type:options ::
Define the type of the authentification, depends strongly on
how alock was built:
'list' - Displays a list of available types
'passwd' - Tries to authentificate against the users system-password.
On systems using 'shadow' alock needs the suid-flag set.
'pam' - Tries to authentificate against the users system-password
using the 'pam-login'-module.
'md5:hash' - alock creates a md5-hash from the entered unlockpassword
and compares it with the hash provided as option
'sha1:hash' - alock creates a sha1-hash from the entered unlockpassword
and compares it with the hash provided as option
'none' - Every 'password' is valid
- list - Displays a list of available types
- passwd - Tries to authentificate against the users system-password.
On systems using 'shadow' alock needs the suid-flag set.
- pam - Tries to authentificate against the users system-password
using the 'pam-login'-module.
- md5:hash - alock creates a md5-hash from the entered unlockpassword
and compares it with the hash provided as option
- sha1:hash - alock creates a sha1-hash from the entered unlockpassword
and compares it with the hash provided as option
- none - Every 'password' is valid
-bg type:options ::
Define the type of alock should handle the background:
- list - Displays a list of available types
- none - you can see everything like it is
- blank:color - fill the background with color
'none' - you can see everything like it is
'blank'
-cursor type:options ::
Define the look-a-like of the cursor/mouse pointer
Define the look-a-like of the cursor/mouse pointer:
- list - Displays a list of available types
- theme:name,bg=color,fg=color
- Use the given internal cursor
- xcursor:file - Use the given cursorfile in xcursor-format
- none - no change to the current cursor
AUTHOR
------