collectdctl: Moved examples section from help output to manpage.
authorSebastian Harl <sh@tokkee.org>
Mon, 9 Aug 2010 15:39:24 +0000 (17:39 +0200)
committerSebastian Harl <sh@tokkee.org>
Mon, 9 Aug 2010 15:39:24 +0000 (17:39 +0200)
src/collectdctl.c
src/collectdctl.pod

index af413cf..68b1675 100644 (file)
@@ -69,13 +69,6 @@ static void exit_usage (const char *name, int status) {
       "Hostname defaults to the local hostname if omitted (e.g., uptime/uptime).\n"
       "No error is returned if the specified identifier does not exist.\n"
 
-      "\nExample:\n\n"
-
-      "  collectdctl flush plugin=rrdtool identifie=somehost/cpu-0/cpu-wait\n\n"
-
-      "Flushes all CPU wait RRD values of the first CPU of the local host.\n"
-      "I.e., writes all pending RRD updates of that data-source to disk.\n"
-
       "\n"PACKAGE" "VERSION", http://collectd.org/\n"
       "by Florian octo Forster <octo@verplant.org>\n"
       "for contributions see `AUTHORS'\n"
index 8bd8970..aff67ef 100644 (file)
@@ -100,6 +100,24 @@ Hostname defaults to the local (non-fully qualified) hostname if omitted. No
 error is returned if the specified identifier does not exist (this is a
 limitation in the C<libcollectdclient> library).
 
+=head1 EXAMPLES
+
+=over 4
+
+=item C<collectdctl flush plugin=rrdtool identifier=somehost/cpu-0/cpu-wait>
+
+Flushes all CPU wait RRD values of the first CPU of the local host.
+I.E<nbsp>e., writes all pending RRD updates of that data-source to disk.
+
+=item C<for ident in `collectdctl listval | grep users/users`; do
+      collectdctl getval $ident;
+  done>
+
+Query the latest number of logged in users on all hosts known to the local
+collectd instance.
+
+=back
+
 =head1 SEE ALSO
 
 L<collectd(1)>