Merge branch 'debian'

[hcoop/debian/courier-authlib.git] / authtest.1

.\"  <!-- $Id: authtest.sgml,v 1.4 2007/04/22 15:05:16 mrsam Exp $ -->
.\"  <!-- Copyright 2004 Double Precision, Inc.  See COPYING for -->
.\"  <!-- distribution information. -->
.\"     Title: authtest
.\"    Author: 
.\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/>
.\"      Date: 08/23/2008
.\"    Manual: Double Precision, Inc.
.\"    Source: Double Precision, Inc.
.\"
.TH "AUTHTEST" "1" "08/23/2008" "Double Precision, Inc." "Double Precision, Inc."
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.SH "NAME"
authtest - Test the Courier Authentication Library
.SH "SYNOPSIS"
.HP 9
\fBauthtest\fR {loginid} [password] [newpassword]
.SH "DESCRIPTION"
.PP

\fBauthtest\fR
is a command\-line diagnostic utility for the Courier Authentication Library\.
\fBauthtest\fR
requires at least one argument:
\fIloginid\fR\.
\fBauthtest\fR
sends the authentication request to the Courier Authentication Library, then displays the results\. Only root may use
\fBauthtest\fR
utility, and the Courier Authentication Library daemon (\fBauthdaemond\fR) must already be started\.
.PP
If only one argument is provided, the authentication request displays the account information for
\fIloginid\fR, if found\.
.PP
If two arguments are provided,
\fIpassword\fR
must match
\fIloginid\fR\'s existing password\.
.PP
If three arguments are provided,
\fIloginid\fR\'s password is changed to
\fInewpassword\fR, but only if
\fIpassword\fR
matches the existing psasword\.
.PP
These three basic authentication requests can be used to troubleshoot the authentication library\'s configuration\.