-<?xml version="1.0" encoding="iso-8859-1"?>
-<!DOCTYPE html
- PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
- "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
- <title>Module: MCollective::Util</title>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
- <meta http-equiv="Content-Script-Type" content="text/javascript" />
- <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
- <script type="text/javascript">
- // <![CDATA[
-
- function popupCode( url ) {
- window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
- }
-
- function toggleCode( id ) {
- if ( document.getElementById )
- elem = document.getElementById( id );
- else if ( document.all )
- elem = eval( "document.all." + id );
- else
- return false;
-
- elemStyle = elem.style;
-
- if ( elemStyle.display != "block" ) {
- elemStyle.display = "block"
- } else {
- elemStyle.display = "none"
- }
-
- return true;
- }
-
- // Make codeblocks hidden by default
- document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
-
- // ]]>
- </script>
-
-</head>
-<body>
-
-
-
- <div id="classHeader">
- <table class="header-table">
- <tr class="top-aligned-row">
- <td><strong>Module</strong></td>
- <td class="class-name-in-header">MCollective::Util</td>
- </tr>
- <tr class="top-aligned-row">
- <td><strong>In:</strong></td>
- <td>
- <a href="../../files/lib/mcollective/util_rb.html">
- lib/mcollective/util.rb
- </a>
- <br />
- </td>
- </tr>
+ <meta content="text/html; charset=utf-8" http-equiv="Content-Type" />
- </table>
- </div>
- <!-- banner header -->
+ <title>Module: MCollective::Util</title>
- <div id="bodyContent">
+ <link rel="stylesheet" href="../rdoc.css" type="text/css" media="screen" />
+ <script src="../js/jquery.js" type="text/javascript"
+ charset="utf-8"></script>
+ <script src="../js/thickbox-compressed.js" type="text/javascript"
+ charset="utf-8"></script>
+ <script src="../js/quicksearch.js" type="text/javascript"
+ charset="utf-8"></script>
+ <script src="../js/darkfish.js" type="text/javascript"
+ charset="utf-8"></script>
-
- <div id="contextContent">
-
- <div id="description">
- <p>
+</head>
+<body class="module">
+
+ <div id="metadata">
+ <div id="file-metadata">
+ <div id="file-list-section" class="section">
+ <h3 class="section-header">In Files</h3>
+ <div class="section-body">
+ <ul>
+
+ <li><a href="../lib/mcollective/util_rb.html?TB_iframe=true&height=550&width=785"
+ class="thickbox" title="lib/mcollective/util.rb">lib/mcollective/util.rb</a></li>
+
+ </ul>
+ </div>
+ </div>
+
+
+ </div>
+
+ <div id="class-metadata">
+
+ <!-- Parent Class -->
+
+
+ <!-- Namespace Contents -->
+
+
+ <!-- Method Quickref -->
+
+ <div id="method-list-section" class="section">
+ <h3 class="section-header">Methods</h3>
+ <ul class="link-list">
+
+ <li><a href="#M000328">::absolute_path?</a></li>
+
+ <li><a href="#M000318">::align_text</a></li>
+
+ <li><a href="#M000313">::color</a></li>
+
+ <li><a href="#M000315">::colorize</a></li>
+
+ <li><a href="#M000325">::command_in_path?</a></li>
+
+ <li><a href="#M000303">::config_file_for_user</a></li>
+
+ <li><a href="#M000304">::default_options</a></li>
+
+ <li><a href="#M000301">::empty_filter</a></li>
+
+ <li><a href="#M000300">::empty_filter?</a></li>
+
+ <li><a href="#M000297">::get_fact</a></li>
+
+ <li><a href="#M000294">::has_agent?</a></li>
+
+ <li><a href="#M000296">::has_cf_class?</a></li>
+
+ <li><a href="#M000298">::has_fact?</a></li>
+
+ <li><a href="#M000299">::has_identity?</a></li>
+
+ <li><a href="#M000308">::loadclass</a></li>
+
+ <li><a href="#M000305">::make_subscriptions</a></li>
+
+ <li><a href="#M000317">::mcollective_version</a></li>
+
+ <li><a href="#M000309">::parse_fact_string</a></li>
+
+ <li><a href="#M000316">::ruby_version</a></li>
+
+ <li><a href="#M000295">::setup_windows_sleeper</a></li>
+
+ <li><a href="#M000311">::shellescape</a></li>
+
+ <li><a href="#M000329">::str_to_bool</a></li>
+
+ <li><a href="#M000306">::subscribe</a></li>
+
+ <li><a href="#M000330">::t</a></li>
+
+ <li><a href="#M000331">::templatepath</a></li>
+
+ <li><a href="#M000322">::terminal_dimensions</a></li>
+
+ <li><a href="#M000307">::unsubscribe</a></li>
+
+ <li><a href="#M000326">::versioncmp</a></li>
+
+ <li><a href="#M000312">::windows?</a></li>
+
+ <li><a href="#M000302">::windows_prefix</a></li>
+
+ </ul>
+ </div>
+
+
+ <!-- Included Modules -->
+
+ </div>
+
+ <div id="project-metadata">
+
+
+ <div id="fileindex-section" class="section project-section">
+ <h3 class="section-header">Files</h3>
+ <ul>
+
+ <li class="file"><a href="../COPYING.html">COPYING</a></li>
+
+ <li class="file"><a href="../Gemfile.html">Gemfile</a></li>
+
+ <li class="file"><a href="../README.html">README</a></li>
+
+ <li class="file"><a href="../Rakefile.html">Rakefile</a></li>
+
+ <li class="file"><a href="../etc/client_cfg_dist.html">client.cfg.dist</a></li>
+
+ <li class="file"><a href="../etc/data-help_erb.html">data-help.erb</a></li>
+
+ <li class="file"><a href="../etc/discovery-help_erb.html">discovery-help.erb</a></li>
+
+ <li class="file"><a href="../etc/facts_yaml_dist.html">facts.yaml.dist</a></li>
+
+ <li class="file"><a href="../etc/metadata-help_erb.html">metadata-help.erb</a></li>
+
+ <li class="file"><a href="../etc/msg-help_erb.html">msg-help.erb</a></li>
+
+ <li class="file"><a href="../etc/rpc-help_erb.html">rpc-help.erb</a></li>
+
+ <li class="file"><a href="../etc/server_cfg_dist.html">server.cfg.dist</a></li>
+
+ <li class="file"><a href="../etc/ssl/PLACEHOLDER.html">PLACEHOLDER</a></li>
+
+ <li class="file"><a href="../etc/ssl/clients/PLACEHOLDER.html">PLACEHOLDER</a></li>
+
+ <li class="file"><a href="../lib/mcollective/generators/templates/action_snippet_erb.html">action_snippet.erb</a></li>
+
+ <li class="file"><a href="../lib/mcollective/generators/templates/data_input_snippet_erb.html">data_input_snippet.erb</a></li>
+
+ <li class="file"><a href="../lib/mcollective/generators/templates/ddl_erb.html">ddl.erb</a></li>
+
+ <li class="file"><a href="../lib/mcollective/generators/templates/plugin_erb.html">plugin.erb</a></li>
+
+ <li class="file"><a href="../lib/mcollective/locales/en_yml.html">en.yml</a></li>
+
+ <li class="file"><a href="../mcollective_init.html">mcollective.init</a></li>
+
+ </ul>
+ </div>
+
+
+ <div id="classindex-section" class="section project-section">
+ <h3 class="section-header">Class Index
+ <span class="search-toggle"><img src="../images/find.png"
+ height="16" width="16" alt="[+]"
+ title="show/hide quicksearch" /></span></h3>
+ <form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
+ <fieldset>
+ <legend>Quicksearch</legend>
+ <input type="text" name="quicksearch" value=""
+ class="quicksearch-field" />
+ </fieldset>
+ </form>
+
+ <ul class="link-list">
+
+ <li><a href="../MCollective.html">MCollective</a></li>
+
+ <li><a href="../MCollective/Agent.html">MCollective::Agent</a></li>
+
+ <li><a href="../MCollective/Agents.html">MCollective::Agents</a></li>
+
+ <li><a href="../MCollective/Aggregate.html">MCollective::Aggregate</a></li>
+
+ <li><a href="../MCollective/Aggregate/Base.html">MCollective::Aggregate::Base</a></li>
+
+ <li><a href="../MCollective/Aggregate/Result.html">MCollective::Aggregate::Result</a></li>
+
+ <li><a href="../MCollective/Aggregate/Result/Base.html">MCollective::Aggregate::Result::Base</a></li>
+
+ <li><a href="../MCollective/Aggregate/Result/CollectionResult.html">MCollective::Aggregate::Result::CollectionResult</a></li>
+
+ <li><a href="../MCollective/Aggregate/Result/NumericResult.html">MCollective::Aggregate::Result::NumericResult</a></li>
+
+ <li><a href="../MCollective/Application.html">MCollective::Application</a></li>
+
+ <li><a href="../MCollective/Applications.html">MCollective::Applications</a></li>
+
+ <li><a href="../MCollective/Cache.html">MCollective::Cache</a></li>
+
+ <li><a href="../MCollective/Client.html">MCollective::Client</a></li>
+
+ <li><a href="../MCollective/CodedError.html">MCollective::CodedError</a></li>
+
+ <li><a href="../MCollective/Config.html">MCollective::Config</a></li>
+
+ <li><a href="../MCollective/Connector.html">MCollective::Connector</a></li>
+
+ <li><a href="../MCollective/Connector/Base.html">MCollective::Connector::Base</a></li>
+
+ <li><a href="../MCollective/DDL.html">MCollective::DDL</a></li>
+
+ <li><a href="../MCollective/DDL/AgentDDL.html">MCollective::DDL::AgentDDL</a></li>
+
+ <li><a href="../MCollective/DDL/Base.html">MCollective::DDL::Base</a></li>
+
+ <li><a href="../MCollective/DDL/DataDDL.html">MCollective::DDL::DataDDL</a></li>
+
+ <li><a href="../MCollective/DDL/DiscoveryDDL.html">MCollective::DDL::DiscoveryDDL</a></li>
+
+ <li><a href="../MCollective/DDL/ValidatorDDL.html">MCollective::DDL::ValidatorDDL</a></li>
+
+ <li><a href="../MCollective/DDLValidationError.html">MCollective::DDLValidationError</a></li>
+
+ <li><a href="../MCollective/Data.html">MCollective::Data</a></li>
+
+ <li><a href="../MCollective/Data/Base.html">MCollective::Data::Base</a></li>
+
+ <li><a href="../MCollective/Data/Result.html">MCollective::Data::Result</a></li>
+
+ <li><a href="../MCollective/Discovery.html">MCollective::Discovery</a></li>
+
+ <li><a href="../MCollective/Facts.html">MCollective::Facts</a></li>
+
+ <li><a href="../MCollective/Facts/Base.html">MCollective::Facts::Base</a></li>
+
+ <li><a href="../MCollective/Generators.html">MCollective::Generators</a></li>
+
+ <li><a href="../MCollective/Generators/AgentGenerator.html">MCollective::Generators::AgentGenerator</a></li>
+
+ <li><a href="../MCollective/Generators/Base.html">MCollective::Generators::Base</a></li>
+
+ <li><a href="../MCollective/Generators/DataGenerator.html">MCollective::Generators::DataGenerator</a></li>
+
+ <li><a href="../MCollective/InvalidRPCData.html">MCollective::InvalidRPCData</a></li>
+
+ <li><a href="../MCollective/Log.html">MCollective::Log</a></li>
+
+ <li><a href="../MCollective/Logger.html">MCollective::Logger</a></li>
+
+ <li><a href="../MCollective/Logger/Base.html">MCollective::Logger::Base</a></li>
+
+ <li><a href="../MCollective/Logger/Console_logger.html">MCollective::Logger::Console_logger</a></li>
+
+ <li><a href="../MCollective/Logger/File_logger.html">MCollective::Logger::File_logger</a></li>
+
+ <li><a href="../MCollective/Logger/Syslog_logger.html">MCollective::Logger::Syslog_logger</a></li>
+
+ <li><a href="../MCollective/Matcher.html">MCollective::Matcher</a></li>
+
+ <li><a href="../MCollective/Matcher/Parser.html">MCollective::Matcher::Parser</a></li>
+
+ <li><a href="../MCollective/Matcher/Scanner.html">MCollective::Matcher::Scanner</a></li>
+
+ <li><a href="../MCollective/Message.html">MCollective::Message</a></li>
+
+ <li><a href="../MCollective/MissingRPCData.html">MCollective::MissingRPCData</a></li>
+
+ <li><a href="../MCollective/MsgDoesNotMatchRequestID.html">MCollective::MsgDoesNotMatchRequestID</a></li>
+
+ <li><a href="../MCollective/MsgTTLExpired.html">MCollective::MsgTTLExpired</a></li>
+
+ <li><a href="../MCollective/NotTargettedAtUs.html">MCollective::NotTargettedAtUs</a></li>
+
+ <li><a href="../MCollective/Optionparser.html">MCollective::Optionparser</a></li>
+
+ <li><a href="../MCollective/PluginManager.html">MCollective::PluginManager</a></li>
+
+ <li><a href="../MCollective/PluginPackager.html">MCollective::PluginPackager</a></li>
+
+ <li><a href="../MCollective/PluginPackager/AgentDefinition.html">MCollective::PluginPackager::AgentDefinition</a></li>
+
+ <li><a href="../MCollective/PluginPackager/StandardDefinition.html">MCollective::PluginPackager::StandardDefinition</a></li>
+
+ <li><a href="../MCollective/RPC.html">MCollective::RPC</a></li>
+
+ <li><a href="../MCollective/RPC/ActionRunner.html">MCollective::RPC::ActionRunner</a></li>
+
+ <li><a href="../MCollective/RPC/Agent.html">MCollective::RPC::Agent</a></li>
+
+ <li><a href="../MCollective/RPC/Audit.html">MCollective::RPC::Audit</a></li>
+
+ <li><a href="../MCollective/RPC/Client.html">MCollective::RPC::Client</a></li>
+
+ <li><a href="../MCollective/RPC/Helpers.html">MCollective::RPC::Helpers</a></li>
+
+ <li><a href="../MCollective/RPC/Progress.html">MCollective::RPC::Progress</a></li>
+
+ <li><a href="../MCollective/RPC/Reply.html">MCollective::RPC::Reply</a></li>
+
+ <li><a href="../MCollective/RPC/Request.html">MCollective::RPC::Request</a></li>
+
+ <li><a href="../MCollective/RPC/Result.html">MCollective::RPC::Result</a></li>
+
+ <li><a href="../MCollective/RPC/Stats.html">MCollective::RPC::Stats</a></li>
+
+ <li><a href="../MCollective/RPCAborted.html">MCollective::RPCAborted</a></li>
+
+ <li><a href="../MCollective/RPCError.html">MCollective::RPCError</a></li>
+
+ <li><a href="../MCollective/Registration.html">MCollective::Registration</a></li>
+
+ <li><a href="../MCollective/Registration/Base.html">MCollective::Registration::Base</a></li>
+
+ <li><a href="../MCollective/Runner.html">MCollective::Runner</a></li>
+
+ <li><a href="../MCollective/RunnerStats.html">MCollective::RunnerStats</a></li>
+
+ <li><a href="../MCollective/SSL.html">MCollective::SSL</a></li>
+
+ <li><a href="../MCollective/Security.html">MCollective::Security</a></li>
+
+ <li><a href="../MCollective/Security/Base.html">MCollective::Security::Base</a></li>
+
+ <li><a href="../MCollective/SecurityValidationFailed.html">MCollective::SecurityValidationFailed</a></li>
+
+ <li><a href="../MCollective/Shell.html">MCollective::Shell</a></li>
+
+ <li><a href="../MCollective/Translatable.html">MCollective::Translatable</a></li>
+
+ <li><a href="../MCollective/UnixDaemon.html">MCollective::UnixDaemon</a></li>
+
+ <li><a href="../MCollective/UnknownRPCAction.html">MCollective::UnknownRPCAction</a></li>
+
+ <li><a href="../MCollective/UnknownRPCError.html">MCollective::UnknownRPCError</a></li>
+
+ <li><a href="../MCollective/Util.html">MCollective::Util</a></li>
+
+ <li><a href="../MCollective/Validator.html">MCollective::Validator</a></li>
+
+ <li><a href="../MCollective/ValidatorError.html">MCollective::ValidatorError</a></li>
+
+ <li><a href="../MCollective/WindowsDaemon.html">MCollective::WindowsDaemon</a></li>
+
+ <li><a href="../Array.html">Array</a></li>
+
+ <li><a href="../Dir.html">Dir</a></li>
+
+ <li><a href="../Object.html">Object</a></li>
+
+ <li><a href="../String.html">String</a></li>
+
+ <li><a href="../Symbol.html">Symbol</a></li>
+
+ </ul>
+ <div id="no-class-search-results" style="display: none;">No matching classes.</div>
+ </div>
+
+
+ </div>
+ </div>
+
+ <div id="documentation">
+ <h1 class="module">MCollective::Util</h1>
+
+ <div id="description">
+ <p>
Some basic utility helper methods useful to clients, agents, runner etc.
</p>
- </div>
-
-
- </div>
-
- <div id="method-list">
- <h3 class="section-bar">Methods</h3>
+ </div>
- <div class="name-list">
- <a href="#M000307">absolute_path?</a>
- <a href="#M000303">align_text</a>
- <a href="#M000299">color</a>
- <a href="#M000300">colorize</a>
- <a href="#M000305">command_in_path?</a>
- <a href="#M000290">config_file_for_user</a>
- <a href="#M000291">default_options</a>
- <a href="#M000288">empty_filter</a>
- <a href="#M000287">empty_filter?</a>
- <a href="#M000284">get_fact</a>
- <a href="#M000281">has_agent?</a>
- <a href="#M000283">has_cf_class?</a>
- <a href="#M000285">has_fact?</a>
- <a href="#M000286">has_identity?</a>
- <a href="#M000295">loadclass</a>
- <a href="#M000292">make_subscriptions</a>
- <a href="#M000302">mcollective_version</a>
- <a href="#M000296">parse_fact_string</a>
- <a href="#M000301">ruby_version</a>
- <a href="#M000282">setup_windows_sleeper</a>
- <a href="#M000297">shellescape</a>
- <a href="#M000308">str_to_bool</a>
- <a href="#M000293">subscribe</a>
- <a href="#M000309">t</a>
- <a href="#M000310">templatepath</a>
- <a href="#M000304">terminal_dimensions</a>
- <a href="#M000294">unsubscribe</a>
- <a href="#M000306">versioncmp</a>
- <a href="#M000298">windows?</a>
- <a href="#M000289">windows_prefix</a>
- </div>
- </div>
+ <!-- Constants -->
+
- </div>
+ <!-- Attributes -->
+
+ <!-- Methods -->
+
+ <div id="public-class-method-details" class="method-section section">
+ <h3 class="section-header">Public Class Methods</h3>
- <!-- if includes -->
+
+ <div id="absolute-path--method" class="method-detail ">
+ <a name="M000328"></a>
- <div id="section">
+ <div class="method-heading">
+
+ <span class="method-name">absolute_path?</span><span
+ class="method-args">(path, separator=File::SEPARATOR, alt_separator=File::ALT_SEPARATOR)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
-
-
-
-
-
-
-
- <!-- if method_list -->
- <div id="methods">
- <h3 class="section-bar">Public Class methods</h3>
-
- <div id="method-M000307" class="method-detail">
- <a name="M000307"></a>
-
- <div class="method-heading">
- <a href="#M000307" class="method-signature">
- <span class="method-name">absolute_path?</span><span class="method-args">(path, separator=File::SEPARATOR, alt_separator=File::ALT_SEPARATOR)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-we should really use Pathname#absolute? but it‘s not in all the ruby
+ <div class="method-description">
+
+ <p>
+we should really use Pathname#absolute? but it’s not in all the ruby
versions we support and it comes down to roughly this
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000307-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000307-source">
+
+
+
+ <div class="method-source-code"
+ id="absolute-path--source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/util.rb, line 464</span>
464: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">absolute_path?</span>(<span class="ruby-identifier">path</span>, <span class="ruby-identifier">separator</span>=<span class="ruby-constant">File</span><span class="ruby-operator">::</span><span class="ruby-constant">SEPARATOR</span>, <span class="ruby-identifier">alt_separator</span>=<span class="ruby-constant">File</span><span class="ruby-operator">::</span><span class="ruby-constant">ALT_SEPARATOR</span>)
469: <span class="ruby-keyword kw">end</span>
470:
471: <span class="ruby-operator">!</span><span class="ruby-operator">!</span><span class="ruby-identifier">path</span>.<span class="ruby-identifier">match</span>(<span class="ruby-identifier">path_matcher</span>)
-472: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000303" class="method-detail">
- <a name="M000303"></a>
-
- <div class="method-heading">
- <a href="#M000303" class="method-signature">
- <span class="method-name">align_text</span><span class="method-args">(text, console_cols = nil, preamble = 5)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+472: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="align-text-method" class="method-detail ">
+ <a name="M000318"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">align_text</span><span
+ class="method-args">(text, console_cols = nil, preamble = 5)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Returns an aligned_string of text relative to the size of the terminal
window. If a line in the string exceeds the width of the terminal window
the line will be chopped off at the whitespace chacter closest to the end
passed. All strings will also be left aligned with 5 whitespace characters
by default.
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000303-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000303-source">
+
+
+
+ <div class="method-source-code"
+ id="align-text-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/util.rb, line 310</span>
310: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">align_text</span>(<span class="ruby-identifier">text</span>, <span class="ruby-identifier">console_cols</span> = <span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">preamble</span> = <span class="ruby-value">5</span>)
387: <span class="ruby-keyword kw">end</span>
388:
389: <span class="ruby-identifier">text</span>.<span class="ruby-identifier">join</span>(<span class="ruby-value str">"\n"</span>)
-390: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000299" class="method-detail">
- <a name="M000299"></a>
-
- <div class="method-heading">
- <a href="#M000299" class="method-signature">
- <span class="method-name">color</span><span class="method-args">(code)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Return <a href="Util.html#M000299">color</a> codes, if the config color=
-option is false just return a empty string
+390: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="color-method" class="method-detail ">
+ <a name="M000313"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">color</span><span
+ class="method-args">(code)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Return color codes, if the config color= option is false just return a
+empty string
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000299-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000299-source">
+
+
+
+ <div class="method-source-code"
+ id="color-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/util.rb, line 270</span>
270: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">color</span>(<span class="ruby-identifier">code</span>)
282: <span class="ruby-keyword kw">else</span>
283: <span class="ruby-keyword kw">return</span> <span class="ruby-value str">""</span>
284: <span class="ruby-keyword kw">end</span>
-285: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000300" class="method-detail">
- <a name="M000300"></a>
-
- <div class="method-heading">
- <a href="#M000300" class="method-signature">
- <span class="method-name">colorize</span><span class="method-args">(code, msg)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Helper to return a string in specific <a href="Util.html#M000299">color</a>
+285: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="colorize-method" class="method-detail ">
+ <a name="M000315"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">colorize</span><span
+ class="method-args">(code, msg)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Helper to return a string in specific color
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000300-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000300-source">
+
+
+
+ <div class="method-source-code"
+ id="colorize-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/util.rb, line 288</span>
288: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">colorize</span>(<span class="ruby-identifier">code</span>, <span class="ruby-identifier">msg</span>)
289: <span class="ruby-value str">"%s%s%s"</span> <span class="ruby-operator">%</span> [ <span class="ruby-identifier">color</span>(<span class="ruby-identifier">code</span>), <span class="ruby-identifier">msg</span>, <span class="ruby-identifier">color</span>(<span class="ruby-identifier">:reset</span>) ]
-290: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000305" class="method-detail">
- <a name="M000305"></a>
-
- <div class="method-heading">
- <a href="#M000305" class="method-signature">
- <span class="method-name">command_in_path?</span><span class="method-args">(command)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+290: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="command-in-path--method" class="method-detail ">
+ <a name="M000325"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">command_in_path?</span><span
+ class="method-args">(command)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Checks in PATH returns true if the command is found
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000305-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000305-source">
+
+
+
+ <div class="method-source-code"
+ id="command-in-path--source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/util.rb, line 417</span>
417: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">command_in_path?</span>(<span class="ruby-identifier">command</span>)
420: <span class="ruby-keyword kw">end</span>
421:
422: <span class="ruby-identifier">found</span>.<span class="ruby-identifier">include?</span>(<span class="ruby-keyword kw">true</span>)
-423: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000290" class="method-detail">
- <a name="M000290"></a>
-
- <div class="method-heading">
- <a href="#M000290" class="method-signature">
- <span class="method-name">config_file_for_user</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+423: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="config-file-for-user-method" class="method-detail ">
+ <a name="M000303"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">config_file_for_user</span><span
+ class="method-args">()</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Picks a config file defaults to ~/.mcollective else
/etc/mcollective/client.cfg
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000290-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000290-source">
+
+
+
+ <div class="method-source-code"
+ id="config-file-for-user-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/util.rb, line 148</span>
148: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">config_file_for_user</span>
168: <span class="ruby-keyword kw">end</span>
169:
170: <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">config</span>
-171: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000291" class="method-detail">
- <a name="M000291"></a>
-
- <div class="method-heading">
- <a href="#M000291" class="method-signature">
- <span class="method-name">default_options</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+171: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="default-options-method" class="method-detail ">
+ <a name="M000304"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">default_options</span><span
+ class="method-args">()</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Creates a standard options hash
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000291-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000291-source">
+
+
+
+ <div class="method-source-code"
+ id="default-options-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/util.rb, line 174</span>
174: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">default_options</span>
180: <span class="ruby-identifier">:discovery_method</span> =<span class="ruby-operator">></span> <span class="ruby-keyword kw">nil</span>,
181: <span class="ruby-identifier">:discovery_options</span> =<span class="ruby-operator">></span> <span class="ruby-constant">Config</span>.<span class="ruby-identifier">instance</span>.<span class="ruby-identifier">default_discovery_options</span>,
182: <span class="ruby-identifier">:filter</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">empty_filter</span>}
-183: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000288" class="method-detail">
- <a name="M000288"></a>
-
- <div class="method-heading">
- <a href="#M000288" class="method-signature">
- <span class="method-name">empty_filter</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+183: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="empty-filter-method" class="method-detail ">
+ <a name="M000301"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">empty_filter</span><span
+ class="method-args">()</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Creates an empty filter
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000288-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000288-source">
+
+
+
+ <div class="method-source-code"
+ id="empty-filter-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/util.rb, line 132</span>
132: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">empty_filter</span>
135: <span class="ruby-value str">"agent"</span> =<span class="ruby-operator">></span> [],
136: <span class="ruby-value str">"identity"</span> =<span class="ruby-operator">></span> [],
137: <span class="ruby-value str">"compound"</span> =<span class="ruby-operator">></span> []}
-138: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000287" class="method-detail">
- <a name="M000287"></a>
-
- <div class="method-heading">
- <a href="#M000287" class="method-signature">
- <span class="method-name">empty_filter?</span><span class="method-args">(filter)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+138: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="empty-filter--method" class="method-detail ">
+ <a name="M000300"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">empty_filter?</span><span
+ class="method-args">(filter)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Checks if the passed in filter is an empty one
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000287-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000287-source">
+
+
+
+ <div class="method-source-code"
+ id="empty-filter--source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/util.rb, line 127</span>
127: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">empty_filter?</span>(<span class="ruby-identifier">filter</span>)
128: <span class="ruby-identifier">filter</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">empty_filter</span> <span class="ruby-operator">||</span> <span class="ruby-identifier">filter</span> <span class="ruby-operator">==</span> {}
-129: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000284" class="method-detail">
- <a name="M000284"></a>
-
- <div class="method-heading">
- <a href="#M000284" class="method-signature">
- <span class="method-name">get_fact</span><span class="method-args">(fact)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+129: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="get-fact-method" class="method-detail ">
+ <a name="M000297"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">get_fact</span><span
+ class="method-args">(fact)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Gets the value of a specific fact, mostly just a duplicate of <a
-href="Facts.html#M000017">MCollective::Facts.get_fact</a> but it kind of
+href="Facts.html#M000483">MCollective::Facts.get_fact</a> but it kind of
goes with the other classes here
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000284-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000284-source">
+
+
+
+ <div class="method-source-code"
+ id="get-fact-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/util.rb, line 63</span>
63: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">get_fact</span>(<span class="ruby-identifier">fact</span>)
64: <span class="ruby-constant">Facts</span>.<span class="ruby-identifier">get_fact</span>(<span class="ruby-identifier">fact</span>)
-65: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000281" class="method-detail">
- <a name="M000281"></a>
-
- <div class="method-heading">
- <a href="#M000281" class="method-signature">
- <span class="method-name">has_agent?</span><span class="method-args">(agent)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+65: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="has-agent--method" class="method-detail ">
+ <a name="M000294"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">has_agent?</span><span
+ class="method-args">(agent)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Finds out if this <a href="../MCollective.html">MCollective</a> has an
agent by the name passed
</p>
<p>
-If the passed name starts with a / it‘s assumed to be regex and will
+If the passed name starts with a / it’s assumed to be regex and will
use regex to match
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000281-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000281-source">
+
+
+
+ <div class="method-source-code"
+ id="has-agent--source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/util.rb, line 10</span>
10: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">has_agent?</span>(<span class="ruby-identifier">agent</span>)
21: <span class="ruby-keyword kw">end</span>
22:
23: <span class="ruby-keyword kw">false</span>
-24: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000283" class="method-detail">
- <a name="M000283"></a>
-
- <div class="method-heading">
- <a href="#M000283" class="method-signature">
- <span class="method-name">has_cf_class?</span><span class="method-args">(klass)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+24: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="has-cf-class--method" class="method-detail ">
+ <a name="M000296"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">has_cf_class?</span><span
+ class="method-args">(klass)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Checks if this node has a configuration management class by parsing the a
text file with just a list of classes, recipes, roles etc. This is ala the
classes.txt from puppet.
</p>
<p>
-If the passed name starts with a / it‘s assumed to be regex and will
+If the passed name starts with a / it’s assumed to be regex and will
use regex to match
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000283-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000283-source">
+
+
+
+ <div class="method-source-code"
+ id="has-cf-class--source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/util.rb, line 40</span>
40: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">has_cf_class?</span>(<span class="ruby-identifier">klass</span>)
56: <span class="ruby-keyword kw">end</span>
57:
58: <span class="ruby-keyword kw">false</span>
-59: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000285" class="method-detail">
- <a name="M000285"></a>
-
- <div class="method-heading">
- <a href="#M000285" class="method-signature">
- <span class="method-name">has_fact?</span><span class="method-args">(fact, value, operator)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+59: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="has-fact--method" class="method-detail ">
+ <a name="M000298"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">has_fact?</span><span
+ class="method-args">(fact, value, operator)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Compares fact == value,
</p>
<p>
-If the passed value starts with a / it‘s assumed to be regex and will
+If the passed value starts with a / it’s assumed to be regex and will
use regex to match
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000285-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000285-source">
+
+
+
+ <div class="method-source-code"
+ id="has-fact--source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/util.rb, line 71</span>
71: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">has_fact?</span>(<span class="ruby-identifier">fact</span>, <span class="ruby-identifier">value</span>, <span class="ruby-identifier">operator</span>)
105: <span class="ruby-keyword kw">end</span>
106:
107: <span class="ruby-keyword kw">false</span>
-108: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000286" class="method-detail">
- <a name="M000286"></a>
-
- <div class="method-heading">
- <a href="#M000286" class="method-signature">
- <span class="method-name">has_identity?</span><span class="method-args">(identity)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+108: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="has-identity--method" class="method-detail ">
+ <a name="M000299"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">has_identity?</span><span
+ class="method-args">(identity)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Checks if the configured identity matches the one supplied
</p>
<p>
-If the passed name starts with a / it‘s assumed to be regex and will
+If the passed name starts with a / it’s assumed to be regex and will
use regex to match
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000286-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000286-source">
+
+
+
+ <div class="method-source-code"
+ id="has-identity--source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/util.rb, line 114</span>
114: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">has_identity?</span>(<span class="ruby-identifier">identity</span>)
121: <span class="ruby-keyword kw">end</span>
122:
123: <span class="ruby-keyword kw">false</span>
-124: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000295" class="method-detail">
- <a name="M000295"></a>
-
- <div class="method-heading">
- <a href="#M000295" class="method-signature">
- <span class="method-name">loadclass</span><span class="method-args">(klass)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+124: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="loadclass-method" class="method-detail ">
+ <a name="M000308"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">loadclass</span><span
+ class="method-args">(klass)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Wrapper around <a
-href="PluginManager.html#M000034">PluginManager.loadclass</a>
+href="PluginManager.html#M000084">PluginManager.loadclass</a>
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000295-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000295-source">
+
+
+
+ <div class="method-source-code"
+ id="loadclass-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/util.rb, line 224</span>
224: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">loadclass</span>(<span class="ruby-identifier">klass</span>)
225: <span class="ruby-constant">PluginManager</span>.<span class="ruby-identifier">loadclass</span>(<span class="ruby-identifier">klass</span>)
-226: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000292" class="method-detail">
- <a name="M000292"></a>
-
- <div class="method-heading">
- <a href="#M000292" class="method-signature">
- <span class="method-name">make_subscriptions</span><span class="method-args">(agent, type, collective=nil)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000292-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000292-source">
+226: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="make-subscriptions-method" class="method-detail ">
+ <a name="M000305"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">make_subscriptions</span><span
+ class="method-args">(agent, type, collective=nil)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+
+
+ <div class="method-source-code"
+ id="make-subscriptions-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/util.rb, line 185</span>
185: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">make_subscriptions</span>(<span class="ruby-identifier">agent</span>, <span class="ruby-identifier">type</span>, <span class="ruby-identifier">collective</span>=<span class="ruby-keyword kw">nil</span>)
196:
197: [{<span class="ruby-identifier">:agent</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">agent</span>, <span class="ruby-identifier">:type</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">type</span>, <span class="ruby-identifier">:collective</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">collective</span>}]
198: <span class="ruby-keyword kw">end</span>
-199: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000302" class="method-detail">
- <a name="M000302"></a>
-
- <div class="method-heading">
- <a href="#M000302" class="method-signature">
- <span class="method-name">mcollective_version</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000302-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000302-source">
+199: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="mcollective-version-method" class="method-detail ">
+ <a name="M000317"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">mcollective_version</span><span
+ class="method-args">()</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+
+
+ <div class="method-source-code"
+ id="mcollective-version-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/util.rb, line 298</span>
298: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">mcollective_version</span>
299: <span class="ruby-constant">MCollective</span><span class="ruby-operator">::</span><span class="ruby-constant">VERSION</span>
-300: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000296" class="method-detail">
- <a name="M000296"></a>
-
- <div class="method-heading">
- <a href="#M000296" class="method-signature">
- <span class="method-name">parse_fact_string</span><span class="method-args">(fact)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+300: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="parse-fact-string-method" class="method-detail ">
+ <a name="M000309"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">parse_fact_string</span><span
+ class="method-args">(fact)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Parse a fact filter string like foo=bar into the tuple hash thats needed
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000296-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000296-source">
+
+
+
+ <div class="method-source-code"
+ id="parse-fact-string-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/util.rb, line 229</span>
229: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">parse_fact_string</span>(<span class="ruby-identifier">fact</span>)
240: <span class="ruby-keyword kw">else</span>
241: <span class="ruby-identifier">raise</span> <span class="ruby-node">"Could not parse fact #{fact} it does not appear to be in a valid format"</span>
242: <span class="ruby-keyword kw">end</span>
-243: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000301" class="method-detail">
- <a name="M000301"></a>
-
- <div class="method-heading">
- <a href="#M000301" class="method-signature">
- <span class="method-name">ruby_version</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+243: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="ruby-version-method" class="method-detail ">
+ <a name="M000316"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">ruby_version</span><span
+ class="method-args">()</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Returns the current ruby version as per RUBY_VERSION, mostly doing this
here to aid testing
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000301-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000301-source">
+
+
+
+ <div class="method-source-code"
+ id="ruby-version-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/util.rb, line 294</span>
294: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">ruby_version</span>
295: <span class="ruby-constant">RUBY_VERSION</span>
-296: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000282" class="method-detail">
- <a name="M000282"></a>
-
- <div class="method-heading">
- <a href="#M000282" class="method-signature">
- <span class="method-name">setup_windows_sleeper</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-On windows ^c can‘<a href="Util.html#M000309">t</a> interrupt the VM
-if its blocking on IO, so this sets up a dummy thread that sleeps and this
-will have the end result of being interruptable at least once a second.
-This is a common pattern found in Rails etc
+296: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="setup-windows-sleeper-method" class="method-detail ">
+ <a name="M000295"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">setup_windows_sleeper</span><span
+ class="method-args">()</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+On windows ^c can’t interrupt the VM if its blocking on IO, so this
+sets up a dummy thread that sleeps and this will have the end result of
+being interruptable at least once a second. This is a common pattern found
+in Rails etc
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000282-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000282-source">
+
+
+
+ <div class="method-source-code"
+ id="setup-windows-sleeper-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/util.rb, line 30</span>
30: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">setup_windows_sleeper</span>
31: <span class="ruby-constant">Thread</span>.<span class="ruby-identifier">new</span> { <span class="ruby-identifier">loop</span> { <span class="ruby-identifier">sleep</span> <span class="ruby-value">1</span> } } <span class="ruby-keyword kw">if</span> <span class="ruby-constant">Util</span>.<span class="ruby-identifier">windows?</span>
-32: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000297" class="method-detail">
- <a name="M000297"></a>
-
- <div class="method-heading">
- <a href="#M000297" class="method-signature">
- <span class="method-name">shellescape</span><span class="method-args">(str)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Escapes a string so it‘s safe to use in system() or backticks
+32: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="shellescape-method" class="method-detail ">
+ <a name="M000311"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">shellescape</span><span
+ class="method-args">(str)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Escapes a string so it’s safe to use in system() or backticks
</p>
<p>
-Taken from Shellwords#shellescape since it‘s only in a few ruby
+Taken from Shellwords#shellescape since it’s only in a few ruby
versions
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000297-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000297-source">
+
+
+
+ <div class="method-source-code"
+ id="shellescape-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/util.rb, line 248</span>
248: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">shellescape</span>(<span class="ruby-identifier">str</span>)
259: <span class="ruby-identifier">str</span>.<span class="ruby-identifier">gsub!</span>(<span class="ruby-regexp re">/\n/</span>, <span class="ruby-value str">"'\n'"</span>)
260:
261: <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">str</span>
-262: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000308" class="method-detail">
- <a name="M000308"></a>
-
- <div class="method-heading">
- <a href="#M000308" class="method-signature">
- <span class="method-name">str_to_bool</span><span class="method-args">(val)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Converts a string into a boolean value Strings matching 1,y,yes,true or <a
-href="Util.html#M000309">t</a> will return TrueClass Any other value will
-return FalseClass
+262: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="str-to-bool-method" class="method-detail ">
+ <a name="M000329"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">str_to_bool</span><span
+ class="method-args">(val)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Converts a string into a boolean value Strings matching 1,y,yes,true or t
+will return TrueClass Any other value will return FalseClass
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000308-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000308-source">
+
+
+
+ <div class="method-source-code"
+ id="str-to-bool-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/util.rb, line 477</span>
477: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">str_to_bool</span>(<span class="ruby-identifier">val</span>)
483: <span class="ruby-keyword kw">else</span>
484: <span class="ruby-identifier">raise_code</span>(<span class="ruby-identifier">:PLMC42</span>, <span class="ruby-value str">"Cannot convert string value '%{value}' into a boolean."</span>, <span class="ruby-identifier">:error</span>, <span class="ruby-identifier">:value</span> =<span class="ruby-operator">></span> <span class="ruby-identifier">clean_val</span>)
485: <span class="ruby-keyword kw">end</span>
-486: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000293" class="method-detail">
- <a name="M000293"></a>
-
- <div class="method-heading">
- <a href="#M000293" class="method-signature">
- <span class="method-name">subscribe</span><span class="method-args">(targets)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Helper to <a href="Util.html#M000293">subscribe</a> to a topic on multiple
-collectives or just one
+486: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="subscribe-method" class="method-detail ">
+ <a name="M000306"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">subscribe</span><span
+ class="method-args">(targets)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Helper to subscribe to a topic on multiple collectives or just one
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000293-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000293-source">
+
+
+
+ <div class="method-source-code"
+ id="subscribe-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/util.rb, line 202</span>
202: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">subscribe</span>(<span class="ruby-identifier">targets</span>)
207: <span class="ruby-identifier">targets</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">target</span><span class="ruby-operator">|</span>
208: <span class="ruby-identifier">connection</span>.<span class="ruby-identifier">subscribe</span>(<span class="ruby-identifier">target</span>[<span class="ruby-identifier">:agent</span>], <span class="ruby-identifier">target</span>[<span class="ruby-identifier">:type</span>], <span class="ruby-identifier">target</span>[<span class="ruby-identifier">:collective</span>])
209: <span class="ruby-keyword kw">end</span>
-210: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000309" class="method-detail">
- <a name="M000309"></a>
-
- <div class="method-heading">
- <a href="#M000309" class="method-signature">
- <span class="method-name">t</span><span class="method-args">(msgid, args={})</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+210: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="t-method" class="method-detail ">
+ <a name="M000330"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">t</span><span
+ class="method-args">(msgid, args={})</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Looks up and interprolate the hash values into a i18n string
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000309-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000309-source">
+
+
+
+ <div class="method-source-code"
+ id="t-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/util.rb, line 489</span>
489: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">t</span>(<span class="ruby-identifier">msgid</span>, <span class="ruby-identifier">args</span>={})
492: <span class="ruby-keyword kw">else</span>
493: <span class="ruby-constant">I18n</span>.<span class="ruby-identifier">t</span>(<span class="ruby-identifier">msgid</span>, <span class="ruby-identifier">args</span>)
494: <span class="ruby-keyword kw">end</span>
-495: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000310" class="method-detail">
- <a name="M000310"></a>
-
- <div class="method-heading">
- <a href="#M000310" class="method-signature">
- <span class="method-name">templatepath</span><span class="method-args">(template_file)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+495: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="templatepath-method" class="method-detail ">
+ <a name="M000331"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">templatepath</span><span
+ class="method-args">(template_file)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Looks up the template directory and returns its full path
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000310-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000310-source">
+
+
+
+ <div class="method-source-code"
+ id="templatepath-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/util.rb, line 498</span>
498: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">templatepath</span>(<span class="ruby-identifier">template_file</span>)
502:
503: <span class="ruby-identifier">template_path</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-value str">"/etc/mcollective"</span>, <span class="ruby-identifier">template_file</span>)
504: <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">template_path</span>
-505: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000304" class="method-detail">
- <a name="M000304"></a>
-
- <div class="method-heading">
- <a href="#M000304" class="method-signature">
- <span class="method-name">terminal_dimensions</span><span class="method-args">(stdout = STDOUT, environment = ENV)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+505: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="terminal-dimensions-method" class="method-detail ">
+ <a name="M000322"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">terminal_dimensions</span><span
+ class="method-args">(stdout = STDOUT, environment = ENV)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Figures out the columns and lines of the current tty
</p>
<p>
-Returns [0, 0] if it can‘<a href="Util.html#M000309">t</a> figure it
-out or if you‘re not running on a tty
+Returns [0, 0] if it can’t figure it out or if you’re not
+running on a tty
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000304-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000304-source">
+
+
+
+ <div class="method-source-code"
+ id="terminal-dimensions-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/util.rb, line 396</span>
396: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">terminal_dimensions</span>(<span class="ruby-identifier">stdout</span> = <span class="ruby-constant">STDOUT</span>, <span class="ruby-identifier">environment</span> = <span class="ruby-constant">ENV</span>)
411: <span class="ruby-keyword kw">end</span>
412: <span class="ruby-keyword kw">rescue</span>
413: [<span class="ruby-value">0</span>, <span class="ruby-value">0</span>]
-414: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000294" class="method-detail">
- <a name="M000294"></a>
-
- <div class="method-heading">
- <a href="#M000294" class="method-signature">
- <span class="method-name">unsubscribe</span><span class="method-args">(targets)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
-Helper to <a href="Util.html#M000294">unsubscribe</a> to a topic on
-multiple collectives or just one
+414: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="unsubscribe-method" class="method-detail ">
+ <a name="M000307"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">unsubscribe</span><span
+ class="method-args">(targets)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
+Helper to unsubscribe to a topic on multiple collectives or just one
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000294-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000294-source">
+
+
+
+ <div class="method-source-code"
+ id="unsubscribe-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/util.rb, line 213</span>
213: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">unsubscribe</span>(<span class="ruby-identifier">targets</span>)
218: <span class="ruby-identifier">targets</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">target</span><span class="ruby-operator">|</span>
219: <span class="ruby-identifier">connection</span>.<span class="ruby-identifier">unsubscribe</span>(<span class="ruby-identifier">target</span>[<span class="ruby-identifier">:agent</span>], <span class="ruby-identifier">target</span>[<span class="ruby-identifier">:type</span>], <span class="ruby-identifier">target</span>[<span class="ruby-identifier">:collective</span>])
220: <span class="ruby-keyword kw">end</span>
-221: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000306" class="method-detail">
- <a name="M000306"></a>
-
- <div class="method-heading">
- <a href="#M000306" class="method-signature">
- <span class="method-name">versioncmp</span><span class="method-args">(version_a, version_b)</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+221: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="versioncmp-method" class="method-detail ">
+ <a name="M000326"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">versioncmp</span><span
+ class="method-args">(version_a, version_b)</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
compare two software versions as commonly found in package versions.
</p>
<p>
-returns 0 if a == b returns -1 if a < b returns 1 if a > b
+returns 0 if a == b returns -1 if a < b returns 1 if a > b
</p>
<p>
Code originally from Puppet
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000306-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000306-source">
+
+
+
+ <div class="method-source-code"
+ id="versioncmp-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/util.rb, line 433</span>
433: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">versioncmp</span>(<span class="ruby-identifier">version_a</span>, <span class="ruby-identifier">version_b</span>)
457: <span class="ruby-keyword kw">end</span>
458:
459: <span class="ruby-identifier">version_a</span> <span class="ruby-operator"><=></span> <span class="ruby-identifier">version_b</span>;
-460: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000298" class="method-detail">
- <a name="M000298"></a>
-
- <div class="method-heading">
- <a href="#M000298" class="method-signature">
- <span class="method-name">windows?</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000298-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000298-source">
+460: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="windows--method" class="method-detail ">
+ <a name="M000312"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">windows?</span><span
+ class="method-args">()</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p class="missing-docs">(Not documented)</p>
+
+
+
+ <div class="method-source-code"
+ id="windows--source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/util.rb, line 264</span>
264: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">windows?</span>
265: <span class="ruby-operator">!</span><span class="ruby-operator">!</span>(<span class="ruby-constant">RbConfig</span><span class="ruby-operator">::</span><span class="ruby-constant">CONFIG</span>[<span class="ruby-value str">'host_os'</span>] <span class="ruby-operator">=~</span> <span class="ruby-regexp re">/mswin|win32|dos|mingw|cygwin/i</span>)
-266: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
-
- <div id="method-M000289" class="method-detail">
- <a name="M000289"></a>
-
- <div class="method-heading">
- <a href="#M000289" class="method-signature">
- <span class="method-name">windows_prefix</span><span class="method-args">()</span>
- </a>
- </div>
-
- <div class="method-description">
- <p>
+266: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+
+ </div>
+
+
+ <div id="windows-prefix-method" class="method-detail ">
+ <a name="M000302"></a>
+
+ <div class="method-heading">
+
+ <span class="method-name">windows_prefix</span><span
+ class="method-args">()</span>
+ <span class="method-click-advice">click to toggle source</span>
+
+ </div>
+
+ <div class="method-description">
+
+ <p>
Returns the PuppetLabs mcollective path for windows
</p>
- <p><a class="source-toggle" href="#"
- onclick="toggleCode('M000289-source');return false;">[Source]</a></p>
- <div class="method-source-code" id="M000289-source">
+
+
+
+ <div class="method-source-code"
+ id="windows-prefix-source">
<pre>
<span class="ruby-comment cmt"># File lib/mcollective/util.rb, line 141</span>
141: <span class="ruby-keyword kw">def</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">windows_prefix</span>
142: <span class="ruby-identifier">require</span> <span class="ruby-value str">'win32/dir'</span>
143: <span class="ruby-identifier">prefix</span> = <span class="ruby-constant">File</span>.<span class="ruby-identifier">join</span>(<span class="ruby-constant">Dir</span><span class="ruby-operator">::</span><span class="ruby-constant">COMMON_APPDATA</span>, <span class="ruby-value str">"PuppetLabs"</span>, <span class="ruby-value str">"mcollective"</span>)
-144: <span class="ruby-keyword kw">end</span>
-</pre>
- </div>
- </div>
- </div>
+144: <span class="ruby-keyword kw">end</span></pre>
+ </div>
+
+ </div>
+
+ </div>
- </div>
+
+ </div>
+
+ </div>
- </div>
+ <div id="rdoc-debugging-section-dump" class="debugging-section">
+
+ <p>Disabled; run with --debug to generate this.</p>
+
+ </div>
-<div id="validator-badges">
- <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
-</div>
+ <div id="validator-badges">
+ <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+ <p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
+ Rdoc Generator</a> 1.1.6</small>.</p>
+ </div>
</body>
-</html>
\ No newline at end of file
+</html>
+
Code Review / packages / precise / mcollective.git / blobdiff