Import Debian changes 0.66.4-9
[hcoop/debian/courier-authlib.git] / authlib.3.in
CommitLineData
b0322a85 1'\" t
d50284c4 2.\" <!-- Copyright 2004-2015 Double Precision, Inc. See COPYING for -->
d9898ee8 3.\" <!-- distribution information. -->
4.\" Title: authlib
b0322a85
CE
5.\" Author: [FIXME: author] [see http://docbook.sf.net/el/author]
6.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
d50284c4 7.\" Date: 11/04/2015
d9898ee8 8.\" Manual: Double Precision, Inc.
9.\" Source: Double Precision, Inc.
b0322a85 10.\" Language: English
d9898ee8 11.\"
d50284c4 12.TH "AUTHLIB" "3" "11/04/2015" "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 33authlib \- Courier Authentication Library
d9898ee8 34.SH "SYNOPSIS"
b0322a85 35.HP \w'\fBcourierauthconfig\fR\ 'u
d9898ee8 36\fBcourierauthconfig\fR [[\-\-ldflags] | [\-\-cppflags]]
37.SH "DESCRIPTION"
38.PP
39The Courier authentication library consists of two libraries:
40.PP
41\-lcourierauth
42.RS 4
b0322a85 43Authentication functions\&.
d9898ee8 44.RE
45.PP
46\-lcourierauthsasl
47.RS 4
b0322a85 48SASL authentication functions\&.
d9898ee8 49.RE
50.PP
d9898ee8 51\fBcourierauthconfig \-\-cppflags\fR
52produces on standard output any necessary compiler flags that are needed to access the
b0322a85 53courierauth\&.h
d9898ee8 54and the
b0322a85
CE
55courierauthsasl\&.h
56header files\&.
d9898ee8 57\fBcourierauthconfig \-\-ldflags\fR
58produces on standard output any necessary compiler flags that are needed to link against the
b0322a85 59courierauth
d9898ee8 60or
b0322a85
CE
61courierauthsasl
62libraries\&.
d9898ee8 63.SH "SEE ALSO"
64.PP
b0322a85
CE
65\m[blue]\fB\fBauth_generic\fR(3)\fR\m[]\&\s-2\u[1]\d\s+2,
66\m[blue]\fB\fBauth_login\fR(3)\fR\m[]\&\s-2\u[2]\d\s+2,
67\m[blue]\fB\fBauth_getuserinfo\fR(3)\fR\m[]\&\s-2\u[3]\d\s+2,
68\m[blue]\fB\fBauth_enumerate\fR(3)\fR\m[]\&\s-2\u[4]\d\s+2,
d50284c4
CE
69\m[blue]\fB\fBauth_mkhomedir\fR(3)\fR\m[]\&\s-2\u[5]\d\s+2,
70\m[blue]\fB\fBauth_passwd\fR(3)\fR\m[]\&\s-2\u[6]\d\s+2,
71\m[blue]\fB\fBauth_sasl\fR(3)\fR\m[]\&\s-2\u[7]\d\s+2\&.
8d138742 72.SH "NOTES"
d9898ee8 73.IP " 1." 4
74\fBauth_generic\fR(3)
75.RS 4
b0322a85 76\%[set $man.base.url.for.relative.links]/auth_generic.html
d9898ee8 77.RE
78.IP " 2." 4
79\fBauth_login\fR(3)
80.RS 4
b0322a85 81\%[set $man.base.url.for.relative.links]/auth_login.html
d9898ee8 82.RE
83.IP " 3." 4
84\fBauth_getuserinfo\fR(3)
85.RS 4
b0322a85 86\%[set $man.base.url.for.relative.links]/auth_getuserinfo.html
d9898ee8 87.RE
88.IP " 4." 4
89\fBauth_enumerate\fR(3)
90.RS 4
b0322a85 91\%[set $man.base.url.for.relative.links]/auth_enumerate.html
d9898ee8 92.RE
93.IP " 5." 4
d50284c4
CE
94\fBauth_mkhomedir\fR(3)
95.RS 4
96\%[set $man.base.url.for.relative.links]/auth_mkhomedir.html
97.RE
98.IP " 6." 4
d9898ee8 99\fBauth_passwd\fR(3)
100.RS 4
b0322a85 101\%[set $man.base.url.for.relative.links]/auth_passwd.html
d9898ee8 102.RE
d50284c4 103.IP " 7." 4
d9898ee8 104\fBauth_sasl\fR(3)
105.RS 4
b0322a85 106\%[set $man.base.url.for.relative.links]/auth_sasl.html
d9898ee8 107.RE