summaryrefslogtreecommitdiff
path: root/src/scripttools/debugging/scripts/commands/help.qs
diff options
context:
space:
mode:
authorQt by Nokia <qt-info@nokia.com>2011-04-27 12:05:43 +0200
committeraxis <qt-info@nokia.com>2011-04-27 12:05:43 +0200
commitc4af45c2914381172e1bd7ee528481edaa2fff1a (patch)
tree01265e109316fda93845e1c96c5e566d870f51d0 /src/scripttools/debugging/scripts/commands/help.qs
downloadqtscript-c4af45c2914381172e1bd7ee528481edaa2fff1a.tar.gz
Initial import from the monolithic Qt.
This is the beginning of revision history for this module. If you want to look at revision history older than this, please refer to the Qt Git wiki for how to use Git history grafting. At the time of writing, this wiki is located here: http://qt.gitorious.org/qt/pages/GitIntroductionWithQt If you have already performed the grafting and you don't see any history beyond this commit, try running "git log" with the "--follow" argument. Branched from the monolithic repo, Qt master branch, at commit 896db169ea224deb96c59ce8af800d019de63f12
Diffstat (limited to 'src/scripttools/debugging/scripts/commands/help.qs')
-rw-r--r--src/scripttools/debugging/scripts/commands/help.qs71
1 files changed, 71 insertions, 0 deletions
diff --git a/src/scripttools/debugging/scripts/commands/help.qs b/src/scripttools/debugging/scripts/commands/help.qs
new file mode 100644
index 0000000..121db11
--- /dev/null
+++ b/src/scripttools/debugging/scripts/commands/help.qs
@@ -0,0 +1,71 @@
+name = "help";
+
+group = "void";
+
+shortDescription = "Print list of commands";
+
+longDescription = "";
+
+argumentTypes = [ "command-or-group-name" ];
+
+function execute() {
+ if (arguments.length == 0) {
+ var groups = getCommandGroups();
+ message("List of command categories:");
+ message("");
+ for (var name in groups) {
+ if (name == "void")
+ continue;
+ var data = groups[name];
+ message(name + " :: " + data.shortDescription);
+ }
+ message("");
+ message("Type \"help\" followed by a category name for a list of commands in that category.");
+ message("Type \"help all\" for the list of all commands.");
+ message("Type \"help\" followed by a command name for full documentation.");
+ message("Command name abbreviations are allowed if they are unambiguous.");
+ } else {
+ var arg = arguments[0];
+ if (arg == "all") {
+ var groups = getCommandGroups();
+ for (var name in groups) {
+ if (name == "void")
+ continue;
+ message("Command category: " + name);
+ message("");
+ var commands = getCommandsInGroup(name);
+ for (var i = 0; i < commands.length; ++i) {
+ var data = commands[i];
+ message(data.name + " :: " + data.shortDescription);
+ }
+ message("");
+ }
+ } else {
+ var data = findCommand(arg);
+ if (data != undefined) {
+ message(data.shortDescription + ".");
+ if (data.longDescription.length != 0)
+ message(data.longDescription);
+ if (data.aliases.length != 0)
+ message("Aliases: " + data.aliases.join(", "));
+ if (data.seeAlso.length != 0)
+ message("See also: " + data.seeAlso.join(", "));
+ } else {
+ data = getCommandGroups()[arg];
+ if (data != undefined) {
+ message(data.shortDescription + ".");
+ message("");
+ message("List of commands:");
+ message("");
+ var commands = getCommandsInGroup(arg);
+ for (var i = 0; i < commands.length; ++i) {
+ var data = commands[i];
+ message(data.name + " :: " + data.shortDescription);
+ }
+ } else {
+ message("Undefined command \"" + arg + "\". Try \"help\".");
+ }
+ }
+ }
+ }
+};