LDAPI.pm: document environment variable LDAPI_SOCK and default

perl-ldap · Sep 28, 2012 · 3b170b8 · 3b170b8
1 parent 0e5156b
commit 3b170b8
Showing 1 changed file with 6 additions and 2 deletions.
diff --git a/lib/Net/LDAPI.pm b/lib/Net/LDAPI.pm
@@ -49,8 +49,12 @@ object; see L<Net::LDAP> for details.
 =item new ( [SOCKPATH] )
 
 Create a new connection. SOCKPATH can optionally be specified, to
-specify the location of the UNIX domain socket to connect to. See
-L<Net::LDAP/new> for details.
+specify the location of the UNIX domain socket to connect to.
+
+If SOCKPATH is not given, the environment variable C<LDAPI_SOCK> is evaluated,
+and if that does not exist, the value C</var/run/ldapi> is used.
+
+See L<Net::LDAP/new> for further details.
 
 =back