1
.TH LDAPURL 1 "RELEASEDATE" "OpenLDAP LDVERSION"
2
.\" $OpenLDAP: pkg/ldap/doc/man/man1/ldapurl.1,v 1.1.2.2 2009/01/22 00:00:48 kurt Exp $
3
.\" Copyright 2008-2009 The OpenLDAP Foundation All Rights Reserved.
4
.\" Copying restrictions apply. See COPYRIGHT/LICENSE.
6
ldapurl \- LDAP URL formatting tool
12
.BI \-b \ searchbase\fR]
14
.BR \-E \ [!]ext[=extparam]]
20
.BI \-h \ ldaphost\fR]
22
.BI \-p \ ldapport\fR]
24
.BI \-s \ base\fR\||\|\fIone\fR\||\|\fIsub\fR\||\|\fIchildren\fR]
29
is a command that allows to either compose or decompose LDAP URIs.
31
When invoked with the \fI-H\fP option,
33
extracts the components of the \fIldapuri\fP option argument,
34
unescaping hex-escaped chars as required.
35
It basically acts as a frontend to the
36
.BR ldap_url_parse (3)
38
Otherwise, it builds an LDAP URI based on the components
39
passed with the appropriate options, performing the inverse operation.
40
Option \fI-H\fP is incompatible with options
55
Set a comma-separated list of attribute selectors.
58
Set the \fIsearchbase\fP.
60
.B \-E \fI[!]ext[=extparam]\fP
61
Set URL extensions; \'!\' indicates criticality.
64
Set the URL filter. No particular check on conformity with RFC 4515
65
LDAP filters is performed, but the value is hex-escaped as required.
68
Specify URI to be exploded.
77
Set the URL scheme. Defaults for other fields, like \fIldapport\fP,
78
may depend on the value of \fIscheme\fP.
80
.BI \-s \ base\fR\||\|\fIone\fR\||\|\fIsub\fR\||\|\fIchildren
81
Specify the scope of the search to be one of
87
to specify a base object, one-level, subtree, or children search.
92
scope requires LDAPv3 subordinate feature extension.
95
If the \fI-H\fP option is used, the \fIldapuri\fP supplied
96
is exploded in its components, which are printed to standard output
99
Otherwise, the URI built using the values passed with the other options
100
is printed to standard output.
102
The following command:
105
ldapuri -h ldap.example.com -b dc=example,dc=com -s sub -f (cn=Some One)
111
ldap://ldap.example.com:389/dc=example,dc=com??sub?(cn=Some%20One)
117
ldapuri -H ldap://ldap.example.com:389/dc=example,dc=com??sub?(cn=Some%20One)
124
host: ldap.example.com
126
dn: dc=example,dc=com
128
filter: (cn=Some One)
132
Exit status is zero if no errors occur.
133
Errors result in a non-zero exit status and
134
a diagnostic message being written to standard error.
137
.BR ldap_url_parse (3),
139
The OpenLDAP Project <http://www.openldap.org/>