From: Florian Forster <octo@noris.net>
Date: Wed, 26 Aug 2009 09:31:24 +0000 (+0200)
Subject: contrib/cussh.pl: Add synopsis for specific commands.
X-Git-Tag: collectd-4.6.5~15
X-Git-Url: https://git.octo.it/?p=collectd.git;a=commitdiff_plain;h=e391ecd14e8c0f153d46e11213e0effc662ff3b8

contrib/cussh.pl: Add synopsis for specific commands.

You can now do
  HELP FLUSH
to get information about the FLUSH command.
---

diff --git a/contrib/cussh.pl b/contrib/cussh.pl
index 7357ad78..320bf73b 100755
--- a/contrib/cussh.pl
+++ b/contrib/cussh.pl
@@ -186,7 +186,14 @@ sub putid {
 =cut
 
 sub cmd_help {
-	print <<HELP;
+	my $sock = shift;
+	my $line = shift || '';
+
+	my @line = tokenize($line);
+	my $cmd = shift (@line);
+
+	my %text = (
+		help => <<HELP,
 Available commands:
   HELP
   PUTVAL
@@ -198,6 +205,45 @@ Available commands:
 See the embedded Perldoc documentation for details. To do that, run:
   perldoc $0
 HELP
+		putval => <<HELP,
+PUTVAL <id> <value0> [<value1> ...]
+
+Submits a value to the daemon.
+HELP
+		getval => <<HELP,
+GETVAL <id>
+
+Retrieves the current value or values from the daemon.
+HELP
+		flush => <<HELP,
+FLUSH [plugin=<plugin>] [timeout=<timeout>] [identifier=<id>] [...]
+
+Sends a FLUSH command to the daemon.
+HELP
+		listval => <<HELP,
+LISTVAL
+
+Prints a list of available values.
+HELP
+		putnotif => <<HELP
+PUTNOTIF severity=<severity> [...] message=<message>
+
+Sends a notifications message to the daemon.
+HELP
+	);
+
+	if (!$cmd)
+	{
+		$cmd = 'help';
+	}
+	if (!exists ($text{$cmd}))
+	{
+		print STDOUT "Unknown command: " . uc ($cmd) . "\n\n";
+		$cmd = 'help';
+	}
+
+	print STDOUT $text{$cmd};
+
 	return 1;
 } # cmd_help