Edit File: URI::ldap.3pm
.\" Automatically generated by Pod::Man 2.22 (Pod::Simple 3.13) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is turned on, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .ie \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . nr % 0 . rr F .\} .el \{\ . de IX .. .\} .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "URI::ldap 3" .TH URI::ldap 3 "2015-02-24" "perl v5.10.1" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" URI::ldap \- LDAP Uniform Resource Locators .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& use URI; \& \& $uri = URI\->new("ldap:$uri_string"); \& $dn = $uri\->dn; \& $filter = $uri\->filter; \& @attr = $uri\->attributes; \& $scope = $uri\->scope; \& %extn = $uri\->extensions; \& \& $uri = URI\->new("ldap:"); # start empty \& $uri\->host("ldap.itd.umich.edu"); \& $uri\->dn("o=University of Michigan,c=US"); \& $uri\->attributes(qw(postalAddress)); \& $uri\->scope(\*(Aqsub\*(Aq); \& $uri\->filter(\*(Aq(cn=Babs Jensen)\*(Aq); \& print $uri\->as_string,"\en"; .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" \&\f(CW\*(C`URI::ldap\*(C'\fR provides an interface to parse an \s-1LDAP\s0 \s-1URI\s0 into its constituent parts and also to build a \s-1URI\s0 as described in \&\s-1RFC\s0 2255. .SH "METHODS" .IX Header "METHODS" \&\f(CW\*(C`URI::ldap\*(C'\fR supports all the generic and server methods defined by \&\s-1URI\s0, plus the following. .PP Each of the following methods can be used to set or get the value in the \s-1URI\s0. The values are passed in unescaped form. None of these return undefined values, but elements without a default can be empty. If arguments are given, then a new value is set for the given part of the \s-1URI\s0. .ie n .IP "$uri\->dn( [$new_dn] )" 4 .el .IP "\f(CW$uri\fR\->dn( [$new_dn] )" 4 .IX Item "$uri->dn( [$new_dn] )" Sets or gets the \fIDistinguished Name\fR part of the \s-1URI\s0. The \s-1DN\s0 identifies the base object of the \s-1LDAP\s0 search. .ie n .IP "$uri\->attributes( [@new_attrs] )" 4 .el .IP "\f(CW$uri\fR\->attributes( [@new_attrs] )" 4 .IX Item "$uri->attributes( [@new_attrs] )" Sets or gets the list of attribute names which are returned by the search. .ie n .IP "$uri\->scope( [$new_scope] )" 4 .el .IP "\f(CW$uri\fR\->scope( [$new_scope] )" 4 .IX Item "$uri->scope( [$new_scope] )" Sets or gets the scope to be used by the search. The value can be one of \&\f(CW"base"\fR, \f(CW"one"\fR or \f(CW"sub"\fR. If none is given in the \s-1URI\s0 then the return value defaults to \f(CW"base"\fR. .ie n .IP "$uri\->_scope( [$new_scope] )" 4 .el .IP "\f(CW$uri\fR\->_scope( [$new_scope] )" 4 .IX Item "$uri->_scope( [$new_scope] )" Same as \fIscope()\fR, but does not default to anything. .ie n .IP "$uri\->filter( [$new_filter] )" 4 .el .IP "\f(CW$uri\fR\->filter( [$new_filter] )" 4 .IX Item "$uri->filter( [$new_filter] )" Sets or gets the filter to be used by the search. If none is given in the \s-1URI\s0 then the return value defaults to \f(CW"(objectClass=*)"\fR. .ie n .IP "$uri\->_filter( [$new_filter] )" 4 .el .IP "\f(CW$uri\fR\->_filter( [$new_filter] )" 4 .IX Item "$uri->_filter( [$new_filter] )" Same as \fIfilter()\fR, but does not default to anything. .ie n .IP "$uri\->extensions( [$etype => $evalue,...] )" 4 .el .IP "\f(CW$uri\fR\->extensions( [$etype => \f(CW$evalue\fR,...] )" 4 .IX Item "$uri->extensions( [$etype => $evalue,...] )" Sets or gets the extensions used for the search. The list passed should be in the form etype1 => evalue1, etype2 => evalue2,... This is also the form of list that is returned. .SH "SEE ALSO" .IX Header "SEE ALSO" <http://tools.ietf.org/html/rfc2255> .SH "AUTHOR" .IX Header "AUTHOR" Graham Barr <\fIgbarr@pobox.com\fR> .PP Slightly modified by Gisle Aas to fit into the \s-1URI\s0 distribution. .SH "COPYRIGHT" .IX Header "COPYRIGHT" Copyright (c) 1998 Graham Barr. All rights reserved. This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.
Back to File Manager