diff --git a/CHANGELOG b/CHANGELOG index 5f11483..e03de19 100644 --- a/CHANGELOG +++ b/CHANGELOG @@ -1,5 +1,9 @@ Version 0.5 +2005-05-14: + + * started documention, using asciidoc + 2005-05-09: * changed project-name to 'alock': diff --git a/README b/README index cf7c0db..b91b3d0 100644 --- a/README +++ b/README @@ -14,8 +14,8 @@ '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 .. lock" .. speaking of size: binary takes - only 11kb. 'alock' shows the content of the locked screen .. so you can + 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 diff --git a/alock.1 b/alock.1 deleted file mode 100644 index 84a05cd..0000000 --- a/alock.1 +++ /dev/null @@ -1,54 +0,0 @@ -.TH ALOCK 1 -.SH NAME -alock \- Lock X display until password supplied -.SH SYNOPSIS -.B alock -.SH DESCRIPTION -.B alock -locks the X server till the user enters their password at the keyboard. - -While -.B alock -is running, the mouse and keyboard are grabbed and the mouse cursor -becomes a padlock. Output displayed by X programs, and windows put up -by new X clients, continue to be visible, and any new output is -displayed normally, except you run in -blank mode. Then the content -of the Screen is hidden behind a black Window. - -The mouse and keyboard are returned when the user types their -password, followed by Enter or Newline. If an incorrect password is -entered the bell is sounded. Pressing Backspace or Delete erases one -character of a password partially typed; pressing Escape or Clear -clears anything that has been entered. - -If too many attempts are made in too short a time further keystrokes -generate bells and are otherwise ignored until a timeout has expired. - -The X server screen saver continues to operate normally; if it comes -into operation the display may be restored by the usual means of -touching a key (Shift, for example) or the mouse. -.SH OPTIONS, X RESOURCES, CONFIGURATION -None. -.SH BUGS -Additional input devices other than the keyboard and mouse are not -disabled. - -The timeouts, bitmaps and mouse cursor colour cannot be modifed. -.SH SEE ALSO -.BR X "(1), " xlock "(1), Xlib Documentation." -.SH AUTHOR -Mathias Gumz -Ian Jackson -.SH COPYRIGHT -Copyright (C) 2005 Mathias Gumz -Copyright (C) 1993, 1994 by Ian Jackson. - -Permission to use, copy, modify and distribute this software and its -documentation is granted under the terms of the GNU General Public -Licence, version 2 or later, as published by the Free Software -Foundation. - -This program is distributed in the hope that it will be useful, but -WITHOUT ANY WARRANTY; without even the implied warranty of -MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU -General Public License for more details. diff --git a/alock.txt b/alock.txt new file mode 100644 index 0000000..7cbe9a8 --- /dev/null +++ b/alock.txt @@ -0,0 +1,65 @@ +ALOCK(1) +======== +Mathias Gumz +v0.5, ?? May 2005 + +NAME +---- +alock - locks the local X display until a password is entered. + +SYNOPSIS +-------- +'alock' [-h] [-v] [-bg type:opts] [-cursor type:opts] [-auth type:opts] + +DESCRIPTION +----------- +alock locks the X server till the user enters a password at the +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' +and never will. Its just for locking the current X session. + +OPTIONS +------- +-h :: + Print a short help +-v :: + Print the version number + +-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 + +-bg type:options :: + Define the type of alock should handle the background: + + 'none' - you can see everything like it is + 'blank' +-cursor type:options :: + Define the look-a-like of the cursor/mouse pointer + +AUTHOR +------ +Written by Mathias Gumz + +RESOURCES +--------- + +Web site: http://darkshed.net + +COPYING +------- +Copyright (C) 2005 Mathias Gumz. Free use of this software is +granted under the terms of the GNU General Public License (GPL).