Imported Upstream version 0.63.0
[hcoop/debian/courier-authlib.git] / auth_getoption.3
index ad8edb7..331df89 100644 (file)
@@ -3,23 +3,23 @@
 .\"  <!-- distribution information. -->
 .\"     Title: auth_getoption
 .\"    Author: 
-.\" Generator: DocBook XSL Stylesheets v1.72.0 <http://docbook.sf.net/>
-.\"      Date: 04/06/2007
+.\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/>
+.\"      Date: 08/23/2008
 .\"    Manual: Double Precision, Inc.
 .\"    Source: Double Precision, Inc.
 .\"
-.TH "AUTH_GETOPTION" "3" "04/06/2007" "Double Precision, Inc." "Double Precision, Inc."
+.TH "AUTH_GETOPTION" "3" "08/23/2008" "Double Precision, Inc." "Double Precision, Inc."
 .\" disable hyphenation
 .nh
 .\" disable justification (adjust text to left margin only)
 .ad l
 .SH "NAME"
-auth_getoption \- Search an option string
+auth_getoption - Search an option string
 .SH "SYNOPSIS"
 .sp
 .RS 4
 .nf
-#include <courierauth.h>
+#include <courierauth\.h>
 .fi
 .RE
 .HP 27
@@ -30,7 +30,7 @@ This is a convenience function for parsing account options, as received by the c
 \fI\fBauth_generic\fR(3)\fR\&[1],
 \fI\fBauth_login\fR(3)\fR\&[2],
 \fI\fBauth_getuserinfo\fR(3)\fR\&[3], and
-\fI\fBauth_passwd\fR(3)\fR\&[4].
+\fI\fBauth_passwd\fR(3)\fR\&[4]\.
 .PP
 
 \fIoptions\fR
@@ -39,18 +39,18 @@ options
 field from
 authinfo
 (which can be
-NULL). As described in
+NULL)\. As described in
 \fI\fBauth_generic\fR(3)\fR\&[1]
 (and the others), it is a comma\-separated list of
 \(lq\fIkeyword\fR=\fIvalue\fR\(rq
-pairs.
+pairs\.
 .PP
 
 \fBauth_getoption\fR
 searches
 \fIoptions\fR
 for a
-\fIkeyword\fR.
+\fIkeyword\fR\.
 .SH "RETURNS"
 .PP
 If
@@ -63,12 +63,12 @@ NULL
 with
 \fIerrno\fR
 set to
-ENOENT. Otherwise
+ENOENT\. Otherwise
 \fBauth_getoption\fR
 allocates a buffer for
-\fIvalue\fR, and returns it. It is the caller's responsibility to
+\fIvalue\fR, and returns it\. It is the caller\'s responsibility to
 \fBfree\fR(3)
-the returned buffer.
+the returned buffer\.
 .PP
 
 \fBauth_getoption\fR
@@ -78,15 +78,15 @@ with
 \fIerrno\fR
 set to
 ENOMEM
-if it cannot allocate a buffer.
+if it cannot allocate a buffer\.
 .SH "SEE ALSO"
 .PP
 
 \fI\fBauthlib\fR(3)\fR\&[5],
 \fI\fBauth_generic\fR(3)\fR\&[1],
 \fI\fBauth_login\fR(3)\fR\&[2],
-\fI\fBauth_getuserinfo\fR(3)\fR\&[3].
-.SH "REFERENCES"
+\fI\fBauth_getuserinfo\fR(3)\fR\&[3]\.
+.SH "NOTES"
 .IP " 1." 4
 \fBauth_generic\fR(3)
 .RS 4