hcoop release
[hcoop/debian/courier-authlib.git] / authtest.1
CommitLineData
b0322a85 1'\" t
d9898ee8 2.\" <!-- Copyright 2004 Double Precision, Inc. See COPYING for -->
3.\" <!-- distribution information. -->
4.\" Title: authtest
0e333c05
CE
5.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
6.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
7.\" Date: 09/08/2017
d9898ee8 8.\" Manual: Double Precision, Inc.
9.\" Source: Double Precision, Inc.
b0322a85 10.\" Language: English
d9898ee8 11.\"
0e333c05 12.TH "AUTHTEST" "1" "09/08/2017" "Double Precision, Inc." "Double Precision, Inc."
b0322a85
CE
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.\" -----------------------------------------------------------------
d9898ee8 25.\" disable hyphenation
26.nh
27.\" disable justification (adjust text to left margin only)
28.ad l
b0322a85
CE
29.\" -----------------------------------------------------------------
30.\" * MAIN CONTENT STARTS HERE *
31.\" -----------------------------------------------------------------
d9898ee8 32.SH "NAME"
b0322a85 33authtest \- Test the Courier Authentication Library
d9898ee8 34.SH "SYNOPSIS"
b0322a85 35.HP \w'\fBauthtest\fR\ 'u
d9898ee8 36\fBauthtest\fR {loginid} [password] [newpassword]
37.SH "DESCRIPTION"
38.PP
d9898ee8 39\fBauthtest\fR
b0322a85 40is a command\-line diagnostic utility for the Courier Authentication Library\&.
d9898ee8 41\fBauthtest\fR
42requires at least one argument:
b0322a85 43\fIloginid\fR\&.
d9898ee8 44\fBauthtest\fR
b0322a85 45sends the authentication request to the Courier Authentication Library, then displays the results\&. Only root may use
d9898ee8 46\fBauthtest\fR
b0322a85 47utility, and the Courier Authentication Library daemon (\fBauthdaemond\fR) must already be started\&.
d9898ee8 48.PP
49If only one argument is provided, the authentication request displays the account information for
b0322a85 50\fIloginid\fR, if found\&.
d9898ee8 51.PP
52If two arguments are provided,
53\fIpassword\fR
54must match
b0322a85 55\fIloginid\fR\*(Aqs existing password\&.
d9898ee8 56.PP
57If three arguments are provided,
b0322a85 58\fIloginid\fR\*(Aqs password is changed to
d9898ee8 59\fInewpassword\fR, but only if
60\fIpassword\fR
b0322a85 61matches the existing psasword\&.
d9898ee8 62.PP
b0322a85 63These three basic authentication requests can be used to troubleshoot the authentication library\*(Aqs configuration\&.