Skip to content
Snippets Groups Projects
Commit 2ab88105 authored by Kurt Zeilenga's avatar Kurt Zeilenga
Browse files

Documentation patch #4 (ITS#1749)

			================
Written by Hallvard B. Furuseth and placed into the public domain.
This software is not subject to any license of the University of Oslo.
			================

Small changes:
- Fix typo slapd_meta -> slapd-meta in slapd-meta(5).
- Add slapd-dnssrv(5) to SEE ALSO in slapd.conf(5).
- Add descriptions of the files in FILES sections.
- Add $HOME/.udrc to FILES in ud(1) and ud.conf(5).
- Add ldaprc (without ".") and ENVIRONMENT VARIABLES in ldap.conf(5).
- Change manpage references to proper ".BR name (section)".

Hallvard B. Furuseth <h.b.furuseth@usit.uio.no>, May 2002.
parent da36670e
No related branches found
No related tags found
No related merge requests found
Showing
with 81 additions and 76 deletions
...@@ -158,8 +158,8 @@ Issue StartTLS (Transport Layer Security) extended operation. If you use ...@@ -158,8 +158,8 @@ Issue StartTLS (Transport Layer Security) extended operation. If you use
.BR \-ZZ , .BR \-ZZ ,
the command will require the operation to be successful the command will require the operation to be successful
.SH SEE ALSO .SH SEE ALSO
.BR ldap_sasl_bind (3) .BR ldap_sasl_bind (3),
.BR ldap_extended_operation (3) .BR ldap_extended_operation (3),
.BR ldap_start_tls_s (3) .BR ldap_start_tls_s (3)
.SH AUTHOR .SH AUTHOR
The OpenLDAP Project <http://www.openldap.org/> The OpenLDAP Project <http://www.openldap.org/>
......
...@@ -61,7 +61,12 @@ command. ...@@ -61,7 +61,12 @@ command.
.B \-D .B \-D
Prints out a list of valid ud debug masks. Prints out a list of valid ud debug masks.
.SH FILES .SH FILES
ETCDIR/ud.conf The ud configuration file. .TP
.I ETCDIR/ud.conf
system-wide ud configuration file
.TP
.I $HOME/.udrc
personal ud configuration file, overriding system file
.SH "SEE ALSO" .SH "SEE ALSO"
.BR ud.conf (5), .BR ud.conf (5),
.BR ldap.conf (5), .BR ldap.conf (5),
......
...@@ -343,9 +343,9 @@ The return values for all of these functions are declared in the ...@@ -343,9 +343,9 @@ The return values for all of these functions are declared in the
header file. Some routines may dynamically allocate memory header file. Some routines may dynamically allocate memory
which must be freed by the caller using supplied deallocation routines. which must be freed by the caller using supplied deallocation routines.
.SH SEE ALSO .SH SEE ALSO
.BR lber-encode (3) .BR lber-encode (3),
.BR lber-memory (3) .BR lber-memory (3),
.BR lber-sockbuf (3) .BR lber-sockbuf (3),
.BR lber-types (3) .BR lber-types (3)
.SH ACKNOWLEDGEMENTS .SH ACKNOWLEDGEMENTS
.B OpenLDAP .B OpenLDAP
......
...@@ -73,7 +73,7 @@ routine is used to actually write the element to a socket ...@@ -73,7 +73,7 @@ routine is used to actually write the element to a socket
(or file) descriptor, once it has been fully encoded (using (or file) descriptor, once it has been fully encoded (using
.BR ber_printf () .BR ber_printf ()
and friends). See and friends). See
.BR lber-sockbuf(3) .BR lber-sockbuf (3)
for more details on the Sockbuf implementation of the \fIsb\fP parameter. for more details on the Sockbuf implementation of the \fIsb\fP parameter.
If the \fIfreeit\fP parameter is non-zero, the supplied \fIber\fP will If the \fIfreeit\fP parameter is non-zero, the supplied \fIber\fP will
be freed after its contents have been flushed. be freed after its contents have been flushed.
...@@ -262,9 +262,9 @@ If an error occurs during encoding, generally these routines return LBER_ERROR. ...@@ -262,9 +262,9 @@ If an error occurs during encoding, generally these routines return LBER_ERROR.
The return values for all of these functions are declared in the The return values for all of these functions are declared in the
<lber.h> header file. <lber.h> header file.
.SH SEE ALSO .SH SEE ALSO
.BR lber-decode (3) .BR lber-decode (3),
.BR lber-memory (3) .BR lber-memory (3),
.BR lber-sockbuf (3) .BR lber-sockbuf (3),
.BR lber-types (3) .BR lber-types (3)
.SH ACKNOWLEDGEMENTS .SH ACKNOWLEDGEMENTS
.B OpenLDAP .B OpenLDAP
......
...@@ -33,14 +33,14 @@ are used exactly like the standard ...@@ -33,14 +33,14 @@ are used exactly like the standard
.BR calloc (3), .BR calloc (3),
.BR realloc (3), .BR realloc (3),
and and
.BR free(3) .BR free (3)
routines, respectively. The routines, respectively. The
.BR ber_memvfree () .BR ber_memvfree ()
routine is used to free a dynamically allocated array of pointers to routine is used to free a dynamically allocated array of pointers to
arbitrary dynamically allocated objects. arbitrary dynamically allocated objects.
.SH SEE ALSO .SH SEE ALSO
.BR lber-decode (3) .BR lber-decode (3),
.BR lber-encode (3) .BR lber-encode (3),
.BR lber-types (3) .BR lber-types (3)
.LP .LP
.SH ACKNOWLEDGEMENTS .SH ACKNOWLEDGEMENTS
......
...@@ -153,8 +153,8 @@ and ...@@ -153,8 +153,8 @@ and
frees a BerElement pointed to by \fIber\fP. If \fIber\fP is NULL, the routine frees a BerElement pointed to by \fIber\fP. If \fIber\fP is NULL, the routine
does nothing. If \fIfreebuf\fP is zero, the internal buffer is not freed. does nothing. If \fIfreebuf\fP is zero, the internal buffer is not freed.
.SH SEE ALSO .SH SEE ALSO
.BR lber-encode (3) .BR lber-encode (3),
.BR lber-decode (3) .BR lber-decode (3),
.BR lber-memory (3) .BR lber-memory (3)
.LP .LP
.SH ACKNOWLEDGEMENTS .SH ACKNOWLEDGEMENTS
......
...@@ -304,7 +304,7 @@ sort a list of attribute values ...@@ -304,7 +304,7 @@ sort a list of attribute values
.SM ldap_sort_strcasecmp(3) .SM ldap_sort_strcasecmp(3)
case insensitive string comparison case insensitive string comparison
.SH SEE ALSO .SH SEE ALSO
.BR slapd (8) .BR slapd (8),
.BR draft-ietf-ldapext-ldap-c-api-xx.txt \ <http://www.ietf.org> .BR draft-ietf-ldapext-ldap-c-api-xx.txt \ <http://www.ietf.org>
.SH ACKNOWLEDGEMENTS .SH ACKNOWLEDGEMENTS
.B OpenLDAP .B OpenLDAP
......
...@@ -55,9 +55,9 @@ See ...@@ -55,9 +55,9 @@ See
.BR ldap_error (3) .BR ldap_error (3)
for details. for details.
.SH SEE ALSO .SH SEE ALSO
.BR ldap(3), .BR ldap (3),
.BR ldap_result(3), .BR ldap_result (3),
.B ldap_error(3) .BR ldap_error (3)
.SH ACKNOWLEDGEMENTS .SH ACKNOWLEDGEMENTS
.B OpenLDAP .B OpenLDAP
is developed and maintained by The OpenLDAP Project (http://www.openldap.org/). is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
......
...@@ -79,8 +79,8 @@ and ...@@ -79,8 +79,8 @@ and
.B ldap_add_ext_s() .B ldap_add_ext_s()
also directly return LDAP error codes. also directly return LDAP error codes.
.SH SEE ALSO .SH SEE ALSO
.BR ldap(3), .BR ldap (3),
.B ldap_modify(3) .BR ldap_modify (3)
.SH ACKNOWLEDGEMENTS .SH ACKNOWLEDGEMENTS
.B OpenLDAP .B OpenLDAP
is developed and maintained by The OpenLDAP Project (http://www.openldap.org/). is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
......
...@@ -211,9 +211,9 @@ routines return whatever \fIld_errno\fP is set to. See ...@@ -211,9 +211,9 @@ routines return whatever \fIld_errno\fP is set to. See
.BR ldap_error (3) .BR ldap_error (3)
for more information. for more information.
.SH SEE ALSO .SH SEE ALSO
.BR ldap(3), .BR ldap (3),
.BR ldap_error(3), .BR ldap_error (3),
.BR ldap_open(3), .BR ldap_open (3),
.B RFC 2222 .B RFC 2222
(http://www.ietf.org), (http://www.ietf.org),
.B Cyrus SASL .B Cyrus SASL
......
...@@ -49,8 +49,8 @@ non-negative message id of the request if things went ok. ...@@ -49,8 +49,8 @@ non-negative message id of the request if things went ok.
.SH BUGS .SH BUGS
There is no way to compare binary values, but there should be. There is no way to compare binary values, but there should be.
.SH SEE ALSO .SH SEE ALSO
.BR ldap(3), .BR ldap (3),
.BR ldap_error(3) .BR ldap_error (3)
.SH ACKNOWLEDGEMENTS .SH ACKNOWLEDGEMENTS
.B OpenLDAP .B OpenLDAP
is developed and maintained by The OpenLDAP Project (http://www.openldap.org/). is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
......
...@@ -46,8 +46,8 @@ and friends. ...@@ -46,8 +46,8 @@ and friends.
returns -1 if something went wrong initiating the request. It returns the returns -1 if something went wrong initiating the request. It returns the
non-negative message id of the request if things went ok. non-negative message id of the request if things went ok.
.SH SEE ALSO .SH SEE ALSO
.BR ldap(3), .BR ldap (3),
.BR ldap_error(3) .BR ldap_error (3)
.SH ACKNOWLEDGEMENTS .SH ACKNOWLEDGEMENTS
.B OpenLDAP .B OpenLDAP
is developed and maintained by The OpenLDAP Project (http://www.openldap.org/). is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
......
...@@ -201,8 +201,8 @@ An memory allocation (e.g., malloc(3) or other dynamic memory ...@@ -201,8 +201,8 @@ An memory allocation (e.g., malloc(3) or other dynamic memory
allocator) call failed in an ldap allocator) call failed in an ldap
library routine. library routine.
.SH SEE ALSO .SH SEE ALSO
.BR ldap(3), .BR ldap (3),
.BR perror(3) .BR perror (3)
.SH ACKNOWLEDGEMENTS .SH ACKNOWLEDGEMENTS
.B OpenLDAP .B OpenLDAP
is developed and maintained by The OpenLDAP Project (http://www.openldap.org/). is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
......
...@@ -63,10 +63,10 @@ and ...@@ -63,10 +63,10 @@ and
return dynamically allocated memory that must be freed by the caller via return dynamically allocated memory that must be freed by the caller via
.BR ldap_memfree (3). .BR ldap_memfree (3).
.SH SEE ALSO .SH SEE ALSO
.BR ldap(3), .BR ldap (3),
.BR ldap_first_entry(3), .BR ldap_first_entry (3),
.BR ldap_get_values(3), .BR ldap_get_values (3),
.BR ldap_error(3) .BR ldap_error (3)
.SH ACKNOWLEDGEMENTS .SH ACKNOWLEDGEMENTS
.B OpenLDAP .B OpenLDAP
is developed and maintained by The OpenLDAP Project (http://www.openldap.org/). is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
......
...@@ -68,12 +68,12 @@ is set appropriately. See ...@@ -68,12 +68,12 @@ is set appropriately. See
.BR ldap_error (3) .BR ldap_error (3)
for a description of possible error codes. for a description of possible error codes.
.SH SEE ALSO .SH SEE ALSO
.BR ldap(3), .BR ldap (3),
.BR ldap_result(3), .BR ldap_result (3),
.BR ldap_search(3), .BR ldap_search (3),
.BR ldap_first_attribute(3), .BR ldap_first_attribute (3),
.BR ldap_get_values(3), .BR ldap_get_values (3),
.BR ldap_get_dn(3) .BR ldap_get_dn (3)
.SH ACKNOWLEDGEMENTS .SH ACKNOWLEDGEMENTS
.B OpenLDAP .B OpenLDAP
is developed and maintained by The OpenLDAP Project (http://www.openldap.org/). is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
......
...@@ -71,12 +71,12 @@ NULL is returned. If an error occurs in ...@@ -71,12 +71,12 @@ NULL is returned. If an error occurs in
.BR ldap_count_messages() , .BR ldap_count_messages() ,
-1 is returned. -1 is returned.
.SH SEE ALSO .SH SEE ALSO
.BR ldap(3), .BR ldap (3),
.BR ldap_search(3), .BR ldap_search (3),
.BR ldap_result(3), .BR ldap_result (3),
.BR ldap_parse_result(3), .BR ldap_parse_result (3),
.BR ldap_first_entry(3), .BR ldap_first_entry (3),
.BR ldap_first_reference(3) .BR ldap_first_reference (3)
.SH ACKNOWLEDGEMENTS .SH ACKNOWLEDGEMENTS
.B OpenLDAP .B OpenLDAP
is developed and maintained by The OpenLDAP Project (http://www.openldap.org/). is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
......
...@@ -62,10 +62,10 @@ NULL is returned. If an error occurs in ...@@ -62,10 +62,10 @@ NULL is returned. If an error occurs in
.BR ldap_count_references() , .BR ldap_count_references() ,
-1 is returned. -1 is returned.
.SH SEE ALSO .SH SEE ALSO
.BR ldap(3), .BR ldap (3),
.BR ldap_result(3), .BR ldap_result (3),
.BR ldap_search(3), .BR ldap_search (3),
.BR ldap_parse_reference(3) .BR ldap_parse_reference (3)
.SH ACKNOWLEDGEMENTS .SH ACKNOWLEDGEMENTS
.B OpenLDAP .B OpenLDAP
is developed and maintained by The OpenLDAP Project (http://www.openldap.org/). is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
......
...@@ -219,11 +219,11 @@ set appropriately in case of trouble. ...@@ -219,11 +219,11 @@ set appropriately in case of trouble.
.SH NOTES .SH NOTES
These routines dynamically allocate memory that the caller must free. These routines dynamically allocate memory that the caller must free.
.SH SEE ALSO .SH SEE ALSO
.BR ldap(3), .BR ldap (3),
.BR ldap_error(3), .BR ldap_error (3),
.BR ldap_first_entry(3), .BR ldap_first_entry (3),
.BR ldap_memfree(3), .BR ldap_memfree (3),
.BR ldap_value_free(3) .BR ldap_value_free (3)
.SH ACKNOWLEDGEMENTS .SH ACKNOWLEDGEMENTS
.B OpenLDAP .B OpenLDAP
is developed and maintained by The OpenLDAP Project (http://www.openldap.org/). is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
......
...@@ -92,10 +92,10 @@ for a description of possible error codes. ...@@ -92,10 +92,10 @@ for a description of possible error codes.
These routines dynamically allocate memory which the caller must free These routines dynamically allocate memory which the caller must free
using the supplied routines. using the supplied routines.
.SH SEE ALSO .SH SEE ALSO
.BR ldap(3), .BR ldap (3),
.BR ldap_first_entry(3), .BR ldap_first_entry (3),
.BR ldap_first_attribute(3), .BR ldap_first_attribute (3),
.BR ldap_error(3) .BR ldap_error (3)
.SH ACKNOWLEDGEMENTS .SH ACKNOWLEDGEMENTS
.B OpenLDAP .B OpenLDAP
is developed and maintained by The OpenLDAP Project (http://www.openldap.org/). is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).
......
...@@ -27,12 +27,12 @@ These routines are used to extract information from a result message. ...@@ -27,12 +27,12 @@ These routines are used to extract information from a result message.
They will operate on the first result message in a chain of search They will operate on the first result message in a chain of search
results (skipping past other message types). They take the \fIresult\fP results (skipping past other message types). They take the \fIresult\fP
as returned by a call to as returned by a call to
.BR ldap_result (3) , .BR ldap_result (3),
.BR ldap_search_s (3) .BR ldap_search_s (3)
or or
.BR ldap_search_st (3) . .BR ldap_search_st (3).
In addition to In addition to
.B ldap_parse_result() , .BR ldap_parse_result() ,
the routines the routines
.B ldap_parse_sasl_bind_result() .B ldap_parse_sasl_bind_result()
and and
...@@ -47,43 +47,43 @@ The server might supply a matched DN string in the message indicating ...@@ -47,43 +47,43 @@ The server might supply a matched DN string in the message indicating
how much of a name in a request was recognized. The \fImatcheddnp\fP how much of a name in a request was recognized. The \fImatcheddnp\fP
parameter will be filled in with this string if supplied, else it will parameter will be filled in with this string if supplied, else it will
be NULL. If a string is returned, it should be freed using be NULL. If a string is returned, it should be freed using
.BR ldap_memfree(3) . .BR ldap_memfree (3).
.LP .LP
The \fIerrmsgp\fP parameter will be filled in with the error message The \fIerrmsgp\fP parameter will be filled in with the error message
field from the parsed message. This string should be freed using field from the parsed message. This string should be freed using
.BR ldap_memfree(3) . .BR ldap_memfree (3).
.LP .LP
The \fIreferralsp\fP parameter will be filled in with an allocated array of The \fIreferralsp\fP parameter will be filled in with an allocated array of
referral strings from the parsed message. This array should be freed using referral strings from the parsed message. This array should be freed using
.BR ldap_value_free(3) . .BR ldap_value_free (3).
If no referrals were returned, \fI*referralsp\fP is set to NULL. If no referrals were returned, \fI*referralsp\fP is set to NULL.
.LP .LP
The \fIserverctrlsp\fP parameter will be filled in with an allocated array of The \fIserverctrlsp\fP parameter will be filled in with an allocated array of
controls copied from the parsed message. The array should be freed using controls copied from the parsed message. The array should be freed using
.BR ldap_controls_free(3) . .BR ldap_controls_free (3).
If no controls were returned, \fI*serverctrlsp\fP is set to NULL. If no controls were returned, \fI*serverctrlsp\fP is set to NULL.
.LP .LP
The \fIfreeit\fP parameter determines whether the parsed message is The \fIfreeit\fP parameter determines whether the parsed message is
freed or not after the extraction. Any non-zero value will make it freed or not after the extraction. Any non-zero value will make it
free the message. The free the message. The
.BR ldap_msgfree(3) .BR ldap_msgfree (3)
routine can also be used to free the message later. routine can also be used to free the message later.
.LP .LP
For SASL bind results, the \fIservercredp\fP parameter will be filled in For SASL bind results, the \fIservercredp\fP parameter will be filled in
with an allocated berval structure containing the credentials from the with an allocated berval structure containing the credentials from the
server if present. The structure should be freed using server if present. The structure should be freed using
.BR ber_bvfree(3) . .BR ber_bvfree (3).
.LP .LP
For extended results, the \fIretoidp\fP parameter will be filled in For extended results, the \fIretoidp\fP parameter will be filled in
with the dotted-OID text representation of the name of the extended with the dotted-OID text representation of the name of the extended
operation response. The string should be freed using operation response. The string should be freed using
.BR ldap_memfree(3) . .BR ldap_memfree (3).
If no OID was returned, \fI*retoidp\fP is set to NULL. If no OID was returned, \fI*retoidp\fP is set to NULL.
.LP .LP
For extended results, the \fIretdatap\fP parameter will be filled in For extended results, the \fIretdatap\fP parameter will be filled in
with a pointer to a berval structure containing the data from the with a pointer to a berval structure containing the data from the
extended operation response. The structure should be freed using extended operation response. The structure should be freed using
.BR ber_bvfree(3) . .BR ber_bvfree (3).
If no data were returned, \fI*retdatap\fP is set to NULL. If no data were returned, \fI*retdatap\fP is set to NULL.
.LP .LP
For all the above result parameters, NULL values can be used in calls For all the above result parameters, NULL values can be used in calls
...@@ -92,12 +92,12 @@ in order to ignore certain fields. ...@@ -92,12 +92,12 @@ in order to ignore certain fields.
Upon success LDAP_SUCCESS is returned. Otherwise the values of the Upon success LDAP_SUCCESS is returned. Otherwise the values of the
result parameters are undefined. result parameters are undefined.
.SH SEE ALSO .SH SEE ALSO
.BR ldap (3) .BR ldap (3),
.BR ldap_result (3) .BR ldap_result (3),
.BR ldap_search (3) .BR ldap_search (3),
.BR ldap_memfree (3) .BR ldap_memfree (3),
.BR ldap_get_values (3) .BR ldap_get_values (3),
.BR ldap_controls_free (3) .BR ldap_controls_free (3),
.BR lber-types (3) .BR lber-types (3)
.SH ACKNOWLEDGEMENTS .SH ACKNOWLEDGEMENTS
.B OpenLDAP .B OpenLDAP
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment