vlock: Add manpage
authorAlexey Gladkov <gladkov.alexey@gmail.com>
Mon, 5 Dec 2011 22:36:28 +0000 (02:36 +0400)
committerAlexey Gladkov <gladkov.alexey@gmail.com>
Mon, 5 Dec 2011 22:36:28 +0000 (02:36 +0400)
Signed-off-by: Alexey Gladkov <gladkov.alexey@gmail.com>
man/man1/vlock.1 [new file with mode: 0644]

diff --git a/man/man1/vlock.1 b/man/man1/vlock.1
new file mode 100644 (file)
index 0000000..452837a
--- /dev/null
@@ -0,0 +1,49 @@
+.TH VLOCK 1 "16 May 1996" "Linux User's Manual"
+.SH NAME
+vlock \- Virtual Console lock program
+.SH SYNOPSIS
+.B vlock
+.PP
+.B vlock [ -a,--all ] [ -c,--current ] [ -h,--help ] [ -v,--version ]
+.SH DESCRIPTION
+.B vlock
+is a program to lock one or more sessions on the Linux console.  This is
+especially useful for Linux machines which have multiple users with access
+to the console.  One user may lock his or her session(s) while still allowing
+other users to use the system on other virtual consoles.  If desired, the
+entire console may be locked and virtual console switching disabled.
+.PP
+By default, only the current VC (virtual console) is locked.  With the
+\fB-a,-all\fR option all VCs are locked.  The locked VCs cannot be unlocked
+without the invoker's password.  And, for the paranoid,
+vlock makes it a trying experience for those attempting to guess the
+password, so unauthorized access to session(s) is highly unlikely.
+.PP
+Please note that it is entirely possible to completely lock yourself out of
+the console with the \fB-a,--all\fR option if you cannot remember your
+password!  Unless you are able to kill vlock by logging in remotely via a
+serial terminal or network, a hard reset is the only method of ``unlocking''
+the display.
+.PP
+\fBvlock\fR works for console sessions primarily.  However, there is
+support for trying to lock non-console sessions as well, but that
+support has not been well tested.
+.SH OPTIONS
+.B -a,--all
+.IP
+Lock all console sessions and disable VC switching.
+.PP
+.B -c,--current
+.IP
+Lock the current session (this is the default).
+.PP
+.B -h,--help
+.IP
+Print a brief help message.
+.PP
+.B -v,--version
+.IP
+Print the version number of \fBvlock\fR.
+.PP
+.SH AUTHOR
+Michael K. Johnson <johnsonm@redhat.com>