debian release
[hcoop/debian/courier-authlib.git] / authtest.1
... / ...
CommitLineData
1'\" t
2.\" <!-- Copyright 2004 Double Precision, Inc. See COPYING for -->
3.\" <!-- distribution information. -->
4.\" Title: authtest
5.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
6.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
7.\" Date: 08/25/2013
8.\" Manual: Double Precision, Inc.
9.\" Source: Double Precision, Inc.
10.\" Language: English
11.\"
12.TH "AUTHTEST" "1" "08/25/2013" "Double Precision, Inc." "Double Precision, Inc."
13.\" -----------------------------------------------------------------
14.\" * Define some portability stuff
15.\" -----------------------------------------------------------------
16.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
17.\" http://bugs.debian.org/507673
18.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
19.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
20.ie \n(.g .ds Aq \(aq
21.el .ds Aq '
22.\" -----------------------------------------------------------------
23.\" * set default formatting
24.\" -----------------------------------------------------------------
25.\" disable hyphenation
26.nh
27.\" disable justification (adjust text to left margin only)
28.ad l
29.\" -----------------------------------------------------------------
30.\" * MAIN CONTENT STARTS HERE *
31.\" -----------------------------------------------------------------
32.SH "NAME"
33authtest \- Test the Courier Authentication Library
34.SH "SYNOPSIS"
35.HP \w'\fBauthtest\fR\ 'u
36\fBauthtest\fR {loginid} [password] [newpassword]
37.SH "DESCRIPTION"
38.PP
39\fBauthtest\fR
40is a command\-line diagnostic utility for the Courier Authentication Library\&.
41\fBauthtest\fR
42requires at least one argument:
43\fIloginid\fR\&.
44\fBauthtest\fR
45sends the authentication request to the Courier Authentication Library, then displays the results\&. Only root may use
46\fBauthtest\fR
47utility, and the Courier Authentication Library daemon (\fBauthdaemond\fR) must already be started\&.
48.PP
49If only one argument is provided, the authentication request displays the account information for
50\fIloginid\fR, if found\&.
51.PP
52If two arguments are provided,
53\fIpassword\fR
54must match
55\fIloginid\fR\*(Aqs existing password\&.
56.PP
57If three arguments are provided,
58\fIloginid\fR\*(Aqs password is changed to
59\fInewpassword\fR, but only if
60\fIpassword\fR
61matches the existing psasword\&.
62.PP
63These three basic authentication requests can be used to troubleshoot the authentication library\*(Aqs configuration\&.