[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:30 UTC 2013
The following commit has been merged in the debian branch:
commit d539212a8d3f44e714ee13772a718d286d9cadd3
Author: Robert James Clay <jame at rocasa.us>
Date: Sun Oct 21 19:34:08 2012 -0400
Add documentation for the hash returned by the citadel_mrtg function.
diff --git a/lib/Net/Citadel.pm b/lib/Net/Citadel.pm
index 53e7b4a..e3dc918 100644
--- a/lib/Net/Citadel.pm
+++ b/lib/Net/Citadel.pm
@@ -764,6 +764,29 @@ Sends the C<MRTG> command to the Citadel server. It expects a type of either
C<users> or C<messages> to be passed to it and returns a hash containing the
information from the server.
+=over 4
+
+=item ActiveUsers
+Number of active users on the system. Only returned for type C<users>.
+
+=item ConnectedUsers
+
+Number of connected users on the system. Only returned for type C<users>.
+
+=item HighMsg
+
+Higest message number on the system. Only returned for type C<messages>.
+
+=item SystemUptime
+
+The uptime for the system formated as days, hours, minutes.
+
+=item SystemName
+
+Human readable name of the Citadel system.
+
+=back
+
=cut
sub citadel_mrtg {
--
Packaging of Net::Citadel in Debian
More information about the Pkg-perl-cvs-commits
mailing list