hcoop release
[hcoop/debian/courier-authlib.git] / authlib.3.in
1 '\" t
2 .\" <!-- Copyright 2004-2015 Double Precision, Inc. See COPYING for -->
3 .\" <!-- distribution information. -->
4 .\" Title: authlib
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
8 .\" Manual: Double Precision, Inc.
9 .\" Source: Double Precision, Inc.
10 .\" Language: English
11 .\"
12 .TH "AUTHLIB" "3" "09/08/2017" "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"
33 authlib \- Courier Authentication Library
34 .SH "SYNOPSIS"
35 .HP \w'\fBcourierauthconfig\fR\ 'u
36 \fBcourierauthconfig\fR [[\-\-ldflags] | [\-\-cppflags]]
37 .SH "DESCRIPTION"
38 .PP
39 The Courier authentication library consists of two libraries:
40 .PP
41 \-lcourierauth
42 .RS 4
43 Authentication functions\&.
44 .RE
45 .PP
46 \-lcourierauthsasl
47 .RS 4
48 SASL authentication functions\&.
49 .RE
50 .PP
51 \fBcourierauthconfig \-\-cppflags\fR
52 produces on standard output any necessary compiler flags that are needed to access the
53 courierauth\&.h
54 and the
55 courierauthsasl\&.h
56 header files\&.
57 \fBcourierauthconfig \-\-ldflags\fR
58 produces on standard output any necessary compiler flags that are needed to link against the
59 courierauth
60 or
61 courierauthsasl
62 libraries\&.
63 .SH "SEE ALSO"
64 .PP
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,
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\&.
72 .SH "NOTES"
73 .IP " 1." 4
74 \fBauth_generic\fR(3)
75 .RS 4
76 \%[set $man.base.url.for.relative.links]/auth_generic.html
77 .RE
78 .IP " 2." 4
79 \fBauth_login\fR(3)
80 .RS 4
81 \%[set $man.base.url.for.relative.links]/auth_login.html
82 .RE
83 .IP " 3." 4
84 \fBauth_getuserinfo\fR(3)
85 .RS 4
86 \%[set $man.base.url.for.relative.links]/auth_getuserinfo.html
87 .RE
88 .IP " 4." 4
89 \fBauth_enumerate\fR(3)
90 .RS 4
91 \%[set $man.base.url.for.relative.links]/auth_enumerate.html
92 .RE
93 .IP " 5." 4
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
99 \fBauth_passwd\fR(3)
100 .RS 4
101 \%[set $man.base.url.for.relative.links]/auth_passwd.html
102 .RE
103 .IP " 7." 4
104 \fBauth_sasl\fR(3)
105 .RS 4
106 \%[set $man.base.url.for.relative.links]/auth_sasl.html
107 .RE