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/alock.txt
mathias faca6bfcb0 * added -bg image:shade=<perc>
* added alock_utils.c, shared code goes to that file

--HG--
extra : convert_revision : svn%3Aeebe1cee-a9af-4fe4-bd26-ad572b19c5ab/trunk%4024
2005-05-23 13:06:27 +00:00

82 lines
3 KiB
Text

ALOCK(1)
========
Mathias Gumz <akira@fluxbox.org>
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:
- list - Displays a list of available types
- none - You can see everything like it is
- blank:color - Fill the background with color
- shade:shade=<perc>,color=<color> - Dims content of the screen and
recolors it.
- image:name,center,scale,tile,color=<color>,shade=<perc> - Use the image <name> and puts it as
the background.
-cursor type:options ::
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, if name == "list" it lists
the available themes
- font:name,bg=<color>,fg=<color> - Use the given glyph of the "cursor"-font, if name ==
"list" it lists the available glyphnames
- xcursor:file - Use the given cursorfile in xcursor-format
- none - no change to the current cursor
AUTHOR
------
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/
COPYING
-------
Copyright (C) 2005 Mathias Gumz. Free use of this software is
granted under the terms of the GNU General Public License (GPL).