doc/MCollective/Optionparser.html

   1 <?xml version="1.0" encoding="utf-8"?>
   2 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
   3         "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
   4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
   5 <head>
   6         <meta content="text/html; charset=utf-8" http-equiv="Content-Type" />
   7
   8         <title>Class: MCollective::Optionparser</title>
   9
  10         <link rel="stylesheet" href="../rdoc.css" type="text/css" media="screen" />
  11
  12         <script src="../js/jquery.js" type="text/javascript"
  13                 charset="utf-8"></script>
  14         <script src="../js/thickbox-compressed.js" type="text/javascript"
  15                 charset="utf-8"></script>
  16         <script src="../js/quicksearch.js" type="text/javascript"
  17                 charset="utf-8"></script>
  18         <script src="../js/darkfish.js" type="text/javascript"
  19                 charset="utf-8"></script>
  20
  21 </head>
  22 <body class="class">
  23
  24         <div id="metadata">
  25                 <div id="file-metadata">
  26                         <div id="file-list-section" class="section">
  27                                 <h3 class="section-header">In Files</h3>
  28                                 <div class="section-body">
  29                                         <ul>
  30
  31                                                 <li><a href="../lib/mcollective/optionparser_rb.html?TB_iframe=true&amp;height=550&amp;width=785"
  32                                                         class="thickbox" title="lib/mcollective/optionparser.rb">lib/mcollective/optionparser.rb</a></li>
  33
  34                                         </ul>
  35                                 </div>
  36                         </div>
  37
  38
  39                 </div>
  40
  41                 <div id="class-metadata">
  42
  43                         <!-- Parent Class -->
  44
  45                         <div id="parent-class-section" class="section">
  46                                 <h3 class="section-header">Parent</h3>
  47
  48                                 <p class="link"><a href="../Object.html">Object</a></p>
  49
  50                         </div>
  51
  52
  53                         <!-- Namespace Contents -->
  54
  55
  56                         <!-- Method Quickref -->
  57
  58                         <div id="method-list-section" class="section">
  59                                 <h3 class="section-header">Methods</h3>
  60                                 <ul class="link-list">
  61
  62                                         <li><a href="#M000020">::new</a></li>
  63
  64                                         <li><a href="#M000031">#add_common_options</a></li>
  65
  66                                         <li><a href="#M000024">#add_filter_options</a></li>
  67
  68                                         <li><a href="#M000028">#add_required_options</a></li>
  69
  70                                         <li><a href="#M000021">#parse</a></li>
  71
  72                                         <li><a href="#M000032">#parse_fact</a></li>
  73
  74                                 </ul>
  75                         </div>
  76
  77
  78                         <!-- Included Modules -->
  79
  80                 </div>
  81
  82                 <div id="project-metadata">
  83
  84
  85                         <div id="fileindex-section" class="section project-section">
  86                                 <h3 class="section-header">Files</h3>
  87                                 <ul>
  88
  89                                         <li class="file"><a href="../COPYING.html">COPYING</a></li>
  90
  91                                         <li class="file"><a href="../Gemfile.html">Gemfile</a></li>
  92
  93                                         <li class="file"><a href="../README.html">README</a></li>
  94
  95                                         <li class="file"><a href="../Rakefile.html">Rakefile</a></li>
  96
  97                                         <li class="file"><a href="../etc/client_cfg_dist.html">client.cfg.dist</a></li>
  98
  99                                         <li class="file"><a href="../etc/data-help_erb.html">data-help.erb</a></li>
 100
 101                                         <li class="file"><a href="../etc/discovery-help_erb.html">discovery-help.erb</a></li>
 102
 103                                         <li class="file"><a href="../etc/facts_yaml_dist.html">facts.yaml.dist</a></li>
 104
 105                                         <li class="file"><a href="../etc/metadata-help_erb.html">metadata-help.erb</a></li>
 106
 107                                         <li class="file"><a href="../etc/msg-help_erb.html">msg-help.erb</a></li>
 108
 109                                         <li class="file"><a href="../etc/rpc-help_erb.html">rpc-help.erb</a></li>
 110
 111                                         <li class="file"><a href="../etc/server_cfg_dist.html">server.cfg.dist</a></li>
 112
 113                                         <li class="file"><a href="../etc/ssl/PLACEHOLDER.html">PLACEHOLDER</a></li>
 114
 115                                         <li class="file"><a href="../etc/ssl/clients/PLACEHOLDER.html">PLACEHOLDER</a></li>
 116
 117                                         <li class="file"><a href="../lib/mcollective/generators/templates/action_snippet_erb.html">action_snippet.erb</a></li>
 118
 119                                         <li class="file"><a href="../lib/mcollective/generators/templates/data_input_snippet_erb.html">data_input_snippet.erb</a></li>
 120
 121                                         <li class="file"><a href="../lib/mcollective/generators/templates/ddl_erb.html">ddl.erb</a></li>
 122
 123                                         <li class="file"><a href="../lib/mcollective/generators/templates/plugin_erb.html">plugin.erb</a></li>
 124
 125                                         <li class="file"><a href="../lib/mcollective/locales/en_yml.html">en.yml</a></li>
 126
 127                                         <li class="file"><a href="../mcollective_init.html">mcollective.init</a></li>
 128
 129                                 </ul>
 130                         </div>
 131
 132
 133                         <div id="classindex-section" class="section project-section">
 134                                 <h3 class="section-header">Class Index
 135                                         <span class="search-toggle"><img src="../images/find.png"
 136                                                 height="16" width="16" alt="[+]"
 137                                                 title="show/hide quicksearch" /></span></h3>
 138                                 <form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
 139                                 <fieldset>
 140                                         <legend>Quicksearch</legend>
 141                                         <input type="text" name="quicksearch" value=""
 142                                                 class="quicksearch-field" />
 143                                 </fieldset>
 144                                 </form>
 145
 146                                 <ul class="link-list">
 147
 148                                         <li><a href="../MCollective.html">MCollective</a></li>
 149
 150                                         <li><a href="../MCollective/Agent.html">MCollective::Agent</a></li>
 151
 152                                         <li><a href="../MCollective/Agents.html">MCollective::Agents</a></li>
 153
 154                                         <li><a href="../MCollective/Aggregate.html">MCollective::Aggregate</a></li>
 155
 156                                         <li><a href="../MCollective/Aggregate/Base.html">MCollective::Aggregate::Base</a></li>
 157
 158                                         <li><a href="../MCollective/Aggregate/Result.html">MCollective::Aggregate::Result</a></li>
 159
 160                                         <li><a href="../MCollective/Aggregate/Result/Base.html">MCollective::Aggregate::Result::Base</a></li>
 161
 162                                         <li><a href="../MCollective/Aggregate/Result/CollectionResult.html">MCollective::Aggregate::Result::CollectionResult</a></li>
 163
 164                                         <li><a href="../MCollective/Aggregate/Result/NumericResult.html">MCollective::Aggregate::Result::NumericResult</a></li>
 165
 166                                         <li><a href="../MCollective/Application.html">MCollective::Application</a></li>
 167
 168                                         <li><a href="../MCollective/Applications.html">MCollective::Applications</a></li>
 169
 170                                         <li><a href="../MCollective/Cache.html">MCollective::Cache</a></li>
 171
 172                                         <li><a href="../MCollective/Client.html">MCollective::Client</a></li>
 173
 174                                         <li><a href="../MCollective/CodedError.html">MCollective::CodedError</a></li>
 175
 176                                         <li><a href="../MCollective/Config.html">MCollective::Config</a></li>
 177
 178                                         <li><a href="../MCollective/Connector.html">MCollective::Connector</a></li>
 179
 180                                         <li><a href="../MCollective/Connector/Base.html">MCollective::Connector::Base</a></li>
 181
 182                                         <li><a href="../MCollective/DDL.html">MCollective::DDL</a></li>
 183
 184                                         <li><a href="../MCollective/DDL/AgentDDL.html">MCollective::DDL::AgentDDL</a></li>
 185
 186                                         <li><a href="../MCollective/DDL/Base.html">MCollective::DDL::Base</a></li>
 187
 188                                         <li><a href="../MCollective/DDL/DataDDL.html">MCollective::DDL::DataDDL</a></li>
 189
 190                                         <li><a href="../MCollective/DDL/DiscoveryDDL.html">MCollective::DDL::DiscoveryDDL</a></li>
 191
 192                                         <li><a href="../MCollective/DDL/ValidatorDDL.html">MCollective::DDL::ValidatorDDL</a></li>
 193
 194                                         <li><a href="../MCollective/DDLValidationError.html">MCollective::DDLValidationError</a></li>
 195
 196                                         <li><a href="../MCollective/Data.html">MCollective::Data</a></li>
 197
 198                                         <li><a href="../MCollective/Data/Base.html">MCollective::Data::Base</a></li>
 199
 200                                         <li><a href="../MCollective/Data/Result.html">MCollective::Data::Result</a></li>
 201
 202                                         <li><a href="../MCollective/Discovery.html">MCollective::Discovery</a></li>
 203
 204                                         <li><a href="../MCollective/Facts.html">MCollective::Facts</a></li>
 205
 206                                         <li><a href="../MCollective/Facts/Base.html">MCollective::Facts::Base</a></li>
 207
 208                                         <li><a href="../MCollective/Generators.html">MCollective::Generators</a></li>
 209
 210                                         <li><a href="../MCollective/Generators/AgentGenerator.html">MCollective::Generators::AgentGenerator</a></li>
 211
 212                                         <li><a href="../MCollective/Generators/Base.html">MCollective::Generators::Base</a></li>
 213
 214                                         <li><a href="../MCollective/Generators/DataGenerator.html">MCollective::Generators::DataGenerator</a></li>
 215
 216                                         <li><a href="../MCollective/InvalidRPCData.html">MCollective::InvalidRPCData</a></li>
 217
 218                                         <li><a href="../MCollective/Log.html">MCollective::Log</a></li>
 219
 220                                         <li><a href="../MCollective/Logger.html">MCollective::Logger</a></li>
 221
 222                                         <li><a href="../MCollective/Logger/Base.html">MCollective::Logger::Base</a></li>
 223
 224                                         <li><a href="../MCollective/Logger/Console_logger.html">MCollective::Logger::Console_logger</a></li>
 225
 226                                         <li><a href="../MCollective/Logger/File_logger.html">MCollective::Logger::File_logger</a></li>
 227
 228                                         <li><a href="../MCollective/Logger/Syslog_logger.html">MCollective::Logger::Syslog_logger</a></li>
 229
 230                                         <li><a href="../MCollective/Matcher.html">MCollective::Matcher</a></li>
 231
 232                                         <li><a href="../MCollective/Matcher/Parser.html">MCollective::Matcher::Parser</a></li>
 233
 234                                         <li><a href="../MCollective/Matcher/Scanner.html">MCollective::Matcher::Scanner</a></li>
 235
 236                                         <li><a href="../MCollective/Message.html">MCollective::Message</a></li>
 237
 238                                         <li><a href="../MCollective/MissingRPCData.html">MCollective::MissingRPCData</a></li>
 239
 240                                         <li><a href="../MCollective/MsgDoesNotMatchRequestID.html">MCollective::MsgDoesNotMatchRequestID</a></li>
 241
 242                                         <li><a href="../MCollective/MsgTTLExpired.html">MCollective::MsgTTLExpired</a></li>
 243
 244                                         <li><a href="../MCollective/NotTargettedAtUs.html">MCollective::NotTargettedAtUs</a></li>
 245
 246                                         <li><a href="../MCollective/Optionparser.html">MCollective::Optionparser</a></li>
 247
 248                                         <li><a href="../MCollective/PluginManager.html">MCollective::PluginManager</a></li>
 249
 250                                         <li><a href="../MCollective/PluginPackager.html">MCollective::PluginPackager</a></li>
 251
 252                                         <li><a href="../MCollective/PluginPackager/AgentDefinition.html">MCollective::PluginPackager::AgentDefinition</a></li>
 253
 254                                         <li><a href="../MCollective/PluginPackager/StandardDefinition.html">MCollective::PluginPackager::StandardDefinition</a></li>
 255
 256                                         <li><a href="../MCollective/RPC.html">MCollective::RPC</a></li>
 257
 258                                         <li><a href="../MCollective/RPC/ActionRunner.html">MCollective::RPC::ActionRunner</a></li>
 259
 260                                         <li><a href="../MCollective/RPC/Agent.html">MCollective::RPC::Agent</a></li>
 261
 262                                         <li><a href="../MCollective/RPC/Audit.html">MCollective::RPC::Audit</a></li>
 263
 264                                         <li><a href="../MCollective/RPC/Client.html">MCollective::RPC::Client</a></li>
 265
 266                                         <li><a href="../MCollective/RPC/Helpers.html">MCollective::RPC::Helpers</a></li>
 267
 268                                         <li><a href="../MCollective/RPC/Progress.html">MCollective::RPC::Progress</a></li>
 269
 270                                         <li><a href="../MCollective/RPC/Reply.html">MCollective::RPC::Reply</a></li>
 271
 272                                         <li><a href="../MCollective/RPC/Request.html">MCollective::RPC::Request</a></li>
 273
 274                                         <li><a href="../MCollective/RPC/Result.html">MCollective::RPC::Result</a></li>
 275
 276                                         <li><a href="../MCollective/RPC/Stats.html">MCollective::RPC::Stats</a></li>
 277
 278                                         <li><a href="../MCollective/RPCAborted.html">MCollective::RPCAborted</a></li>
 279
 280                                         <li><a href="../MCollective/RPCError.html">MCollective::RPCError</a></li>
 281
 282                                         <li><a href="../MCollective/Registration.html">MCollective::Registration</a></li>
 283
 284                                         <li><a href="../MCollective/Registration/Base.html">MCollective::Registration::Base</a></li>
 285
 286                                         <li><a href="../MCollective/Runner.html">MCollective::Runner</a></li>
 287
 288                                         <li><a href="../MCollective/RunnerStats.html">MCollective::RunnerStats</a></li>
 289
 290                                         <li><a href="../MCollective/SSL.html">MCollective::SSL</a></li>
 291
 292                                         <li><a href="../MCollective/Security.html">MCollective::Security</a></li>
 293
 294                                         <li><a href="../MCollective/Security/Base.html">MCollective::Security::Base</a></li>
 295
 296                                         <li><a href="../MCollective/SecurityValidationFailed.html">MCollective::SecurityValidationFailed</a></li>
 297
 298                                         <li><a href="../MCollective/Shell.html">MCollective::Shell</a></li>
 299
 300                                         <li><a href="../MCollective/Translatable.html">MCollective::Translatable</a></li>
 301
 302                                         <li><a href="../MCollective/UnixDaemon.html">MCollective::UnixDaemon</a></li>
 303
 304                                         <li><a href="../MCollective/UnknownRPCAction.html">MCollective::UnknownRPCAction</a></li>
 305
 306                                         <li><a href="../MCollective/UnknownRPCError.html">MCollective::UnknownRPCError</a></li>
 307
 308                                         <li><a href="../MCollective/Util.html">MCollective::Util</a></li>
 309
 310                                         <li><a href="../MCollective/Validator.html">MCollective::Validator</a></li>
 311
 312                                         <li><a href="../MCollective/ValidatorError.html">MCollective::ValidatorError</a></li>
 313
 314                                         <li><a href="../MCollective/WindowsDaemon.html">MCollective::WindowsDaemon</a></li>
 315
 316                                         <li><a href="../Array.html">Array</a></li>
 317
 318                                         <li><a href="../Dir.html">Dir</a></li>
 319
 320                                         <li><a href="../Object.html">Object</a></li>
 321
 322                                         <li><a href="../String.html">String</a></li>
 323
 324                                         <li><a href="../Symbol.html">Symbol</a></li>
 325
 326                                 </ul>
 327                                 <div id="no-class-search-results" style="display: none;">No matching classes.</div>
 328                         </div>
 329
 330
 331                 </div>
 332         </div>
 333
 334         <div id="documentation">
 335                 <h1 class="class">MCollective::Optionparser</h1>
 336
 337                 <div id="description">
 338                         <p>
 339 A simple helper to build cli tools that supports a uniform command line
 340 layout.
 341 </p>
 342
 343                 </div>
 344
 345                 <!-- Constants -->
 346
 347
 348                 <!-- Attributes -->
 349
 350                 <div id="attribute-method-details" class="method-section section">
 351                         <h3 class="section-header">Attributes</h3>
 352
 353
 354                         <div id="parser-attribute-method" class="method-detail">
 355                                 <a name="parser"></a>
 356
 357                                 <div class="method-heading attribute-method-heading">
 358                                         <span class="method-name">parser</span><span
 359                                                 class="attribute-access-type">[R]</span>
 360                                 </div>
 361
 362                                 <div class="method-description">
 363
 364                                 <p class="missing-docs">(Not documented)</p>
 365
 366                                 </div>
 367                         </div>
 368
 369                 </div>
 370
 371
 372                 <!-- Methods -->
 373
 374                 <div id="public-class-method-details" class="method-section section">
 375                         <h3 class="section-header">Public Class Methods</h3>
 376
 377
 378                         <div id="new-method" class="method-detail ">
 379                                 <a name="M000020"></a>
 380
 381                                 <div class="method-heading">
 382
 383                                         <span class="method-name">new</span><span
 384                                                 class="method-args">(defaults = {}, include_sections = nil, exclude_sections = nil)</span>
 385                                         <span class="method-click-advice">click to toggle source</span>
 386
 387                                 </div>
 388
 389                                 <div class="method-description">
 390
 391                                         <p>
 392 Creates a new instance of the parser, you can supply defaults and include
 393 named groups of options.
 394 </p>
 395 <p>
 396 Starts a parser that defaults to verbose and that includs the filter
 397 options:
 398 </p>
 399 <pre>
 400  oparser = MCollective::Optionparser.new({:verbose =&gt; true}, &quot;filter&quot;)
 401 </pre>
 402 <p>
 403 Stats a parser in non verbose mode that does support discovery
 404 </p>
 405 <pre>
 406  oparser = MCollective::Optionparser.new()
 407 </pre>
 408 <p>
 409 Starts a parser in verbose mode that does not show the common options:
 410 </p>
 411 <pre>
 412  oparser = MCollective::Optionparser.new({:verbose =&gt; true}, &quot;filter&quot;, &quot;common&quot;)
 413 </pre>
 414
 415
 416
 417                                         <div class="method-source-code"
 418                                                 id="new-source">
 419 <pre>
 420     <span class="ruby-comment cmt"># File lib/mcollective/optionparser.rb, line 20</span>
 421 20:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">defaults</span> = {}, <span class="ruby-identifier">include_sections</span> = <span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">exclude_sections</span> = <span class="ruby-keyword kw">nil</span>)
 422 21:       <span class="ruby-ivar">@parser</span> = <span class="ruby-operator">::</span><span class="ruby-constant">OptionParser</span>.<span class="ruby-identifier">new</span>
 423 22:
 424 23:       <span class="ruby-ivar">@include</span> = [<span class="ruby-identifier">include_sections</span>].<span class="ruby-identifier">flatten</span>
 425 24:       <span class="ruby-ivar">@exclude</span> = [<span class="ruby-identifier">exclude_sections</span>].<span class="ruby-identifier">flatten</span>
 426 25:
 427 26:       <span class="ruby-ivar">@options</span> = <span class="ruby-constant">Util</span>.<span class="ruby-identifier">default_options</span>
 428 27:
 429 28:       <span class="ruby-ivar">@options</span>.<span class="ruby-identifier">merge!</span>(<span class="ruby-identifier">defaults</span>)
 430 29:     <span class="ruby-keyword kw">end</span></pre>
 431                                         </div>
 432
 433                                 </div>
 434
 435
 436                         </div>
 437
 438
 439                 </div>
 440
 441                 <div id="public-instance-method-details" class="method-section section">
 442                         <h3 class="section-header">Public Instance Methods</h3>
 443
 444
 445                         <div id="add-common-options-method" class="method-detail ">
 446                                 <a name="M000031"></a>
 447
 448                                 <div class="method-heading">
 449
 450                                         <span class="method-name">add_common_options</span><span
 451                                                 class="method-args">()</span>
 452                                         <span class="method-click-advice">click to toggle source</span>
 453
 454                                 </div>
 455
 456                                 <div class="method-description">
 457
 458                                         <p>
 459 These options will be added to most cli tools
 460 </p>
 461
 462
 463
 464                                         <div class="method-source-code"
 465                                                 id="add-common-options-source">
 466 <pre>
 467      <span class="ruby-comment cmt"># File lib/mcollective/optionparser.rb, line 128</span>
 468 128:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">add_common_options</span>
 469 129:       <span class="ruby-ivar">@parser</span>.<span class="ruby-identifier">separator</span> <span class="ruby-value str">&quot;&quot;</span>
 470 130:       <span class="ruby-ivar">@parser</span>.<span class="ruby-identifier">separator</span> <span class="ruby-value str">&quot;Common Options&quot;</span>
 471 131:
 472 132:       <span class="ruby-ivar">@parser</span>.<span class="ruby-identifier">on</span>(<span class="ruby-value str">'-T'</span>, <span class="ruby-value str">'--target COLLECTIVE'</span>, <span class="ruby-value str">'Target messages to a specific sub collective'</span>) <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">f</span><span class="ruby-operator">|</span>
 473 133:         <span class="ruby-ivar">@options</span>[<span class="ruby-identifier">:collective</span>] = <span class="ruby-identifier">f</span>
 474 134:       <span class="ruby-keyword kw">end</span>
 475 135:
 476 136:       <span class="ruby-ivar">@parser</span>.<span class="ruby-identifier">on</span>(<span class="ruby-value str">'--dt'</span>, <span class="ruby-value str">'--discovery-timeout SECONDS'</span>, <span class="ruby-constant">Integer</span>, <span class="ruby-value str">'Timeout for doing discovery'</span>) <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">t</span><span class="ruby-operator">|</span>
 477 137:         <span class="ruby-ivar">@options</span>[<span class="ruby-identifier">:disctimeout</span>] = <span class="ruby-identifier">t</span>
 478 138:       <span class="ruby-keyword kw">end</span>
 479 139:
 480 140:       <span class="ruby-ivar">@parser</span>.<span class="ruby-identifier">on</span>(<span class="ruby-value str">'-t'</span>, <span class="ruby-value str">'--timeout SECONDS'</span>, <span class="ruby-constant">Integer</span>, <span class="ruby-value str">'Timeout for calling remote agents'</span>) <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">t</span><span class="ruby-operator">|</span>
 481 141:         <span class="ruby-ivar">@options</span>[<span class="ruby-identifier">:timeout</span>] = <span class="ruby-identifier">t</span>
 482 142:       <span class="ruby-keyword kw">end</span>
 483 143:
 484 144:       <span class="ruby-ivar">@parser</span>.<span class="ruby-identifier">on</span>(<span class="ruby-value str">'-q'</span>, <span class="ruby-value str">'--quiet'</span>, <span class="ruby-value str">'Do not be verbose'</span>) <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">v</span><span class="ruby-operator">|</span>
 485 145:         <span class="ruby-ivar">@options</span>[<span class="ruby-identifier">:verbose</span>] = <span class="ruby-keyword kw">false</span>
 486 146:       <span class="ruby-keyword kw">end</span>
 487 147:
 488 148:       <span class="ruby-ivar">@parser</span>.<span class="ruby-identifier">on</span>(<span class="ruby-value str">'--ttl TTL'</span>, <span class="ruby-value str">'Set the message validity period'</span>) <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">v</span><span class="ruby-operator">|</span>
 489 149:         <span class="ruby-ivar">@options</span>[<span class="ruby-identifier">:ttl</span>] = <span class="ruby-identifier">v</span>.<span class="ruby-identifier">to_i</span>
 490 150:       <span class="ruby-keyword kw">end</span>
 491 151:
 492 152:       <span class="ruby-ivar">@parser</span>.<span class="ruby-identifier">on</span>(<span class="ruby-value str">'--reply-to TARGET'</span>, <span class="ruby-value str">'Set a custom target for replies'</span>) <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">v</span><span class="ruby-operator">|</span>
 493 153:         <span class="ruby-ivar">@options</span>[<span class="ruby-identifier">:reply_to</span>] = <span class="ruby-identifier">v</span>
 494 154:       <span class="ruby-keyword kw">end</span>
 495 155:
 496 156:       <span class="ruby-ivar">@parser</span>.<span class="ruby-identifier">on</span>(<span class="ruby-value str">'--dm'</span>, <span class="ruby-value str">'--disc-method METHOD'</span>, <span class="ruby-value str">'Which discovery method to use'</span>) <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">v</span><span class="ruby-operator">|</span>
 497 157:         <span class="ruby-identifier">raise</span> <span class="ruby-value str">&quot;Discovery method is already set by a competing option&quot;</span> <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@options</span>[<span class="ruby-identifier">:discovery_method</span>] <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-ivar">@options</span>[<span class="ruby-identifier">:discovery_method</span>] <span class="ruby-operator">!=</span> <span class="ruby-identifier">v</span>
 498 158:         <span class="ruby-ivar">@options</span>[<span class="ruby-identifier">:discovery_method</span>] = <span class="ruby-identifier">v</span>
 499 159:       <span class="ruby-keyword kw">end</span>
 500 160:
 501 161:       <span class="ruby-ivar">@parser</span>.<span class="ruby-identifier">on</span>(<span class="ruby-value str">'--do'</span>, <span class="ruby-value str">'--disc-option OPTION'</span>, <span class="ruby-value str">'Options to pass to the discovery method'</span>) <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">a</span><span class="ruby-operator">|</span>
 502 162:         <span class="ruby-ivar">@options</span>[<span class="ruby-identifier">:discovery_options</span>] <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">a</span>
 503 163:       <span class="ruby-keyword kw">end</span>
 504 164:
 505 165:       <span class="ruby-ivar">@parser</span>.<span class="ruby-identifier">on</span>(<span class="ruby-value str">&quot;--nodes FILE&quot;</span>, <span class="ruby-value str">&quot;List of nodes to address&quot;</span>) <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">v</span><span class="ruby-operator">|</span>
 506 166:         <span class="ruby-identifier">raise</span> <span class="ruby-value str">&quot;Cannot mix --disc-method, --disc-option and --nodes&quot;</span> <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@options</span>[<span class="ruby-identifier">:discovery_method</span>] <span class="ruby-operator">||</span> <span class="ruby-ivar">@options</span>[<span class="ruby-identifier">:discovery_options</span>].<span class="ruby-identifier">size</span> <span class="ruby-operator">&gt;</span> <span class="ruby-value">0</span>
 507 167:         <span class="ruby-identifier">raise</span> <span class="ruby-node">&quot;Cannot read the discovery file #{v}&quot;</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-constant">File</span>.<span class="ruby-identifier">readable?</span>(<span class="ruby-identifier">v</span>)
 508 168:
 509 169:         <span class="ruby-ivar">@options</span>[<span class="ruby-identifier">:discovery_method</span>] = <span class="ruby-value str">&quot;flatfile&quot;</span>
 510 170:         <span class="ruby-ivar">@options</span>[<span class="ruby-identifier">:discovery_options</span>] <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">v</span>
 511 171:       <span class="ruby-keyword kw">end</span>
 512 172:
 513 173:       <span class="ruby-ivar">@parser</span>.<span class="ruby-identifier">on</span>(<span class="ruby-value str">&quot;--publish_timeout TIMEOUT&quot;</span>, <span class="ruby-constant">Integer</span>, <span class="ruby-value str">&quot;Timeout for publishing requests to remote agents.&quot;</span>) <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">pt</span><span class="ruby-operator">|</span>
 514 174:         <span class="ruby-ivar">@options</span>[<span class="ruby-identifier">:publish_timeout</span>] = <span class="ruby-identifier">pt</span>
 515 175:       <span class="ruby-keyword kw">end</span>
 516 176:
 517 177:       <span class="ruby-ivar">@parser</span>.<span class="ruby-identifier">on</span>(<span class="ruby-value str">&quot;--threaded&quot;</span>, <span class="ruby-value str">&quot;Start publishing requests and receiving responses in threaded mode.&quot;</span>) <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">v</span><span class="ruby-operator">|</span>
 518 178:         <span class="ruby-ivar">@options</span>[<span class="ruby-identifier">:threaded</span>] = <span class="ruby-keyword kw">true</span>
 519 179:       <span class="ruby-keyword kw">end</span>
 520 180:     <span class="ruby-keyword kw">end</span></pre>
 521                                         </div>
 522
 523                                 </div>
 524
 525
 526                         </div>
 527
 528
 529                         <div id="add-filter-options-method" class="method-detail ">
 530                                 <a name="M000024"></a>
 531
 532                                 <div class="method-heading">
 533
 534                                         <span class="method-name">add_filter_options</span><span
 535                                                 class="method-args">()</span>
 536                                         <span class="method-click-advice">click to toggle source</span>
 537
 538                                 </div>
 539
 540                                 <div class="method-description">
 541
 542                                         <p>
 543 These options will be added if you pass &#8216;filter&#8217; into the
 544 include list of the constructor.
 545 </p>
 546
 547
 548
 549                                         <div class="method-source-code"
 550                                                 id="add-filter-options-source">
 551 <pre>
 552      <span class="ruby-comment cmt"># File lib/mcollective/optionparser.rb, line 73</span>
 553  73:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">add_filter_options</span>
 554  74:       <span class="ruby-ivar">@parser</span>.<span class="ruby-identifier">separator</span> <span class="ruby-value str">&quot;&quot;</span>
 555  75:       <span class="ruby-ivar">@parser</span>.<span class="ruby-identifier">separator</span> <span class="ruby-value str">&quot;Host Filters&quot;</span>
 556  76:
 557  77:       <span class="ruby-ivar">@parser</span>.<span class="ruby-identifier">on</span>(<span class="ruby-value str">'-W'</span>, <span class="ruby-value str">'--with FILTER'</span>, <span class="ruby-value str">'Combined classes and facts filter'</span>) <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">f</span><span class="ruby-operator">|</span>
 558  78:         <span class="ruby-identifier">f</span>.<span class="ruby-identifier">split</span>(<span class="ruby-value str">&quot; &quot;</span>).<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">filter</span><span class="ruby-operator">|</span>
 559  79:           <span class="ruby-keyword kw">begin</span>
 560  80:             <span class="ruby-identifier">fact_parsed</span> = <span class="ruby-identifier">parse_fact</span>(<span class="ruby-identifier">filter</span>)
 561  81:             <span class="ruby-ivar">@options</span>[<span class="ruby-identifier">:filter</span>][<span class="ruby-value str">&quot;fact&quot;</span>] <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">fact_parsed</span>
 562  82:           <span class="ruby-keyword kw">rescue</span>
 563  83:             <span class="ruby-ivar">@options</span>[<span class="ruby-identifier">:filter</span>][<span class="ruby-value str">&quot;cf_class&quot;</span>] <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">filter</span>
 564  84:           <span class="ruby-keyword kw">end</span>
 565  85:         <span class="ruby-keyword kw">end</span>
 566  86:       <span class="ruby-keyword kw">end</span>
 567  87:
 568  88:       <span class="ruby-ivar">@parser</span>.<span class="ruby-identifier">on</span>(<span class="ruby-value str">'-S'</span>, <span class="ruby-value str">'--select FILTER'</span>, <span class="ruby-value str">'Compound filter combining facts and classes'</span>) <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">f</span><span class="ruby-operator">|</span>
 569  89:         <span class="ruby-ivar">@options</span>[<span class="ruby-identifier">:filter</span>][<span class="ruby-value str">&quot;compound&quot;</span>] <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-constant">Matcher</span>.<span class="ruby-identifier">create_compound_callstack</span>(<span class="ruby-identifier">f</span>)
 570  90:       <span class="ruby-keyword kw">end</span>
 571  91:
 572  92:       <span class="ruby-ivar">@parser</span>.<span class="ruby-identifier">on</span>(<span class="ruby-value str">'-F'</span>, <span class="ruby-value str">'--wf'</span>, <span class="ruby-value str">'--with-fact fact=val'</span>, <span class="ruby-value str">'Match hosts with a certain fact'</span>) <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">f</span><span class="ruby-operator">|</span>
 573  93:         <span class="ruby-identifier">fact_parsed</span> = <span class="ruby-identifier">parse_fact</span>(<span class="ruby-identifier">f</span>)
 574  94:
 575  95:         <span class="ruby-ivar">@options</span>[<span class="ruby-identifier">:filter</span>][<span class="ruby-value str">&quot;fact&quot;</span>] <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">fact_parsed</span> <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">fact_parsed</span>
 576  96:       <span class="ruby-keyword kw">end</span>
 577  97:
 578  98:       <span class="ruby-ivar">@parser</span>.<span class="ruby-identifier">on</span>(<span class="ruby-value str">'-C'</span>, <span class="ruby-value str">'--wc'</span>, <span class="ruby-value str">'--with-class CLASS'</span>, <span class="ruby-value str">'Match hosts with a certain config management class'</span>) <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">f</span><span class="ruby-operator">|</span>
 579  99:         <span class="ruby-ivar">@options</span>[<span class="ruby-identifier">:filter</span>][<span class="ruby-value str">&quot;cf_class&quot;</span>] <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">f</span>
 580 100:       <span class="ruby-keyword kw">end</span>
 581 101:
 582 102:       <span class="ruby-ivar">@parser</span>.<span class="ruby-identifier">on</span>(<span class="ruby-value str">'-A'</span>, <span class="ruby-value str">'--wa'</span>, <span class="ruby-value str">'--with-agent AGENT'</span>, <span class="ruby-value str">'Match hosts with a certain agent'</span>) <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">a</span><span class="ruby-operator">|</span>
 583 103:         <span class="ruby-ivar">@options</span>[<span class="ruby-identifier">:filter</span>][<span class="ruby-value str">&quot;agent&quot;</span>] <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">a</span>
 584 104:       <span class="ruby-keyword kw">end</span>
 585 105:
 586 106:       <span class="ruby-ivar">@parser</span>.<span class="ruby-identifier">on</span>(<span class="ruby-value str">'-I'</span>, <span class="ruby-value str">'--wi'</span>, <span class="ruby-value str">'--with-identity IDENT'</span>, <span class="ruby-value str">'Match hosts with a certain configured identity'</span>) <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">a</span><span class="ruby-operator">|</span>
 587 107:         <span class="ruby-ivar">@options</span>[<span class="ruby-identifier">:filter</span>][<span class="ruby-value str">&quot;identity&quot;</span>] <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">a</span>
 588 108:       <span class="ruby-keyword kw">end</span>
 589 109:     <span class="ruby-keyword kw">end</span></pre>
 590                                         </div>
 591
 592                                 </div>
 593
 594
 595                         </div>
 596
 597
 598                         <div id="add-required-options-method" class="method-detail ">
 599                                 <a name="M000028"></a>
 600
 601                                 <div class="method-heading">
 602
 603                                         <span class="method-name">add_required_options</span><span
 604                                                 class="method-args">()</span>
 605                                         <span class="method-click-advice">click to toggle source</span>
 606
 607                                 </div>
 608
 609                                 <div class="method-description">
 610
 611                                         <p>
 612 These options should always be present
 613 </p>
 614
 615
 616
 617                                         <div class="method-source-code"
 618                                                 id="add-required-options-source">
 619 <pre>
 620      <span class="ruby-comment cmt"># File lib/mcollective/optionparser.rb, line 112</span>
 621 112:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">add_required_options</span>
 622 113:       <span class="ruby-ivar">@parser</span>.<span class="ruby-identifier">on</span>(<span class="ruby-value str">'-c'</span>, <span class="ruby-value str">'--config FILE'</span>, <span class="ruby-value str">'Load configuratuion from file rather than default'</span>) <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">f</span><span class="ruby-operator">|</span>
 623 114:         <span class="ruby-ivar">@options</span>[<span class="ruby-identifier">:config</span>] = <span class="ruby-identifier">f</span>
 624 115:       <span class="ruby-keyword kw">end</span>
 625 116:
 626 117:       <span class="ruby-ivar">@parser</span>.<span class="ruby-identifier">on</span>(<span class="ruby-value str">'-v'</span>, <span class="ruby-value str">'--verbose'</span>, <span class="ruby-value str">'Be verbose'</span>) <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">v</span><span class="ruby-operator">|</span>
 627 118:         <span class="ruby-ivar">@options</span>[<span class="ruby-identifier">:verbose</span>] = <span class="ruby-identifier">v</span>
 628 119:       <span class="ruby-keyword kw">end</span>
 629 120:
 630 121:       <span class="ruby-ivar">@parser</span>.<span class="ruby-identifier">on</span>(<span class="ruby-value str">'-h'</span>, <span class="ruby-value str">'--help'</span>, <span class="ruby-value str">'Display this screen'</span>) <span class="ruby-keyword kw">do</span>
 631 122:         <span class="ruby-identifier">puts</span> <span class="ruby-ivar">@parser</span>
 632 123:         <span class="ruby-identifier">exit!</span> <span class="ruby-value">1</span>
 633 124:       <span class="ruby-keyword kw">end</span>
 634 125:     <span class="ruby-keyword kw">end</span></pre>
 635                                         </div>
 636
 637                                 </div>
 638
 639
 640                         </div>
 641
 642
 643                         <div id="parse-method" class="method-detail ">
 644                                 <a name="M000021"></a>
 645
 646                                 <div class="method-heading">
 647
 648                                         <span class="method-name">parse</span><span
 649                                                 class="method-args">(&block)</span>
 650                                         <span class="method-click-advice">click to toggle source</span>
 651
 652                                 </div>
 653
 654                                 <div class="method-description">
 655
 656                                         <p>
 657 Parse the options returning the options, you can pass a block that adds
 658 additional options to the <a href="Optionparser.html">Optionparser</a>.
 659 </p>
 660 <p>
 661 The sample below starts a parser that also prompts for &#8212;arguments in
 662 addition to the defaults. It also sets the description and shows a usage
 663 message specific to this app.
 664 </p>
 665 <pre>
 666  options = oparser.parse{|parser, options|
 667       parser.define_head &quot;Control the mcollective controller daemon&quot;
 668       parser.banner = &quot;Usage: sh-mcollective [options] command&quot;
 669
 670       parser.on('--arg', '--argument ARGUMENT', 'Argument to pass to agent') do |v|
 671           options[:argument] = v
 672       end
 673  }
 674 </pre>
 675 <p>
 676 Users can set default options that get parsed in using the
 677 MCOLLECTIVE_EXTRA_OPTS environemnt variable
 678 </p>
 679
 680
 681
 682                                         <div class="method-source-code"
 683                                                 id="parse-source">
 684 <pre>
 685     <span class="ruby-comment cmt"># File lib/mcollective/optionparser.rb, line 48</span>
 686 48:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">parse</span>(<span class="ruby-operator">&amp;</span><span class="ruby-identifier">block</span>)
 687 49:       <span class="ruby-keyword kw">yield</span>(<span class="ruby-ivar">@parser</span>, <span class="ruby-ivar">@options</span>) <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">block_given?</span>
 688 50:
 689 51:       <span class="ruby-identifier">add_required_options</span>
 690 52:
 691 53:       <span class="ruby-identifier">add_common_options</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@exclude</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-value str">&quot;common&quot;</span>)
 692 54:
 693 55:       <span class="ruby-ivar">@include</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">i</span><span class="ruby-operator">|</span>
 694 56:         <span class="ruby-keyword kw">next</span> <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@exclude</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-identifier">i</span>)
 695 57:
 696 58:         <span class="ruby-identifier">options_name</span> = <span class="ruby-node">&quot;add_#{i}_options&quot;</span>
 697 59:         <span class="ruby-identifier">send</span>(<span class="ruby-identifier">options_name</span>)  <span class="ruby-keyword kw">if</span> <span class="ruby-identifier">respond_to?</span>(<span class="ruby-identifier">options_name</span>)
 698 60:       <span class="ruby-keyword kw">end</span>
 699 61:
 700 62:       <span class="ruby-ivar">@parser</span>.<span class="ruby-identifier">environment</span>(<span class="ruby-value str">&quot;MCOLLECTIVE_EXTRA_OPTS&quot;</span>)
 701 63:
 702 64:       <span class="ruby-ivar">@parser</span>.<span class="ruby-identifier">parse!</span>
 703 65:
 704 66:       <span class="ruby-ivar">@options</span>[<span class="ruby-identifier">:collective</span>] = <span class="ruby-constant">Config</span>.<span class="ruby-identifier">instance</span>.<span class="ruby-identifier">main_collective</span> <span class="ruby-keyword kw">unless</span> <span class="ruby-ivar">@options</span>[<span class="ruby-identifier">:collective</span>]
 705 67:
 706 68:       <span class="ruby-ivar">@options</span>
 707 69:     <span class="ruby-keyword kw">end</span></pre>
 708                                         </div>
 709
 710                                 </div>
 711
 712
 713                         </div>
 714
 715
 716                 </div>
 717
 718                 <div id="private-instance-method-details" class="method-section section">
 719                         <h3 class="section-header">Private Instance Methods</h3>
 720
 721
 722                         <div id="parse-fact-method" class="method-detail ">
 723                                 <a name="M000032"></a>
 724
 725                                 <div class="method-heading">
 726
 727                                         <span class="method-name">parse_fact</span><span
 728                                                 class="method-args">(fact)</span>
 729                                         <span class="method-click-advice">click to toggle source</span>
 730
 731                                 </div>
 732
 733                                 <div class="method-description">
 734
 735                                         <p>
 736 Parse a fact filter string like foo=bar into the tuple hash thats needed
 737 </p>
 738
 739
 740
 741                                         <div class="method-source-code"
 742                                                 id="parse-fact-source">
 743 <pre>
 744      <span class="ruby-comment cmt"># File lib/mcollective/optionparser.rb, line 184</span>
 745 184:     <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">parse_fact</span>(<span class="ruby-identifier">fact</span>)
 746 185:       <span class="ruby-constant">Util</span>.<span class="ruby-identifier">parse_fact_string</span>(<span class="ruby-identifier">fact</span>)
 747 186:     <span class="ruby-keyword kw">end</span></pre>
 748                                         </div>
 749
 750                                 </div>
 751
 752
 753                         </div>
 754
 755
 756                 </div>
 757
 758
 759         </div>
 760
 761
 762         <div id="rdoc-debugging-section-dump" class="debugging-section">
 763
 764                 <p>Disabled; run with --debug to generate this.</p>
 765
 766         </div>
 767
 768         <div id="validator-badges">
 769                 <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
 770                 <p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
 771                         Rdoc Generator</a> 1.1.6</small>.</p>
 772         </div>
 773
 774 </body>
 775 </html>
 776