From 9caf7ba1f2ae79f11940d12375ee1fae4818a105 Mon Sep 17 00:00:00 2001 From: mathias Date: Mon, 16 May 2005 17:47:50 +0000 Subject: [PATCH] * updated documention --HG-- extra : convert_revision : svn%3Aeebe1cee-a9af-4fe4-bd26-ad572b19c5ab/trunk%4012 --- CHANGELOG | 4 ++++ README | 15 ++------------- alock.txt | 37 +++++++++++++++++++++---------------- 3 files changed, 27 insertions(+), 29 deletions(-) diff --git a/CHANGELOG b/CHANGELOG index e03de19..9c766dd 100644 --- a/CHANGELOG +++ b/CHANGELOG @@ -1,5 +1,9 @@ Version 0.5 +2005-05-16: + + * updated documention + 2005-05-14: * started documention, using asciidoc diff --git a/README b/README index b91b3d0..c18a282 100644 --- a/README +++ b/README @@ -59,19 +59,8 @@ 3. usage -------- - alock [-vh] [-blank] [-cursor ] - [-auth list|] - - -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 ------- diff --git a/alock.txt b/alock.txt index 7cbe9a8..4730c91 100644 --- a/alock.txt +++ b/alock.txt @@ -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 ------