From: Sebastian Harl <sh@tokkee.org>
Date: Mon, 9 Aug 2010 15:39:24 +0000 (+0200)
Subject: collectdctl: Moved examples section from help output to manpage.
X-Git-Tag: collectd-5.0.0-beta0~58
X-Git-Url: https://git.verplant.org/?a=commitdiff_plain;h=58744510fe0d5d67150779bfa93609fa94eaa2b7;p=collectd.git

collectdctl: Moved examples section from help output to manpage.
---

diff --git a/src/collectdctl.c b/src/collectdctl.c
index af413cf3..68b16750 100644
--- a/src/collectdctl.c
+++ b/src/collectdctl.c
@@ -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"
diff --git a/src/collectdctl.pod b/src/collectdctl.pod
index 8bd89705..aff67ef6 100644
--- a/src/collectdctl.pod
+++ b/src/collectdctl.pod
@@ -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)>