ldapfriendly(5) [redhat man page]

LDAPFRIENDLY(5) 						File Formats Manual						   LDAPFRIENDLY(5)

NAME

       ldapfriendly - data file for LDAP friendly routines

SYNOPSIS

       /usr/share/openldap/ldapfriendly

DESCRIPTION

       The  file  /usr/share/openldap/ldapfriendly contains simple mapping information used by the ldap_friendly_name(3) routine.  Blank lines and
       lines that have a first character of `#' are treated as comments and ignored.  The information consists of lines that contain an "unfriend-
       ly" name, a tab, and a "friendly" name.

       Other  friendly	mapping  files	can  be  created  and used by ldap_friendly_name(3).  Just use the same format as that described above and
       include the file name in the ldap_friendly_name() call.

FILES

       /usr/share/openldap/ldapfriendly

SEE ALSO

       ldap(3), ldap_friendly_name(3)

ACKNOWLEDGEMENTS

       OpenLDAP is developed and maintained by The OpenLDAP Project (http://www.openldap.org/).  OpenLDAP is derived from University  of  Michigan
       LDAP 3.3 Release.

OpenLDAP 2.0.27-Release 					  20 August 2000						   LDAPFRIENDLY(5)

LDAP_FRIENDLY(3)					     Library Functions Manual						  LDAP_FRIENDLY(3)

NAME

       ldap_friendly_name, ldap_free_friendlymap - LDAP unfriendly to friendly name mapping routine

SYNOPSIS

       #include <ldap.h>

       typedef struct ldap_friendly {
	       char *lf_unfriendly;
	       char *lf_friendly;
       } LDAPFriendlyMap;

       char *ldap_friendly_name(filename, name, map)
       char *filename;
       char *name;
       LDAPFriendlyMap **map;

       void ldap_free_friendlymap(map)
       LDAPFriendlyMap **map;

DESCRIPTION

       This  routine  is used to map one set of strings to another.  Typically, this is done for country names, to map from the two-letter country
       codes to longer more readable names.  The mechanism is general enough to be used with other things, though.

       filename is the name of a file containing the unfriendly to friendly mapping, name is the unfriendly name to map to a  friendly	name,  and
       map  is a result-parameter that should be set to NULL on the first call.  It is then used to hold the mapping in core so that the file need
       not be read on subsequent calls.

       For example:

	       LDAPFriendlyMap *map = NULL;

	       printf( "unfriendly %s => friendly %s
", name,
		   ldap_friendly_name( "/usr/share/openldap/ldapfriendly", name, &map ) );

       The mapping file should contain lines like this: unfriendlyname	friendlyname.  Lines that begin with a '#' character are comments and  are
       ignored.

       The  ldap_free_friendlymap()  call  is used to free structures allocated by ldap_friendly_name() when no more calls to ldap_friendly_name()
       are to be made.

ERRORS

       NULL is returned by ldap_friendly_name() if there is an error opening filename, or if the file has a bad format, or if the map parameter is
       NULL.

FILES

       /usr/share/openldap/ldapfriendly.conf

SEE ALSO

       ldap(3)

ACKNOWLEDGEMENTS

       OpenLDAP  is  developed and maintained by The OpenLDAP Project (http://www.openldap.org/).  OpenLDAP is derived from University of Michigan
       LDAP 3.3 Release.

OpenLDAP 2.0.27-Release 					 22 September 1998						  LDAP_FRIENDLY(3)