[SCM] Packaging of Net::Citadel in Debian branch, debian, updated. debian/0.16-1-45-gd21e85b

Robert James Clay jame at rocasa.us
Wed Jun 5 17:20:28 UTC 2013


The following commit has been merged in the debian branch:
commit 6038e21ae713c5734a4660cbf40997e3b543d263
Author: Robert James Clay <jame at rocasa.us>
Date:   Sun Oct 21 17:24:12 2012 -0400

    Expand the documentation for the new citadel_info function.

diff --git a/lib/Net/Citadel.pm b/lib/Net/Citadel.pm
index 0427ed2..836c6c7 100644
--- a/lib/Net/Citadel.pm
+++ b/lib/Net/Citadel.pm
@@ -719,10 +719,20 @@ sub citadel_echo {
 
 =item I<citadel_info>
 
-$ctdl_inforef = I<$c>->citadel_info()
+$info_aref = I<$c>->citadel_info()
 
-Sends an INFO command to the Citadel server and returns the lines it receives
-from that as a reference to an array.
+Sends the C<INFO> command to the Citadel server and returns the lines it receives
+from that as a reference to an array. An example of getting and then displaying the
+server information lines the following:
+
+ my $c = new Net::Citadel (host => $host_name);
+ my $info_aref = $c->citadel_info;
+ foreach $line (@{$info_aref}) {
+    print $line;
+ }
+
+For more details about the server information lines that are returned, see the
+C<INFO> entry at L<http://www.citadel.org/doku.php/documentation:appproto:connection>.
 
 =cut
 

-- 
Packaging of Net::Citadel in Debian



More information about the Pkg-perl-cvs-commits mailing list