1 .TH LDAPURL 1 "RELEASEDATE" "OpenLDAP LDVERSION"
3 .\" Copyright 2008-2011 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 \ [ ! ] \fIext\fP [ =\fIextparam\fP ]]
16 .BR \-E \ [ ! ] \fIext\fP [ =\fIextparam\fP ]]
22 .BI \-h \ ldaphost\fR]
24 .BI \-p \ ldapport\fR]
26 .BR \-s \ { base \||\| one \||\| sub \||\| children }]
31 is a command that allows to either compose or decompose LDAP URIs.
33 When invoked with the \fB\-H\fP option,
35 extracts the components of the \fIldapuri\fP option argument,
36 unescaping hex-escaped chars as required.
37 It basically acts as a frontend to the
38 .BR ldap_url_parse (3)
40 Otherwise, it builds an LDAP URI based on the components
41 passed with the appropriate options, performing the inverse operation.
42 Option \fB\-H\fP is incompatible with options
57 Set a comma-separated list of attribute selectors.
60 Set the \fIsearchbase\fP.
62 .BR \-e \ [ ! ] \fIext\fP [ =\fIextparam\fP ]
64 Specify general extensions with \fB\-e\fP
65 \'\fB!\fP\' indicates criticality.
69 [!]assert=<filter> (an RFC 4515 Filter)
70 !authzid=<authzid> ("dn:<dn>" or "u:<user>")
71 [!]bauthzid (RFC 3829 authzid control)
72 [!]chaining[=<resolve>[/<cont>]]
76 [!]postread[=<attrs>] (a comma-separated attribute list)
77 [!]preread[=<attrs>] (a comma-separated attribute list)
79 sessiontracking[=<username>]
80 abandon,cancel,ignore (SIGINT sends abandon/cancel,
81 or ignores response; if critical, doesn't wait for SIGINT.
86 .BR \-E \ [ ! ] \fIext\fP [ =\fIextparam\fP ]
87 Set URL extensions; incompatible with
91 Set the URL filter. No particular check on conformity with RFC 4515
92 LDAP filters is performed, but the value is hex-escaped as required.
95 Specify URI to be exploded.
104 Set the URL scheme. Defaults for other fields, like \fIldapport\fP,
105 may depend on the value of \fIscheme\fP.
107 .BR \-s \ { base \||\| one \||\| sub \||\| children }
108 Specify the scope of the search to be one of
114 to specify a base object, one-level, subtree, or children search.
119 scope requires LDAPv3 subordinate feature extension.
122 If the \fB\-H\fP option is used, the \fIldapuri\fP supplied
123 is exploded in its components, which are printed to standard output
124 in an LDIF-like form.
126 Otherwise, the URI built using the values passed with the other options
127 is printed to standard output.
129 The following command:
132 ldapuri \-h ldap.example.com \-b dc=example,dc=com \-s sub \-f "(cn=Some One)"
138 ldap://ldap.example.com:389/dc=example,dc=com??sub?(cn=Some%20One)
144 ldapuri \-H ldap://ldap.example.com:389/dc=example,dc=com??sub?(cn=Some%20One)
151 host: ldap.example.com
153 dn: dc=example,dc=com
155 filter: (cn=Some One)
159 Exit status is zero if no errors occur.
160 Errors result in a non-zero exit status and
161 a diagnostic message being written to standard error.
164 .BR ldap_url_parse (3),
166 The OpenLDAP Project <http://www.openldap.org/>