| d9898ee8 |
1 | .\" <!-- $Id: auth_passwd.sgml,v 1.3 2007/04/01 00:21:34 mrsam Exp $ --> |
| 2 | .\" <!-- Copyright 2004 Double Precision, Inc. See COPYING for --> |
| 3 | .\" <!-- distribution information. --> |
| 4 | .\" Title: auth_passwd |
| 5 | .\" Author: |
| 6 | .\" Generator: DocBook XSL Stylesheets v1.72.0 <http://docbook.sf.net/> |
| 7 | .\" Date: 04/06/2007 |
| 8 | .\" Manual: Double Precision, Inc. |
| 9 | .\" Source: Double Precision, Inc. |
| 10 | .\" |
| 11 | .TH "AUTH_PASSWD" "3" "04/06/2007" "Double Precision, Inc." "Double Precision, Inc." |
| 12 | .\" disable hyphenation |
| 13 | .nh |
| 14 | .\" disable justification (adjust text to left margin only) |
| 15 | .ad l |
| 16 | .SH "NAME" |
| 17 | auth_passwd \- Change account's password |
| 18 | .SH "SYNOPSIS" |
| 19 | .sp |
| 20 | .RS 4 |
| 21 | .nf |
| 22 | #include <courierauth.h> |
| 23 | .fi |
| 24 | .RE |
| 25 | .HP 19 |
| 26 | .BI "int rc=auth_passwd(const\ char\ *" "service" ", const\ char\ *" "username" ", const\ char\ *" "oldpassword" ", const\ char\ *" "newpassword" ");" |
| 27 | .SH "DESCRIPTION" |
| 28 | .PP |
| 29 | If |
| 30 | \fIusername\fR's password is |
| 31 | \fIoldpassword\fR, it is replaced with |
| 32 | \fInewpassword\fR. |
| 33 | \fIservice\fR |
| 34 | identifies which so\-called "service"'s password is changed; like |
| 35 | \(lqimap\(rq |
| 36 | or |
| 37 | \(lqpop3\(rq. Some Courier authentication library's back\-end module can use different passwords for different services. |
| 38 | \fIservice\fR |
| 39 | is ignored if this is not the case. |
| 40 | .SH "RETURNS" |
| 41 | .PP |
| 42 | |
| 43 | \fBauth_passwd\fR |
| 44 | returns 0 if the password was succesfully changed. A non\-0 error code indicates a failure.. |
| 45 | .SH "SEE ALSO" |
| 46 | .PP |
| 47 | |
| 48 | \fI\fBauthlib\fR(3)\fR\&[1], |
| 49 | \fI\fBauth_generic\fR(3)\fR\&[2], |
| 50 | \fI\fBauth_login\fR(3)\fR\&[3], |
| 51 | \fI\fBauth_getuserinfo\fR(3)\fR\&[4], |
| 52 | \fI\fBauth_enumerate\fR(3)\fR\&[5]. |
| 53 | .SH "REFERENCES" |
| 54 | .IP " 1." 4 |
| 55 | \fBauthlib\fR(3) |
| 56 | .RS 4 |
| 57 | \%authlib.html |
| 58 | .RE |
| 59 | .IP " 2." 4 |
| 60 | \fBauth_generic\fR(3) |
| 61 | .RS 4 |
| 62 | \%auth_generic.html |
| 63 | .RE |
| 64 | .IP " 3." 4 |
| 65 | \fBauth_login\fR(3) |
| 66 | .RS 4 |
| 67 | \%auth_login.html |
| 68 | .RE |
| 69 | .IP " 4." 4 |
| 70 | \fBauth_getuserinfo\fR(3) |
| 71 | .RS 4 |
| 72 | \%auth_getuserinfo.html |
| 73 | .RE |
| 74 | .IP " 5." 4 |
| 75 | \fBauth_enumerate\fR(3) |
| 76 | .RS 4 |
| 77 | \%auth_enumerate.html |
| 78 | .RE |
HCoop / hcoop / debian / courier-authlib.git / blame