local-lib5/man/man3/URI::ldap.3pm

   1 .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.3
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sh \" Subsection heading
   6 .br
   7 .if t .Sp
   8 .ne 5
   9 .PP
  10 \fB\\$1\fR
  11 .PP
  12 ..
  13 .de Sp \" Vertical space (when we can't use .PP)
  14 .if t .sp .5v
  15 .if n .sp
  16 ..
  17 .de Vb \" Begin verbatim text
  18 .ft CW
  19 .nf
  20 .ne \\$1
  21 ..
  22 .de Ve \" End verbatim text
  23 .ft R
  24 .fi
  25 ..
  26 .\" Set up some character translations and predefined strings.  \*(-- will
  27 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  28 .\" double quote, and \*(R" will give a right double quote.  | will give a
  29 .\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
  30 .\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
  31 .\" expand to `' in nroff, nothing in troff, for use with C<>.
  32 .tr \(*W-|\(bv\*(Tr
  33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  34 .ie n \{\
  35 .    ds -- \(*W-
  36 .    ds PI pi
  37 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  38 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  39 .    ds L" ""
  40 .    ds R" ""
  41 .    ds C` ""
  42 .    ds C' ""
  43 'br\}
  44 .el\{\
  45 .    ds -- \|\(em\|
  46 .    ds PI \(*p
  47 .    ds L" ``
  48 .    ds R" ''
  49 'br\}
  50 .\"
  51 .\" If the F register is turned on, we'll generate index entries on stderr for
  52 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
  53 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  54 .\" output yourself in some meaningful fashion.
  55 .if \nF \{\
  56 .    de IX
  57 .    tm Index:\\$1\t\\n%\t"\\$2"
  58 ..
  59 .    nr % 0
  60 .    rr F
  61 .\}
  62 .\"
  63 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
  64 .\" way too many mistakes in technical documents.
  65 .hy 0
  66 .if n .na
  67 .\"
  68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  69 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  70 .    \" fudge factors for nroff and troff
  71 .if n \{\
  72 .    ds #H 0
  73 .    ds #V .8m
  74 .    ds #F .3m
  75 .    ds #[ \f1
  76 .    ds #] \fP
  77 .\}
  78 .if t \{\
  79 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  80 .    ds #V .6m
  81 .    ds #F 0
  82 .    ds #[ \&
  83 .    ds #] \&
  84 .\}
  85 .    \" simple accents for nroff and troff
  86 .if n \{\
  87 .    ds ' \&
  88 .    ds ` \&
  89 .    ds ^ \&
  90 .    ds , \&
  91 .    ds ~ ~
  92 .    ds /
  93 .\}
  94 .if t \{\
  95 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  96 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  97 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  98 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  99 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 100 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 101 .\}
 102 .    \" troff and (daisy-wheel) nroff accents
 103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 110 .ds ae a\h'-(\w'a'u*4/10)'e
 111 .ds Ae A\h'-(\w'A'u*4/10)'E
 112 .    \" corrections for vroff
 113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 115 .    \" for low resolution devices (crt and lpr)
 116 .if \n(.H>23 .if \n(.V>19 \
 117 \{\
 118 .    ds : e
 119 .    ds 8 ss
 120 .    ds o a
 121 .    ds d- d\h'-1'\(ga
 122 .    ds D- D\h'-1'\(hy
 123 .    ds th \o'bp'
 124 .    ds Th \o'LP'
 125 .    ds ae ae
 126 .    ds Ae AE
 127 .\}
 128 .rm #[ #] #H #V #F C
 129 .\" ========================================================================
 130 .\"
 131 .IX Title "URI::ldap 3"
 132 .TH URI::ldap 3 "2008-04-04" "perl v5.8.7" "User Contributed Perl Documentation"
 133 .SH "NAME"
 134 URI::ldap \- LDAP Uniform Resource Locators
 135 .SH "SYNOPSIS"
 136 .IX Header "SYNOPSIS"
 137 .Vb 1
 138 \&  use URI;
 139 .Ve
 140 .PP
 141 .Vb 6
 142 \&  $uri = URI\->new("ldap:$uri_string");
 143 \&  $dn     = $uri\->dn;
 144 \&  $filter = $uri\->filter;
 145 \&  @attr   = $uri\->attributes;
 146 \&  $scope  = $uri\->scope;
 147 \&  %extn   = $uri\->extensions;
 148 .Ve
 149 .PP
 150 .Vb 7
 151 \&  $uri = URI\->new("ldap:");  # start empty
 152 \&  $uri\->host("ldap.itd.umich.edu");
 153 \&  $uri\->dn("o=University of Michigan,c=US");
 154 \&  $uri\->attributes(qw(postalAddress));
 155 \&  $uri\->scope('sub');
 156 \&  $uri\->filter('(cn=Babs Jensen)');
 157 \&  print $uri\->as_string,"\en";
 158 .Ve
 159 .SH "DESCRIPTION"
 160 .IX Header "DESCRIPTION"
 161 \&\f(CW\*(C`URI::ldap\*(C'\fR provides an interface to parse an \s-1LDAP\s0 \s-1URI\s0 into its
 162 constituent parts and also to build a \s-1URI\s0 as described in
 163 \&\s-1RFC\s0 2255.
 164 .SH "METHODS"
 165 .IX Header "METHODS"
 166 \&\f(CW\*(C`URI::ldap\*(C'\fR supports all the generic and server methods defined by
 167 \&\s-1URI\s0, plus the following.
 168 .PP
 169 Each of the following methods can be used to set or get the value in
 170 the \s-1URI\s0. The values are passed in unescaped form.  None of these
 171 return undefined values, but elements without a default can be empty.
 172 If arguments are given, then a new value is set for the given part
 173 of the \s-1URI\s0.
 174 .IP "$uri\->dn( [$new_dn] )" 4
 175 .IX Item "$uri->dn( [$new_dn] )"
 176 Sets or gets the \fIDistinguished Name\fR part of the \s-1URI\s0.  The \s-1DN\s0
 177 identifies the base object of the \s-1LDAP\s0 search.
 178 .IP "$uri\->attributes( [@new_attrs] )" 4
 179 .IX Item "$uri->attributes( [@new_attrs] )"
 180 Sets or gets the list of attribute names which are
 181 returned by the search.
 182 .IP "$uri\->scope( [$new_scope] )" 4
 183 .IX Item "$uri->scope( [$new_scope] )"
 184 Sets or gets the scope to be used by the search. The value can be one of
 185 \&\f(CW"base"\fR, \f(CW"one"\fR or \f(CW"sub"\fR. If none is given in the \s-1URI\s0 then the
 186 return value defaults to \f(CW"base"\fR.
 187 .IP "$uri\->_scope( [$new_scope] )" 4
 188 .IX Item "$uri->_scope( [$new_scope] )"
 189 Same as \fIscope()\fR, but does not default to anything.
 190 .IP "$uri\->filter( [$new_filter] )" 4
 191 .IX Item "$uri->filter( [$new_filter] )"
 192 Sets or gets the filter to be used by the search. If none is given in
 193 the \s-1URI\s0 then the return value defaults to \f(CW"(objectClass=*)"\fR.
 194 .IP "$uri\->_filter( [$new_filter] )" 4
 195 .IX Item "$uri->_filter( [$new_filter] )"
 196 Same as \fIfilter()\fR, but does not default to anything.
 197 .ie n .IP "$uri\->extensions( [$etype => $evalue,...] )" 4
 198 .el .IP "$uri\->extensions( [$etype => \f(CW$evalue\fR,...] )" 4
 199 .IX Item "$uri->extensions( [$etype => $evalue,...] )"
 200 Sets or gets the extensions used for the search. The list passed should
 201 be in the form etype1 => evalue1, etype2 => evalue2,... This is also
 202 the form of list that is returned.
 203 .SH "SEE ALSO"
 204 .IX Header "SEE ALSO"
 205 \&\s-1RFC\-2255\s0
 206 .SH "AUTHOR"
 207 .IX Header "AUTHOR"
 208 Graham Barr <\fIgbarr@pobox.com\fR>
 209 .PP
 210 Slightly modified by Gisle Aas to fit into the \s-1URI\s0 distribution.
 211 .SH "COPYRIGHT"
 212 .IX Header "COPYRIGHT"
 213 Copyright (c) 1998 Graham Barr. All rights reserved. This program is
 214 free software; you can redistribute it and/or modify it under the same
 215 terms as Perl itself.