.\"                                      Hey, EMACS: -*- nroff -*-
.\" First parameter, NAME, should be all caps
.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
.\" other parameters are allowed: see man(7), man(1)
.TH LSH-PAM-CHECKPW 8 "Jul 05 2002" lsh-pam-checkpw "lsh manuals"
.\" Please adjust this date whenever revising the manpage.
.\"
.\" Some roff macros, for reference:
.\" .nh        disable hyphenation
.\" .hy        enable hyphenation
.\" .ad l      left justify
.\" .ad b      justify to both left and right margins
.\" .nf        disable filling
.\" .fi        enable filling
.\" .br        insert line break
.\" .sp <n>    insert n+1 empty lines
.\" for manpage-specific macros, see man(7)
.SH NAME
lsh-pam-checkpw \- program to check a PAM username/password combination
.SH SYNOPSIS
.B lsh-pam-checkpw
.RI username-to-check
.SH DESCRIPTION
This manual page documents briefly the
.B lsh-pam-checkpw
command.
This manual page was written for the Debian distribution
because the original program does not have a manual page.
Instead, it has documentation in the GNU Info format; see below.
.PP
.\" TeX users may be more comfortable with the \fB<whatever>\fP and
.\" \fI<whatever>\fP escape sequences to invode bold face and italics, 
.\" respectively.
\fBlsh-pam-checkpw\fP is a program that checks if a username and password
combination is valid for login by doing a PAM lookup. It is designed to be
used as a password helper program for \fBlshd (8)\fP, (eg.
\fB\-\-password\-helper=/usr/sbin/lsh-pam-checkpw\fP.
.PP
.B lsh-pam-checkpw
takes one required argument, which is the username, and reads the password from
stdin, then returns 0 if the password is valid, or 1 otherwise. Note that the
password must be supplied exactly, ie. there must be no newline after the
password, so if invoking from a shell, just type "<your-password><CTRL-D>".
.SH SEE ALSO
.BR lsh (1),
.BR lshd (8).
.BR
The programs are documented fully by
.IR "Lsh" ,
available via the Info system.
.SH AUTHOR
This manual page was written by Timshel Knoll <timshel@debian.org>,
for the Debian GNU/Linux system (but may be used by others).