doc/README.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
   5 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
   6 <head>
   7         <meta content="text/html; charset=utf-8" http-equiv="Content-Type" />
   8
   9         <title>File: README [mcollective version 2.3.3]</title>
  10
  11         <link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet" />
  12
  13         <script src="./js/jquery.js" type="text/javascript"
  14                 charset="utf-8"></script>
  15         <script src="./js/thickbox-compressed.js" type="text/javascript"
  16                 charset="utf-8"></script>
  17         <script src="./js/quicksearch.js" type="text/javascript"
  18                 charset="utf-8"></script>
  19         <script src="./js/darkfish.js" type="text/javascript"
  20                 charset="utf-8"></script>
  21 </head>
  22
  23 <body class="file">
  24         <div id="metadata">
  25                 <div id="project-metadata">
  26
  27
  28                         <div id="fileindex-section" class="section project-section">
  29                                 <h3 class="section-header">Files</h3>
  30                                 <ul>
  31
  32                                         <li class="file"><a href="./COPYING.html">COPYING</a></li>
  33
  34                                         <li class="file"><a href="./Gemfile.html">Gemfile</a></li>
  35
  36                                         <li class="file"><a href="./README.html">README</a></li>
  37
  38                                         <li class="file"><a href="./Rakefile.html">Rakefile</a></li>
  39
  40                                         <li class="file"><a href="./etc/client_cfg_dist.html">client.cfg.dist</a></li>
  41
  42                                         <li class="file"><a href="./etc/data-help_erb.html">data-help.erb</a></li>
  43
  44                                         <li class="file"><a href="./etc/discovery-help_erb.html">discovery-help.erb</a></li>
  45
  46                                         <li class="file"><a href="./etc/facts_yaml_dist.html">facts.yaml.dist</a></li>
  47
  48                                         <li class="file"><a href="./etc/metadata-help_erb.html">metadata-help.erb</a></li>
  49
  50                                         <li class="file"><a href="./etc/msg-help_erb.html">msg-help.erb</a></li>
  51
  52                                         <li class="file"><a href="./etc/rpc-help_erb.html">rpc-help.erb</a></li>
  53
  54                                         <li class="file"><a href="./etc/server_cfg_dist.html">server.cfg.dist</a></li>
  55
  56                                         <li class="file"><a href="./etc/ssl/PLACEHOLDER.html">PLACEHOLDER</a></li>
  57
  58                                         <li class="file"><a href="./etc/ssl/clients/PLACEHOLDER.html">PLACEHOLDER</a></li>
  59
  60                                         <li class="file"><a href="./lib/mcollective/generators/templates/action_snippet_erb.html">action_snippet.erb</a></li>
  61
  62                                         <li class="file"><a href="./lib/mcollective/generators/templates/data_input_snippet_erb.html">data_input_snippet.erb</a></li>
  63
  64                                         <li class="file"><a href="./lib/mcollective/generators/templates/ddl_erb.html">ddl.erb</a></li>
  65
  66                                         <li class="file"><a href="./lib/mcollective/generators/templates/plugin_erb.html">plugin.erb</a></li>
  67
  68                                         <li class="file"><a href="./lib/mcollective/locales/en_yml.html">en.yml</a></li>
  69
  70                                         <li class="file"><a href="./mcollective_init.html">mcollective.init</a></li>
  71
  72                                 </ul>
  73                         </div>
  74
  75
  76                         <div id="classindex-section" class="section project-section">
  77                                 <h3 class="section-header">Class Index
  78                                         <span class="search-toggle"><img src="./images/find.png"
  79                                                 height="16" width="16" alt="[+]"
  80                                                 title="show/hide quicksearch" /></span></h3>
  81                                 <form action="#" method="get" accept-charset="utf-8" class="initially-hidden">
  82                                 <fieldset>
  83                                         <legend>Quicksearch</legend>
  84                                         <input type="text" name="quicksearch" value=""
  85                                                 class="quicksearch-field" />
  86                                 </fieldset>
  87                                 </form>
  88
  89                                 <ul class="link-list">
  90
  91                                         <li><a href="./MCollective.html">MCollective</a></li>
  92
  93                                         <li><a href="./MCollective/Agent.html">MCollective::Agent</a></li>
  94
  95                                         <li><a href="./MCollective/Agents.html">MCollective::Agents</a></li>
  96
  97                                         <li><a href="./MCollective/Aggregate.html">MCollective::Aggregate</a></li>
  98
  99                                         <li><a href="./MCollective/Aggregate/Base.html">MCollective::Aggregate::Base</a></li>
 100
 101                                         <li><a href="./MCollective/Aggregate/Result.html">MCollective::Aggregate::Result</a></li>
 102
 103                                         <li><a href="./MCollective/Aggregate/Result/Base.html">MCollective::Aggregate::Result::Base</a></li>
 104
 105                                         <li><a href="./MCollective/Aggregate/Result/CollectionResult.html">MCollective::Aggregate::Result::CollectionResult</a></li>
 106
 107                                         <li><a href="./MCollective/Aggregate/Result/NumericResult.html">MCollective::Aggregate::Result::NumericResult</a></li>
 108
 109                                         <li><a href="./MCollective/Application.html">MCollective::Application</a></li>
 110
 111                                         <li><a href="./MCollective/Applications.html">MCollective::Applications</a></li>
 112
 113                                         <li><a href="./MCollective/Cache.html">MCollective::Cache</a></li>
 114
 115                                         <li><a href="./MCollective/Client.html">MCollective::Client</a></li>
 116
 117                                         <li><a href="./MCollective/CodedError.html">MCollective::CodedError</a></li>
 118
 119                                         <li><a href="./MCollective/Config.html">MCollective::Config</a></li>
 120
 121                                         <li><a href="./MCollective/Connector.html">MCollective::Connector</a></li>
 122
 123                                         <li><a href="./MCollective/Connector/Base.html">MCollective::Connector::Base</a></li>
 124
 125                                         <li><a href="./MCollective/DDL.html">MCollective::DDL</a></li>
 126
 127                                         <li><a href="./MCollective/DDL/AgentDDL.html">MCollective::DDL::AgentDDL</a></li>
 128
 129                                         <li><a href="./MCollective/DDL/Base.html">MCollective::DDL::Base</a></li>
 130
 131                                         <li><a href="./MCollective/DDL/DataDDL.html">MCollective::DDL::DataDDL</a></li>
 132
 133                                         <li><a href="./MCollective/DDL/DiscoveryDDL.html">MCollective::DDL::DiscoveryDDL</a></li>
 134
 135                                         <li><a href="./MCollective/DDL/ValidatorDDL.html">MCollective::DDL::ValidatorDDL</a></li>
 136
 137                                         <li><a href="./MCollective/DDLValidationError.html">MCollective::DDLValidationError</a></li>
 138
 139                                         <li><a href="./MCollective/Data.html">MCollective::Data</a></li>
 140
 141                                         <li><a href="./MCollective/Data/Base.html">MCollective::Data::Base</a></li>
 142
 143                                         <li><a href="./MCollective/Data/Result.html">MCollective::Data::Result</a></li>
 144
 145                                         <li><a href="./MCollective/Discovery.html">MCollective::Discovery</a></li>
 146
 147                                         <li><a href="./MCollective/Facts.html">MCollective::Facts</a></li>
 148
 149                                         <li><a href="./MCollective/Facts/Base.html">MCollective::Facts::Base</a></li>
 150
 151                                         <li><a href="./MCollective/Generators.html">MCollective::Generators</a></li>
 152
 153                                         <li><a href="./MCollective/Generators/AgentGenerator.html">MCollective::Generators::AgentGenerator</a></li>
 154
 155                                         <li><a href="./MCollective/Generators/Base.html">MCollective::Generators::Base</a></li>
 156
 157                                         <li><a href="./MCollective/Generators/DataGenerator.html">MCollective::Generators::DataGenerator</a></li>
 158
 159                                         <li><a href="./MCollective/InvalidRPCData.html">MCollective::InvalidRPCData</a></li>
 160
 161                                         <li><a href="./MCollective/Log.html">MCollective::Log</a></li>
 162
 163                                         <li><a href="./MCollective/Logger.html">MCollective::Logger</a></li>
 164
 165                                         <li><a href="./MCollective/Logger/Base.html">MCollective::Logger::Base</a></li>
 166
 167                                         <li><a href="./MCollective/Logger/Console_logger.html">MCollective::Logger::Console_logger</a></li>
 168
 169                                         <li><a href="./MCollective/Logger/File_logger.html">MCollective::Logger::File_logger</a></li>
 170
 171                                         <li><a href="./MCollective/Logger/Syslog_logger.html">MCollective::Logger::Syslog_logger</a></li>
 172
 173                                         <li><a href="./MCollective/Matcher.html">MCollective::Matcher</a></li>
 174
 175                                         <li><a href="./MCollective/Matcher/Parser.html">MCollective::Matcher::Parser</a></li>
 176
 177                                         <li><a href="./MCollective/Matcher/Scanner.html">MCollective::Matcher::Scanner</a></li>
 178
 179                                         <li><a href="./MCollective/Message.html">MCollective::Message</a></li>
 180
 181                                         <li><a href="./MCollective/MissingRPCData.html">MCollective::MissingRPCData</a></li>
 182
 183                                         <li><a href="./MCollective/MsgDoesNotMatchRequestID.html">MCollective::MsgDoesNotMatchRequestID</a></li>
 184
 185                                         <li><a href="./MCollective/MsgTTLExpired.html">MCollective::MsgTTLExpired</a></li>
 186
 187                                         <li><a href="./MCollective/NotTargettedAtUs.html">MCollective::NotTargettedAtUs</a></li>
 188
 189                                         <li><a href="./MCollective/Optionparser.html">MCollective::Optionparser</a></li>
 190
 191                                         <li><a href="./MCollective/PluginManager.html">MCollective::PluginManager</a></li>
 192
 193                                         <li><a href="./MCollective/PluginPackager.html">MCollective::PluginPackager</a></li>
 194
 195                                         <li><a href="./MCollective/PluginPackager/AgentDefinition.html">MCollective::PluginPackager::AgentDefinition</a></li>
 196
 197                                         <li><a href="./MCollective/PluginPackager/StandardDefinition.html">MCollective::PluginPackager::StandardDefinition</a></li>
 198
 199                                         <li><a href="./MCollective/RPC.html">MCollective::RPC</a></li>
 200
 201                                         <li><a href="./MCollective/RPC/ActionRunner.html">MCollective::RPC::ActionRunner</a></li>
 202
 203                                         <li><a href="./MCollective/RPC/Agent.html">MCollective::RPC::Agent</a></li>
 204
 205                                         <li><a href="./MCollective/RPC/Audit.html">MCollective::RPC::Audit</a></li>
 206
 207                                         <li><a href="./MCollective/RPC/Client.html">MCollective::RPC::Client</a></li>
 208
 209                                         <li><a href="./MCollective/RPC/Helpers.html">MCollective::RPC::Helpers</a></li>
 210
 211                                         <li><a href="./MCollective/RPC/Progress.html">MCollective::RPC::Progress</a></li>
 212
 213                                         <li><a href="./MCollective/RPC/Reply.html">MCollective::RPC::Reply</a></li>
 214
 215                                         <li><a href="./MCollective/RPC/Request.html">MCollective::RPC::Request</a></li>
 216
 217                                         <li><a href="./MCollective/RPC/Result.html">MCollective::RPC::Result</a></li>
 218
 219                                         <li><a href="./MCollective/RPC/Stats.html">MCollective::RPC::Stats</a></li>
 220
 221                                         <li><a href="./MCollective/RPCAborted.html">MCollective::RPCAborted</a></li>
 222
 223                                         <li><a href="./MCollective/RPCError.html">MCollective::RPCError</a></li>
 224
 225                                         <li><a href="./MCollective/Registration.html">MCollective::Registration</a></li>
 226
 227                                         <li><a href="./MCollective/Registration/Base.html">MCollective::Registration::Base</a></li>
 228
 229                                         <li><a href="./MCollective/Runner.html">MCollective::Runner</a></li>
 230
 231                                         <li><a href="./MCollective/RunnerStats.html">MCollective::RunnerStats</a></li>
 232
 233                                         <li><a href="./MCollective/SSL.html">MCollective::SSL</a></li>
 234
 235                                         <li><a href="./MCollective/Security.html">MCollective::Security</a></li>
 236
 237                                         <li><a href="./MCollective/Security/Base.html">MCollective::Security::Base</a></li>
 238
 239                                         <li><a href="./MCollective/SecurityValidationFailed.html">MCollective::SecurityValidationFailed</a></li>
 240
 241                                         <li><a href="./MCollective/Shell.html">MCollective::Shell</a></li>
 242
 243                                         <li><a href="./MCollective/Translatable.html">MCollective::Translatable</a></li>
 244
 245                                         <li><a href="./MCollective/UnixDaemon.html">MCollective::UnixDaemon</a></li>
 246
 247                                         <li><a href="./MCollective/UnknownRPCAction.html">MCollective::UnknownRPCAction</a></li>
 248
 249                                         <li><a href="./MCollective/UnknownRPCError.html">MCollective::UnknownRPCError</a></li>
 250
 251                                         <li><a href="./MCollective/Util.html">MCollective::Util</a></li>
 252
 253                                         <li><a href="./MCollective/Validator.html">MCollective::Validator</a></li>
 254
 255                                         <li><a href="./MCollective/ValidatorError.html">MCollective::ValidatorError</a></li>
 256
 257                                         <li><a href="./MCollective/WindowsDaemon.html">MCollective::WindowsDaemon</a></li>
 258
 259                                         <li><a href="./Array.html">Array</a></li>
 260
 261                                         <li><a href="./Dir.html">Dir</a></li>
 262
 263                                         <li><a href="./Object.html">Object</a></li>
 264
 265                                         <li><a href="./String.html">String</a></li>
 266
 267                                         <li><a href="./Symbol.html">Symbol</a></li>
 268
 269                                 </ul>
 270                                 <div id="no-class-search-results" style="display: none;">No matching classes.</div>
 271                         </div>
 272
 273
 274                 </div>
 275         </div>
 276
 277         <div id="documentation">
 278                 <p>
 279 The Marionette Collective
 280 </p>
 281 <h6>===================</h6>
 282 <p>
 283 The Marionette Collective aka. mcollective is a framework to build server
 284 orchestration or parallel job execution systems.
 285 </p>
 286 <p>
 287 For full information, wikis, ticketing and downloads please see <a
 288 href="http://marionette-collective.org/">marionette-collective.org/</a>
 289 </p>
 290
 291         </div>
 292
 293         <div id="validator-badges">
 294                 <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
 295                 <p><small>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish
 296                         Rdoc Generator</a> 1.1.6</small>.</p>
 297         </div>
 298 </body>
 299 </html>
 300