From 2ab8810555d7dfacec389864eaf2d83beaa8e329 Mon Sep 17 00:00:00 2001 From: Kurt Zeilenga Date: Thu, 9 May 2002 02:07:41 +0000 Subject: [PATCH] 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 , May 2002. --- doc/man/man1/ldappasswd.1 | 4 ++-- doc/man/man1/ud.1 | 7 +++++- doc/man/man3/lber-decode.3 | 6 ++--- doc/man/man3/lber-encode.3 | 8 +++---- doc/man/man3/lber-memory.3 | 6 ++--- doc/man/man3/lber-types.3 | 4 ++-- doc/man/man3/ldap.3 | 2 +- doc/man/man3/ldap_abandon.3 | 6 ++--- doc/man/man3/ldap_add.3 | 4 ++-- doc/man/man3/ldap_bind.3 | 6 ++--- doc/man/man3/ldap_compare.3 | 4 ++-- doc/man/man3/ldap_delete.3 | 4 ++-- doc/man/man3/ldap_error.3 | 4 ++-- doc/man/man3/ldap_first_attribute.3 | 8 +++---- doc/man/man3/ldap_first_entry.3 | 12 +++++----- doc/man/man3/ldap_first_message.3 | 12 +++++----- doc/man/man3/ldap_first_reference.3 | 8 +++---- doc/man/man3/ldap_get_dn.3 | 10 ++++----- doc/man/man3/ldap_get_values.3 | 8 +++---- doc/man/man3/ldap_parse_result.3 | 34 ++++++++++++++--------------- doc/man/man3/ldap_schema.3 | 2 +- doc/man/man5/ldap.conf.5 | 34 ++++++++++++++++++++++++----- doc/man/man5/slapd-bdb.5 | 2 ++ doc/man/man5/slapd-dnssrv.5 | 2 ++ doc/man/man5/slapd-ldap.5 | 2 ++ doc/man/man5/slapd-ldbm.5 | 2 ++ doc/man/man5/slapd-meta.5 | 6 +++-- doc/man/man5/slapd-null.5 | 2 ++ doc/man/man5/slapd-passwd.5 | 5 ++++- doc/man/man5/slapd-perl.5 | 2 ++ doc/man/man5/slapd-shell.5 | 2 ++ doc/man/man5/slapd-sql.5 | 2 ++ doc/man/man5/slapd-tcl.5 | 2 ++ doc/man/man5/slapd.access.5 | 2 ++ doc/man/man5/slapd.conf.5 | 5 ++++- doc/man/man5/slapd.replog.5 | 8 +++++-- doc/man/man5/ud.conf.5 | 9 ++++++-- doc/man/man8/mail500.8 | 6 ++--- 38 files changed, 158 insertions(+), 94 deletions(-) diff --git a/doc/man/man1/ldappasswd.1 b/doc/man/man1/ldappasswd.1 index 3fa179f87b..a23f875c51 100644 --- a/doc/man/man1/ldappasswd.1 +++ b/doc/man/man1/ldappasswd.1 @@ -158,8 +158,8 @@ Issue StartTLS (Transport Layer Security) extended operation. If you use .BR \-ZZ , the command will require the operation to be successful .SH SEE ALSO -.BR ldap_sasl_bind (3) -.BR ldap_extended_operation (3) +.BR ldap_sasl_bind (3), +.BR ldap_extended_operation (3), .BR ldap_start_tls_s (3) .SH AUTHOR The OpenLDAP Project diff --git a/doc/man/man1/ud.1 b/doc/man/man1/ud.1 index b4e080d6b0..c1eb3bc5ca 100644 --- a/doc/man/man1/ud.1 +++ b/doc/man/man1/ud.1 @@ -61,7 +61,12 @@ command. .B \-D Prints out a list of valid ud debug masks. .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" .BR ud.conf (5), .BR ldap.conf (5), diff --git a/doc/man/man3/lber-decode.3 b/doc/man/man3/lber-decode.3 index 2eb1fb77a7..b0ff540d00 100644 --- a/doc/man/man3/lber-decode.3 +++ b/doc/man/man3/lber-decode.3 @@ -343,9 +343,9 @@ The return values for all of these functions are declared in the header file. Some routines may dynamically allocate memory which must be freed by the caller using supplied deallocation routines. .SH SEE ALSO -.BR lber-encode (3) -.BR lber-memory (3) -.BR lber-sockbuf (3) +.BR lber-encode (3), +.BR lber-memory (3), +.BR lber-sockbuf (3), .BR lber-types (3) .SH ACKNOWLEDGEMENTS .B OpenLDAP diff --git a/doc/man/man3/lber-encode.3 b/doc/man/man3/lber-encode.3 index 38c8854e47..be7302cb79 100644 --- a/doc/man/man3/lber-encode.3 +++ b/doc/man/man3/lber-encode.3 @@ -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 .BR ber_printf () and friends). See -.BR lber-sockbuf(3) +.BR lber-sockbuf (3) 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 be freed after its contents have been flushed. @@ -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 header file. .SH SEE ALSO -.BR lber-decode (3) -.BR lber-memory (3) -.BR lber-sockbuf (3) +.BR lber-decode (3), +.BR lber-memory (3), +.BR lber-sockbuf (3), .BR lber-types (3) .SH ACKNOWLEDGEMENTS .B OpenLDAP diff --git a/doc/man/man3/lber-memory.3 b/doc/man/man3/lber-memory.3 index 75da6214ee..2cf9d32332 100644 --- a/doc/man/man3/lber-memory.3 +++ b/doc/man/man3/lber-memory.3 @@ -33,14 +33,14 @@ are used exactly like the standard .BR calloc (3), .BR realloc (3), and -.BR free(3) +.BR free (3) routines, respectively. The .BR ber_memvfree () routine is used to free a dynamically allocated array of pointers to arbitrary dynamically allocated objects. .SH SEE ALSO -.BR lber-decode (3) -.BR lber-encode (3) +.BR lber-decode (3), +.BR lber-encode (3), .BR lber-types (3) .LP .SH ACKNOWLEDGEMENTS diff --git a/doc/man/man3/lber-types.3 b/doc/man/man3/lber-types.3 index e7cc82c647..0a8b020b76 100644 --- a/doc/man/man3/lber-types.3 +++ b/doc/man/man3/lber-types.3 @@ -153,8 +153,8 @@ and 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. .SH SEE ALSO -.BR lber-encode (3) -.BR lber-decode (3) +.BR lber-encode (3), +.BR lber-decode (3), .BR lber-memory (3) .LP .SH ACKNOWLEDGEMENTS diff --git a/doc/man/man3/ldap.3 b/doc/man/man3/ldap.3 index f65fc1d3a9..2b3c97b6ac 100644 --- a/doc/man/man3/ldap.3 +++ b/doc/man/man3/ldap.3 @@ -304,7 +304,7 @@ sort a list of attribute values .SM ldap_sort_strcasecmp(3) case insensitive string comparison .SH SEE ALSO -.BR slapd (8) +.BR slapd (8), .BR draft-ietf-ldapext-ldap-c-api-xx.txt \ .SH ACKNOWLEDGEMENTS .B OpenLDAP diff --git a/doc/man/man3/ldap_abandon.3 b/doc/man/man3/ldap_abandon.3 index 63e75446cd..a5266937ed 100644 --- a/doc/man/man3/ldap_abandon.3 +++ b/doc/man/man3/ldap_abandon.3 @@ -55,9 +55,9 @@ See .BR ldap_error (3) for details. .SH SEE ALSO -.BR ldap(3), -.BR ldap_result(3), -.B ldap_error(3) +.BR ldap (3), +.BR ldap_result (3), +.BR ldap_error (3) .SH ACKNOWLEDGEMENTS .B OpenLDAP is developed and maintained by The OpenLDAP Project (http://www.openldap.org/). diff --git a/doc/man/man3/ldap_add.3 b/doc/man/man3/ldap_add.3 index 7a3aad11d3..fbd33a321d 100644 --- a/doc/man/man3/ldap_add.3 +++ b/doc/man/man3/ldap_add.3 @@ -79,8 +79,8 @@ and .B ldap_add_ext_s() also directly return LDAP error codes. .SH SEE ALSO -.BR ldap(3), -.B ldap_modify(3) +.BR ldap (3), +.BR ldap_modify (3) .SH ACKNOWLEDGEMENTS .B OpenLDAP is developed and maintained by The OpenLDAP Project (http://www.openldap.org/). diff --git a/doc/man/man3/ldap_bind.3 b/doc/man/man3/ldap_bind.3 index 8f9c56b0fc..16ce233d33 100644 --- a/doc/man/man3/ldap_bind.3 +++ b/doc/man/man3/ldap_bind.3 @@ -211,9 +211,9 @@ routines return whatever \fIld_errno\fP is set to. See .BR ldap_error (3) for more information. .SH SEE ALSO -.BR ldap(3), -.BR ldap_error(3), -.BR ldap_open(3), +.BR ldap (3), +.BR ldap_error (3), +.BR ldap_open (3), .B RFC 2222 (http://www.ietf.org), .B Cyrus SASL diff --git a/doc/man/man3/ldap_compare.3 b/doc/man/man3/ldap_compare.3 index 2904698a75..b4971eb45d 100644 --- a/doc/man/man3/ldap_compare.3 +++ b/doc/man/man3/ldap_compare.3 @@ -49,8 +49,8 @@ non-negative message id of the request if things went ok. .SH BUGS There is no way to compare binary values, but there should be. .SH SEE ALSO -.BR ldap(3), -.BR ldap_error(3) +.BR ldap (3), +.BR ldap_error (3) .SH ACKNOWLEDGEMENTS .B OpenLDAP is developed and maintained by The OpenLDAP Project (http://www.openldap.org/). diff --git a/doc/man/man3/ldap_delete.3 b/doc/man/man3/ldap_delete.3 index c6e3a4c4b5..9390106367 100644 --- a/doc/man/man3/ldap_delete.3 +++ b/doc/man/man3/ldap_delete.3 @@ -46,8 +46,8 @@ and friends. returns -1 if something went wrong initiating the request. It returns the non-negative message id of the request if things went ok. .SH SEE ALSO -.BR ldap(3), -.BR ldap_error(3) +.BR ldap (3), +.BR ldap_error (3) .SH ACKNOWLEDGEMENTS .B OpenLDAP is developed and maintained by The OpenLDAP Project (http://www.openldap.org/). diff --git a/doc/man/man3/ldap_error.3 b/doc/man/man3/ldap_error.3 index b3a6592a4b..da99aa6231 100644 --- a/doc/man/man3/ldap_error.3 +++ b/doc/man/man3/ldap_error.3 @@ -201,8 +201,8 @@ An memory allocation (e.g., malloc(3) or other dynamic memory allocator) call failed in an ldap library routine. .SH SEE ALSO -.BR ldap(3), -.BR perror(3) +.BR ldap (3), +.BR perror (3) .SH ACKNOWLEDGEMENTS .B OpenLDAP is developed and maintained by The OpenLDAP Project (http://www.openldap.org/). diff --git a/doc/man/man3/ldap_first_attribute.3 b/doc/man/man3/ldap_first_attribute.3 index 8eb49b62e5..ec9fd54b43 100644 --- a/doc/man/man3/ldap_first_attribute.3 +++ b/doc/man/man3/ldap_first_attribute.3 @@ -63,10 +63,10 @@ and return dynamically allocated memory that must be freed by the caller via .BR ldap_memfree (3). .SH SEE ALSO -.BR ldap(3), -.BR ldap_first_entry(3), -.BR ldap_get_values(3), -.BR ldap_error(3) +.BR ldap (3), +.BR ldap_first_entry (3), +.BR ldap_get_values (3), +.BR ldap_error (3) .SH ACKNOWLEDGEMENTS .B OpenLDAP is developed and maintained by The OpenLDAP Project (http://www.openldap.org/). diff --git a/doc/man/man3/ldap_first_entry.3 b/doc/man/man3/ldap_first_entry.3 index 56a96a5d5c..9df89ebf52 100644 --- a/doc/man/man3/ldap_first_entry.3 +++ b/doc/man/man3/ldap_first_entry.3 @@ -68,12 +68,12 @@ is set appropriately. See .BR ldap_error (3) for a description of possible error codes. .SH SEE ALSO -.BR ldap(3), -.BR ldap_result(3), -.BR ldap_search(3), -.BR ldap_first_attribute(3), -.BR ldap_get_values(3), -.BR ldap_get_dn(3) +.BR ldap (3), +.BR ldap_result (3), +.BR ldap_search (3), +.BR ldap_first_attribute (3), +.BR ldap_get_values (3), +.BR ldap_get_dn (3) .SH ACKNOWLEDGEMENTS .B OpenLDAP is developed and maintained by The OpenLDAP Project (http://www.openldap.org/). diff --git a/doc/man/man3/ldap_first_message.3 b/doc/man/man3/ldap_first_message.3 index dd0cce2baf..f341319d3c 100644 --- a/doc/man/man3/ldap_first_message.3 +++ b/doc/man/man3/ldap_first_message.3 @@ -71,12 +71,12 @@ NULL is returned. If an error occurs in .BR ldap_count_messages() , -1 is returned. .SH SEE ALSO -.BR ldap(3), -.BR ldap_search(3), -.BR ldap_result(3), -.BR ldap_parse_result(3), -.BR ldap_first_entry(3), -.BR ldap_first_reference(3) +.BR ldap (3), +.BR ldap_search (3), +.BR ldap_result (3), +.BR ldap_parse_result (3), +.BR ldap_first_entry (3), +.BR ldap_first_reference (3) .SH ACKNOWLEDGEMENTS .B OpenLDAP is developed and maintained by The OpenLDAP Project (http://www.openldap.org/). diff --git a/doc/man/man3/ldap_first_reference.3 b/doc/man/man3/ldap_first_reference.3 index 1fc1eda636..fe9bda4b9c 100644 --- a/doc/man/man3/ldap_first_reference.3 +++ b/doc/man/man3/ldap_first_reference.3 @@ -62,10 +62,10 @@ NULL is returned. If an error occurs in .BR ldap_count_references() , -1 is returned. .SH SEE ALSO -.BR ldap(3), -.BR ldap_result(3), -.BR ldap_search(3), -.BR ldap_parse_reference(3) +.BR ldap (3), +.BR ldap_result (3), +.BR ldap_search (3), +.BR ldap_parse_reference (3) .SH ACKNOWLEDGEMENTS .B OpenLDAP is developed and maintained by The OpenLDAP Project (http://www.openldap.org/). diff --git a/doc/man/man3/ldap_get_dn.3 b/doc/man/man3/ldap_get_dn.3 index 9784cd7027..c86c0de6f7 100644 --- a/doc/man/man3/ldap_get_dn.3 +++ b/doc/man/man3/ldap_get_dn.3 @@ -219,11 +219,11 @@ set appropriately in case of trouble. .SH NOTES These routines dynamically allocate memory that the caller must free. .SH SEE ALSO -.BR ldap(3), -.BR ldap_error(3), -.BR ldap_first_entry(3), -.BR ldap_memfree(3), -.BR ldap_value_free(3) +.BR ldap (3), +.BR ldap_error (3), +.BR ldap_first_entry (3), +.BR ldap_memfree (3), +.BR ldap_value_free (3) .SH ACKNOWLEDGEMENTS .B OpenLDAP is developed and maintained by The OpenLDAP Project (http://www.openldap.org/). diff --git a/doc/man/man3/ldap_get_values.3 b/doc/man/man3/ldap_get_values.3 index eebb117a5f..e9acf3d207 100644 --- a/doc/man/man3/ldap_get_values.3 +++ b/doc/man/man3/ldap_get_values.3 @@ -92,10 +92,10 @@ for a description of possible error codes. These routines dynamically allocate memory which the caller must free using the supplied routines. .SH SEE ALSO -.BR ldap(3), -.BR ldap_first_entry(3), -.BR ldap_first_attribute(3), -.BR ldap_error(3) +.BR ldap (3), +.BR ldap_first_entry (3), +.BR ldap_first_attribute (3), +.BR ldap_error (3) .SH ACKNOWLEDGEMENTS .B OpenLDAP is developed and maintained by The OpenLDAP Project (http://www.openldap.org/). diff --git a/doc/man/man3/ldap_parse_result.3 b/doc/man/man3/ldap_parse_result.3 index 4cb95dcc49..d30115ac77 100644 --- a/doc/man/man3/ldap_parse_result.3 +++ b/doc/man/man3/ldap_parse_result.3 @@ -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 results (skipping past other message types). They take the \fIresult\fP as returned by a call to -.BR ldap_result (3) , +.BR ldap_result (3), .BR ldap_search_s (3) or -.BR ldap_search_st (3) . +.BR ldap_search_st (3). In addition to -.B ldap_parse_result() , +.BR ldap_parse_result() , the routines .B ldap_parse_sasl_bind_result() and @@ -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 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 -.BR ldap_memfree(3) . +.BR ldap_memfree (3). .LP The \fIerrmsgp\fP parameter will be filled in with the error message field from the parsed message. This string should be freed using -.BR ldap_memfree(3) . +.BR ldap_memfree (3). .LP 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 -.BR ldap_value_free(3) . +.BR ldap_value_free (3). If no referrals were returned, \fI*referralsp\fP is set to NULL. .LP 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 -.BR ldap_controls_free(3) . +.BR ldap_controls_free (3). If no controls were returned, \fI*serverctrlsp\fP is set to NULL. .LP The \fIfreeit\fP parameter determines whether the parsed message is freed or not after the extraction. Any non-zero value will make it free the message. The -.BR ldap_msgfree(3) +.BR ldap_msgfree (3) routine can also be used to free the message later. .LP For SASL bind results, the \fIservercredp\fP parameter will be filled in with an allocated berval structure containing the credentials from the server if present. The structure should be freed using -.BR ber_bvfree(3) . +.BR ber_bvfree (3). .LP For extended results, the \fIretoidp\fP parameter will be filled in with the dotted-OID text representation of the name of the extended 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. .LP For extended results, the \fIretdatap\fP parameter will be filled in with a pointer to a berval structure containing the data from the 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. .LP For all the above result parameters, NULL values can be used in calls @@ -92,12 +92,12 @@ in order to ignore certain fields. Upon success LDAP_SUCCESS is returned. Otherwise the values of the result parameters are undefined. .SH SEE ALSO -.BR ldap (3) -.BR ldap_result (3) -.BR ldap_search (3) -.BR ldap_memfree (3) -.BR ldap_get_values (3) -.BR ldap_controls_free (3) +.BR ldap (3), +.BR ldap_result (3), +.BR ldap_search (3), +.BR ldap_memfree (3), +.BR ldap_get_values (3), +.BR ldap_controls_free (3), .BR lber-types (3) .SH ACKNOWLEDGEMENTS .B OpenLDAP diff --git a/doc/man/man3/ldap_schema.3 b/doc/man/man3/ldap_schema.3 index 11a7bfc739..27c6446671 100644 --- a/doc/man/man3/ldap_schema.3 +++ b/doc/man/man3/ldap_schema.3 @@ -320,7 +320,7 @@ Duplicate option. Unexpected end of data. .SH SEE ALSO -.BR ldap (3), +.BR ldap (3) .SH ACKNOWLEDGEMENTS .B OpenLDAP is developed and maintained by The OpenLDAP Project (http://www.openldap.org/). diff --git a/doc/man/man5/ldap.conf.5 b/doc/man/man5/ldap.conf.5 index dec57bbff5..85ed4e245f 100644 --- a/doc/man/man5/ldap.conf.5 +++ b/doc/man/man5/ldap.conf.5 @@ -1,4 +1,4 @@ -.TH LDAP.CONF 5 "20 August 2000" "OpenLDAP LDVERSION" +.TH LDAP.CONF 5 "6 May 2002" "OpenLDAP LDVERSION" .\" $OpenLDAP$ .\" Copyright 1998-2002 The OpenLDAP Foundation All Rights Reserved. .\" Copying restrictions apply. See COPYRIGHT/LICENSE. @@ -18,9 +18,14 @@ clients. If the environment variable \fBLDAPNOINIT\fP is defined, all defaulting is disabled. .LP Each user may specify an optional configuration file, +.IR ldaprc +or .IR .ldaprc , in his/her home directory which will be used to override the system-wide defaults file. +The file +.IR ldaprc +in the current working directory is also used. .LP Additional configuration files can be specified using the \fBLDAPCONF\fP and \fBLDAPRC\fP environment variables. @@ -128,14 +133,31 @@ or to specify that aliases are never dereferenced, always dereferenced, dereferenced when searching, or dereferenced only when locating the base object for the search. The default is to never dereference aliases. +.SH "ENVIRONMENT VARIABLES" +.TP +LDAPNOINIT +disable all defaulting +.TP +LDAPCONF +path of a configuration file +.TP +LDAPRC +basename of ldaprc file in $HOME or $CWD +.TP +LDAP +Set as from ldap.conf .SH FILES +.TP .I ETCDIR/ldap.conf -.LP -.I $HOME/.ldaprc -.LP -.I $CWD/.ldaprc +system-wide ldap configuration file +.TP +.I $HOME/ldaprc, $HOME/.ldaprc +user ldap configuration file +.TP +.I $CWD/ldaprc +local ldap configuration file .SH "SEE ALSO" -ldap(3) +.BR ldap (3) .SH AUTHOR Kurt Zeilenga, The OpenLDAP Project .SH ACKNOWLEDGEMENTS diff --git a/doc/man/man5/slapd-bdb.5 b/doc/man/man5/slapd-bdb.5 index 630aecb545..0dfdb8ba9e 100644 --- a/doc/man/man5/slapd-bdb.5 +++ b/doc/man/man5/slapd-bdb.5 @@ -95,7 +95,9 @@ Specify the file protection mode that newly created database index files should have. The default is 0600. .SH FILES +.TP ETCDIR/slapd.conf +default slapd configuration file .SH SEE ALSO .BR slapd.conf (5), .BR slapd (8), diff --git a/doc/man/man5/slapd-dnssrv.5 b/doc/man/man5/slapd-dnssrv.5 index d7aaf031ae..9e3fbdf3aa 100644 --- a/doc/man/man5/slapd-dnssrv.5 +++ b/doc/man/man5/slapd-dnssrv.5 @@ -16,7 +16,9 @@ The DNSSRV backend has no backend nor database specific options. It is configured simply by "database dnssrv" followed a suffix directive, e.g. suffix "". .SH FILES +.TP ETCDIR/slapd.conf +default slapd configuration file .br .SH SEE ALSO \fB"OpenLDAP Root Service - An experimental LDAP referral diff --git a/doc/man/man5/slapd-ldap.5 b/doc/man/man5/slapd-ldap.5 index e22d94479b..192d0e7159 100644 --- a/doc/man/man5/slapd-ldap.5 +++ b/doc/man/man5/slapd-ldap.5 @@ -108,7 +108,9 @@ any other attribute gets "removed" from the object before it is sent to the client (or sent up to the LDAP server). This is obviously a simplistic example, but you get the point. .SH FILES +.TP ETCDIR/slapd.conf +default slapd configuration file .SH SEE ALSO .BR slapd.conf (5), .BR slapd-meta (5), diff --git a/doc/man/man5/slapd-ldbm.5 b/doc/man/man5/slapd-ldbm.5 index 6affd08585..3fd0c3bff1 100644 --- a/doc/man/man5/slapd-ldbm.5 +++ b/doc/man/man5/slapd-ldbm.5 @@ -115,7 +115,9 @@ Specify the file protection mode that newly created database index files should have. The default is 0600. .SH FILES +.TP ETCDIR/slapd.conf +default slapd configuration file .SH SEE ALSO .BR slapd.conf (5), .BR slapd (8), diff --git a/doc/man/man5/slapd-meta.5 b/doc/man/man5/slapd-meta.5 index ec37ff98f8..6671174e4d 100644 --- a/doc/man/man5/slapd-meta.5 +++ b/doc/man/man5/slapd-meta.5 @@ -1,4 +1,4 @@ -.TH SLAPD_META 5 "2 May 2002" "OpenLDAP LDVERSION" +.TH SLAPD-META 5 "2 May 2002" "OpenLDAP LDVERSION" .\" Copyright 1998-2002 The OpenLDAP Foundation, All Rights Reserved. .\" Copying restrictions apply. See the COPYRIGHT file. .\" Copyright 2001, Pierangelo Masarati, All rights reserved. @@ -8,7 +8,7 @@ .\" and maybe manual pages for librewrite. .\" .SH NAME -slapd_meta \- metadirectory backend +slapd-meta \- metadirectory backend .SH SYNOPSIS ETCDIR/slapd.conf .SH DESCRIPTION @@ -658,7 +658,9 @@ been written: .LP with the advantage of saving one rewrite pass ...) .SH FILES +.TP ETCDIR/slapd.conf +default slapd configuration file .SH SEE ALSO .BR slapd.conf (5), .BR slapd\-ldap (5), diff --git a/doc/man/man5/slapd-null.5 b/doc/man/man5/slapd-null.5 index b9d7908b00..fad41f5560 100644 --- a/doc/man/man5/slapd-null.5 +++ b/doc/man/man5/slapd-null.5 @@ -43,7 +43,9 @@ bind on .fi .RE .SH FILES +.TP ETCDIR/slapd.conf +default slapd configuration file .SH SEE ALSO .BR slapd.conf (5), .BR slapd (8). diff --git a/doc/man/man5/slapd-passwd.5 b/doc/man/man5/slapd-passwd.5 index 20456f1845..6765d2e3c5 100644 --- a/doc/man/man5/slapd-passwd.5 +++ b/doc/man/man5/slapd-passwd.5 @@ -30,9 +30,12 @@ Specifies an alternate passwd file to use. The default is .BR /etc/passwd . .SH FILES +.TP ETCDIR/slapd.conf -.br +default slapd configuration file +.TP /etc/passwd +user account information .SH SEE ALSO .BR slapd.conf (5), .BR slapd (8), diff --git a/doc/man/man5/slapd-perl.5 b/doc/man/man5/slapd-perl.5 index 0c83dceee8..d544a4412d 100644 --- a/doc/man/man5/slapd-perl.5 +++ b/doc/man/man5/slapd-perl.5 @@ -166,7 +166,9 @@ direcetory in the OpenLDAP source tree. The interface of this backend to the perl module MAY change. Any suggestions would greatly be appreciated. .SH FILES +.TP ETCDIR/slapd.conf +default slapd configuration file .SH SEE ALSO .BR slapd.conf (5), .BR slapd (8), diff --git a/doc/man/man5/slapd-shell.5 b/doc/man/man5/slapd-shell.5 index af039f984a..737f277365 100644 --- a/doc/man/man5/slapd-shell.5 +++ b/doc/man/man5/slapd-shell.5 @@ -139,7 +139,9 @@ Lines starting with `#' or `DEBUG:' are ignored. There is an example search script in the slapd/back-shell/ directory in the OpenLDAP source tree. .SH FILES +.TP ETCDIR/slapd.conf +default slapd configuration file .SH SEE ALSO .BR slapd.conf (5), .BR slapd (8), diff --git a/doc/man/man5/slapd-sql.5 b/doc/man/man5/slapd-sql.5 index 31fae83623..b01e04df86 100644 --- a/doc/man/man5/slapd-sql.5 +++ b/doc/man/man5/slapd-sql.5 @@ -375,7 +375,9 @@ described in the Administrators Guide. There are example SQL modules in the slapd/back-sql/rdbms_depend/ directory in the OpenLDAP source tree. .SH FILES +.TP ETCDIR/slapd.conf +default slapd configuration file .SH SEE ALSO .BR slapd.conf (5), .BR slapd (8). diff --git a/doc/man/man5/slapd-tcl.5 b/doc/man/man5/slapd-tcl.5 index c4ada1fa5f..bf45a49d35 100644 --- a/doc/man/man5/slapd-tcl.5 +++ b/doc/man/man5/slapd-tcl.5 @@ -247,7 +247,9 @@ Allows you to send debug messages through OpenLDAP's native debugging system, this is sent as a LDAP_DEBUG_ANY and will be logged. Useful for debugging scripts or logging bind failures. .SH FILES +.TP ETCDIR/slapd.conf +default slapd configuration file .SH SEE ALSO .BR slapd.conf (5), .BR slapd (8), diff --git a/doc/man/man5/slapd.access.5 b/doc/man/man5/slapd.access.5 index 6be551c1cd..4b30c60e84 100644 --- a/doc/man/man5/slapd.access.5 +++ b/doc/man/man5/slapd.access.5 @@ -412,7 +412,9 @@ or the (even more silly) example which grants everybody search and compare privileges, and adds read privileges to authenticated users. .SH FILES +.TP ETCDIR/slapd.conf +default slapd configuration file .SH SEE ALSO .BR slapd (8), .LP diff --git a/doc/man/man5/slapd.conf.5 b/doc/man/man5/slapd.conf.5 index 5692deb51c..3c9ed2bc52 100644 --- a/doc/man/man5/slapd.conf.5 +++ b/doc/man/man5/slapd.conf.5 @@ -253,7 +253,7 @@ to allow any level of depth match, not including the exact match; .BR regex explicitly requires the (default) match based on regular expression pattern, as detailed in -.BR regex(7). +.BR regex (7). Finally, .B anonymous matches unbound operations; the @@ -985,10 +985,13 @@ lastmod off example of a configuration file. The original ETCDIR/slapd.conf is another example. .SH FILES +.TP ETCDIR/slapd.conf +default slapd configuration file .SH SEE ALSO .BR ldap (3), .BR slapd-bdb (5), +.BR slapd-dnssrv (5), .BR slapd-ldap (5), .BR slapd-ldbm (5), .BR slapd-meta (5), diff --git a/doc/man/man5/slapd.replog.5 b/doc/man/man5/slapd.replog.5 index 5e67091edd..46586e2c22 100644 --- a/doc/man/man5/slapd.replog.5 +++ b/doc/man/man5/slapd.replog.5 @@ -10,7 +10,7 @@ slapd.replog.lock .SH DESCRIPTION .LP The file slapd.replog is produced by the stand-alone LDAP daemon, -.IR slapd , +.BR slapd (8), when changes are made to its local database that are to be propagated to one or more replica .IR slapd s. @@ -20,7 +20,7 @@ or deletion from the .I slapd database. The file is meant to be read and processed by -.IR slurpd , +.BR slurpd (8), the stand-alone LDAP update replication daemon. The records are separated by a blank line. Each record has the following format. .LP @@ -152,8 +152,12 @@ on one of each type of change. deleteoldrdn: 0 .fi .SH FILES +.TP slapd.replog +slapd replication log file +.TP slapd.replog.lock +lockfile for slapd.replog .SH SEE ALSO .BR ldap (3), .BR ldif (5), diff --git a/doc/man/man5/ud.conf.5 b/doc/man/man5/ud.conf.5 index 5ccb3b57f4..8dbd40a0eb 100644 --- a/doc/man/man5/ud.conf.5 +++ b/doc/man/man5/ud.conf.5 @@ -91,10 +91,15 @@ For example, causes this algorithm to be applied when the number of fields is exactly equal to one. If there is exactly one field, the token is looked up as a UID. .SH FILES +.TP .I ETCDIR/ud.conf +system-wide ud configuration file +.TP +.I $HOME/.udrc +personal ud configuration file, overriding system file .SH "SEE ALSO" -ud(1), -ldap(3) +.BR ud (1), +.BR ldap (3) .SH AUTHOR Bryan Beecher, University of Michigan .SH ACKNOWLEDGEMENTS diff --git a/doc/man/man8/mail500.8 b/doc/man/man8/mail500.8 index 21ed0f48eb..58c157ed25 100644 --- a/doc/man/man8/mail500.8 +++ b/doc/man/man8/mail500.8 @@ -285,9 +285,9 @@ would behave appropriately based on how they were invoked. Unfortunately, several new features (e.g. vacation support) were added to mail500 but not to fax500. .SH "SEE ALSO" -.BR ldap(3), -.BR sendmail.cf(5), -.BR sendmail(8), +.BR ldap (3), +.BR sendmail.cf (5), +.BR sendmail (8) .SH ACKNOWLEDGEMENTS .B OpenLDAP is developed and maintained by The OpenLDAP Project (http://www.openldap.org/). -- 2.39.5