Help command in the controlinterface
authorDarren <darren@darrenwhitlen.com>
Mon, 9 Jun 2014 12:29:30 +0000 (13:29 +0100)
committerDarren <darren@darrenwhitlen.com>
Mon, 9 Jun 2014 12:29:30 +0000 (13:29 +0100)
server/controlinterface.js

index 091bc1fa486e006ad9c2086ae5d2109061689f34..2bcf32cdc3b5f78e3d463d2e215480581a11f64c 100644 (file)
@@ -76,6 +76,25 @@ ControlInterface.prototype.addCommand = function(command, fn) {
 
 
 var commands = {};
+commands.help = function(args, raw) {
+    var help = 'Available commands:\n';
+    help += 'help\n';
+    help += '    This help menu\n';
+    help += 'reconfig\n';
+    help += '    Reload the config.js file\n';
+    help += 'stats\n';
+    help += '    Show connection statistics\n';
+    help += 'module list\n';
+    help += '    List the loaded server modules\n';
+    help += 'module reload module_name\n';
+    help += '    Reload the module_name module\n';
+    help += 'jumpserver [force] http://kiwi-server.com\n';
+    help += '    Tell all connected clients to reconnect to a different kiwi server. If \'force\' is given, they will be forced to reconnect in 5 minutes. \n';
+
+    this.write(help);
+};
+
+
 commands.stats = function(args, raw) {
     this.write('Connected clients: ' + _.size(global.clients.clients).toString());
     this.write('Num. remote hosts: ' + _.size(global.clients.addresses).toString());