]> gitweb.fluxo.info Git - leap/leap_cli.git/commitdiff
add long description to 'leap list'
authorelijah <elijah@riseup.net>
Tue, 27 Nov 2012 09:41:27 +0000 (01:41 -0800)
committerelijah <elijah@riseup.net>
Tue, 27 Nov 2012 09:41:27 +0000 (01:41 -0800)
lib/leap_cli/commands/list.rb

index 5f455c0771214ae764501bab39d6c399559d1aac..42f2996700e0fba313059e1edae31d801d849cf3 100644 (file)
@@ -3,8 +3,14 @@ require 'command_line_reporter'
 module LeapCli; module Commands
 
   desc 'List nodes and their classifications'
-  long_desc 'Prints out a listing of nodes, services, or tags.'
-  arg_name 'filter'
+  long_desc 'Prints out a listing of nodes, services, or tags. ' +
+            'The node-filter can be a list of names of nodes, services, or tags. ' +
+            'If the name is prefixed with +, this acts like an AND condition. ' +
+            "For example:\n\n" +
+            " * node1 node2    -> matches all nodes named \"node1\" OR \"node2\"\n\n" +
+            " * openvpn +local -> matches all nodes with service \"openvpn\" AND tag \"local\""
+
+  arg_name '[node-filter]', :optional => true
   command :list do |c|
     c.flag 'print', :desc => 'What attributes to print (optional)'
     c.action do |global_options,options,args|