-.\" <!-- $Id: auth_enumerate.sgml,v 1.5 2007/07/21 20:05:53 mrsam Exp $ -->
+'\" t
.\" <!-- Copyright 2004 Double Precision, Inc. See COPYING for -->
.\" <!-- distribution information. -->
.\" Title: auth_enumerate
-.\" Author:
-.\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/>
-.\" Date: 08/23/2008
+.\" 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_ENUMERATE" "3" "08/23/2008" "Double Precision, Inc." "Double Precision, Inc."
+.TH "AUTH_ENUMERATE" "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_enumerate - Obtain list of accounts
+auth_enumerate \- Obtain list of accounts
.SH "SYNOPSIS"
.sp
-.RS 4
.nf
-#include <courierauth\.h>
+#include <courierauth\&.h>
.fi
-.RE
-.HP 15
+.HP \w'auth_enumerate('u
.BI "auth_enumerate(int\ " "(*callback_func)" "\ (const\ char\ *,\ uid_t,\ gid_t,\ const\ char\ *,\ const\ char\ *,\ const\ char\ *,\ void\ *), void\ *" "callback_arg" ");"
.SH "DESCRIPTION"
.PP
-
\fBauth_enumerate\fR
-enumerates all of the available accounts\.
+enumerates all of the available accounts\&.
\fBauth_enumerate\fR
repeatedly calls
-\fBcallback_func\fR, once for each account\.
+\fBcallback_func\fR, once for each account\&.
\fBcallback_func\fR
receives the following arguments:
.sp
.RS 4
-\h'-04'\(bu\h'+03'Account name\.
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+Account name\&.
.RE
.sp
.RS 4
-\h'-04'\(bu\h'+03'Account\'s numeric userid\.
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+Account\*(Aqs numeric userid\&.
.RE
.sp
.RS 4
-\h'-04'\(bu\h'+03'Account\'s numeric groupid\.
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+Account\*(Aqs numeric groupid\&.
.RE
.sp
.RS 4
-\h'-04'\(bu\h'+03'Account\'s home directory\.
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+Account\*(Aqs home directory\&.
.RE
.sp
.RS 4
-\h'-04'\(bu\h'+03'Account\'s mailbox (if defined, may be
-NULL, which indicates the default mailbox location)\.
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+Account\*(Aqs mailbox (if defined, may be
+NULL, which indicates the default mailbox location)\&.
.RE
.sp
.RS 4
-\h'-04'\(bu\h'+03'Account\'s options string (if defined, may be
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+Account\*(Aqs options string (if defined, may be
NULL)
.RE
.sp
.RS 4
-\h'-04'\(bu\h'+03'
-\fIcallback_arg\fR, verbatim\.
+.ie n \{\
+\h'-04'\(bu\h'+03'\c
+.\}
+.el \{\
+.sp -1
+.IP \(bu 2.3
+.\}
+\fIcallback_arg\fR, verbatim\&.
.RE
.PP
After invoking
\fBcallback_func\fR
one more time with all parameters set to
NULL
-or 0\.
+or 0\&.
.PP
If
\fBauth_enumerate\fR
\fBcallback_func\fR
with all
NULL
-or 0 parameters\. This can be used to determine whether a partial list of accounts was received\.
+or 0 parameters\&. This can be used to determine whether a partial list of accounts was received\&.
+.if n \{\
.sp
+.\}
+.RS 4
.it 1 an-trap
.nr an-no-space-flag 1
.nr an-break-flag 1
.br
-Note
+.ps +1
+\fBNote\fR
+.ps -1
+.br
.PP
-Some back\-end Courier authentication modules do not implement account enumeration, so this function may not be available in all configurations\.
+Some back\-end Courier authentication modules do not implement account enumeration, so this function may not be available in all configurations\&.
+.sp .5v
+.RE
.SH "SEE ALSO"
.PP
-
-\fI\fBauthlib\fR(3)\fR\&[1],
-\fI\fBauth_generic\fR(3)\fR\&[2],
-\fI\fBauth_login\fR(3)\fR\&[3],
-\fI\fBauth_getuserinfo\fR(3)\fR\&[4],
-\fI\fBauth_passwd\fR(3)\fR\&[5]\.
+\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_passwd\fR(3)\fR\m[]\&\s-2\u[5]\d\s+2\&.
.SH "NOTES"
.IP " 1." 4
\fBauthlib\fR(3)
.RS 4
-\%authlib.html
+\%[set $man.base.url.for.relative.links]/authlib.html
.RE
.IP " 2." 4
\fBauth_generic\fR(3)
.RS 4
-\%auth_generic.html
+\%[set $man.base.url.for.relative.links]/auth_generic.html
.RE
.IP " 3." 4
\fBauth_login\fR(3)
.RS 4
-\%auth_login.html
+\%[set $man.base.url.for.relative.links]/auth_login.html
.RE
.IP " 4." 4
\fBauth_getuserinfo\fR(3)
.RS 4
-\%auth_getuserinfo.html
+\%[set $man.base.url.for.relative.links]/auth_getuserinfo.html
.RE
.IP " 5." 4
\fBauth_passwd\fR(3)
.RS 4
-\%auth_passwd.html
+\%[set $man.base.url.for.relative.links]/auth_passwd.html
.RE
HCoop / hcoop / debian / courier-authlib.git / blobdiff