Imported Upstream version 0.66.1

[hcoop/debian/courier-authlib.git] / auth_getoption.3

diff --git a/auth_getoption.3 b/auth_getoption.3
index 331df89..3b455b7 100644 (file)
--- a/auth_getoption.3
+++ b/auth_getoption.3
@@ -1,56 +1,68 @@
-.\"  <!-- $Id: auth_getoption.sgml,v 1.3 2007/04/01 00:21:34 mrsam Exp $ -->
+'\" t
 .\"  <!-- Copyright 2004 Double Precision, Inc.  See COPYING for -->
 .\"  <!-- distribution information. -->
 .\"     Title: auth_getoption
-.\"    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_GETOPTION" "3" "08/23/2008" "Double Precision, Inc." "Double Precision, Inc."
+.TH "AUTH_GETOPTION" "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_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
+.HP \w'char\ *value=auth_getoption('u
 .BI "char *value=auth_getoption(const\ char\ *" "options" ", const\ char\ *" "keyword" ");"
 .SH "DESCRIPTION"
 .PP
 This is a convenience function for parsing account options, as received by the callback function invoked by
-\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]\.
+\m[blue]\fB\fBauth_generic\fR(3)\fR\m[]\&\s-2\u[1]\d\s+2,
+\m[blue]\fB\fBauth_login\fR(3)\fR\m[]\&\s-2\u[2]\d\s+2,
+\m[blue]\fB\fBauth_getuserinfo\fR(3)\fR\m[]\&\s-2\u[3]\d\s+2, and
+\m[blue]\fB\fBauth_passwd\fR(3)\fR\m[]\&\s-2\u[4]\d\s+2\&.
 .PP
-
 \fIoptions\fR
 is the
-options
+\fIoptions\fR
 field from
 authinfo
 (which can be
-NULL)\. As described in
-\fI\fBauth_generic\fR(3)\fR\&[1]
+NULL)\&. As described in
+\m[blue]\fB\fBauth_generic\fR(3)\fR\m[]\&\s-2\u[1]\d\s+2
 (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,14 +75,13 @@ 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\*(Aqs responsibility to
 \fBfree\fR(3)
-the returned buffer\.
+the returned buffer\&.
 .PP
-
 \fBauth_getoption\fR
 returns
 NULL
@@ -78,37 +89,36 @@ 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]\.
+\m[blue]\fB\fBauthlib\fR(3)\fR\m[]\&\s-2\u[5]\d\s+2,
+\m[blue]\fB\fBauth_generic\fR(3)\fR\m[]\&\s-2\u[1]\d\s+2,
+\m[blue]\fB\fBauth_login\fR(3)\fR\m[]\&\s-2\u[2]\d\s+2,
+\m[blue]\fB\fBauth_getuserinfo\fR(3)\fR\m[]\&\s-2\u[3]\d\s+2\&.
 .SH "NOTES"
 .IP " 1." 4
 \fBauth_generic\fR(3)
 .RS 4
-\%auth_generic.html
+\%[set $man.base.url.for.relative.links]/auth_generic.html
 .RE
 .IP " 2." 4
 \fBauth_login\fR(3)
 .RS 4
-\%auth_login.html
+\%[set $man.base.url.for.relative.links]/auth_login.html
 .RE
 .IP " 3." 4
 \fBauth_getuserinfo\fR(3)
 .RS 4
-\%auth_getuserinfo.html
+\%[set $man.base.url.for.relative.links]/auth_getuserinfo.html
 .RE
 .IP " 4." 4
 \fBauth_passwd\fR(3)
 .RS 4
-\%auth_passwd.html
+\%[set $man.base.url.for.relative.links]/auth_passwd.html
 .RE
 .IP " 5." 4
 \fBauthlib\fR(3)
 .RS 4
-\%authlib.html
+\%[set $man.base.url.for.relative.links]/authlib.html
 .RE