openafs: Improved calling of get-token script

[hcoop/debian/courier-authlib.git] / auth_passwd.3

'\" t
.\"  <!-- Copyright 2004 Double Precision, Inc.  See COPYING for -->
.\"  <!-- distribution information. -->
.\"     Title: auth_passwd
.\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
.\"      Date: 08/25/2013
.\"    Manual: Double Precision, Inc.
.\"    Source: Double Precision, Inc.
.\"  Language: English
.\"
.TH "AUTH_PASSWD" "3" "08/25/2013" "Double Precision, Inc." "Double Precision, Inc."
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
auth_passwd \- Change account\*(Aqs password
.SH "SYNOPSIS"
.sp
.nf
#include <courierauth\&.h>
.fi
.HP \w'int\ rc=auth_passwd('u
.BI "int rc=auth_passwd(const\ char\ *" "service" ", const\ char\ *" "username" ", const\ char\ *" "oldpassword" ", const\ char\ *" "newpassword" ");"
.SH "DESCRIPTION"
.PP
If
\fIusername\fR\*(Aqs password is
\fIoldpassword\fR, it is replaced with
\fInewpassword\fR\&.
\fIservice\fR
identifies which so\-called "service"\*(Aqs password is changed; like
\(lqimap\(rq
or
\(lqpop3\(rq\&. Some Courier authentication library\*(Aqs back\-end module can use different passwords for different services\&.
\fIservice\fR
is ignored if this is not the case\&.
.SH "RETURNS"
.PP
\fBauth_passwd\fR
returns 0 if the password was succesfully changed\&. A non\-0 error code indicates a failure\&.\&.
.SH "SEE ALSO"
.PP
\m[blue]\fB\fBauthlib\fR(3)\fR\m[]\&\s-2\u[1]\d\s+2,
\m[blue]\fB\fBauth_generic\fR(3)\fR\m[]\&\s-2\u[2]\d\s+2,
\m[blue]\fB\fBauth_login\fR(3)\fR\m[]\&\s-2\u[3]\d\s+2,
\m[blue]\fB\fBauth_getuserinfo\fR(3)\fR\m[]\&\s-2\u[4]\d\s+2,
\m[blue]\fB\fBauth_enumerate\fR(3)\fR\m[]\&\s-2\u[5]\d\s+2\&.
.SH "NOTES"
.IP " 1." 4
\fBauthlib\fR(3)
.RS 4
\%[set $man.base.url.for.relative.links]/authlib.html
.RE
.IP " 2." 4
\fBauth_generic\fR(3)
.RS 4
\%[set $man.base.url.for.relative.links]/auth_generic.html
.RE
.IP " 3." 4
\fBauth_login\fR(3)
.RS 4
\%[set $man.base.url.for.relative.links]/auth_login.html
.RE
.IP " 4." 4
\fBauth_getuserinfo\fR(3)
.RS 4
\%[set $man.base.url.for.relative.links]/auth_getuserinfo.html
.RE
.IP " 5." 4
\fBauth_enumerate\fR(3)
.RS 4
\%[set $man.base.url.for.relative.links]/auth_enumerate.html
.RE