doc/rdocs/Rcmd.html in rcmd-1.5.7 vs doc/rdocs/Rcmd.html in rcmd-1.5.8
- old
+ new
@@ -1,147 +1,122 @@
<!DOCTYPE html>
<html>
<head>
-<meta content="text/html; charset=UTF-8" http-equiv="Content-Type">
+<meta charset="UTF-8">
<title>module Rcmd - RDoc Documentation</title>
-<link type="text/css" media="screen" href="./rdoc.css" rel="stylesheet">
-
<script type="text/javascript">
var rdoc_rel_prefix = "./";
+ var index_rel_prefix = "./";
</script>
-<script type="text/javascript" charset="utf-8" src="./js/jquery.js"></script>
-<script type="text/javascript" charset="utf-8" src="./js/navigation.js"></script>
-<script type="text/javascript" charset="utf-8" src="./js/search_index.js"></script>
-<script type="text/javascript" charset="utf-8" src="./js/search.js"></script>
-<script type="text/javascript" charset="utf-8" src="./js/searcher.js"></script>
-<script type="text/javascript" charset="utf-8" src="./js/darkfish.js"></script>
+<script src="./js/jquery.js"></script>
+<script src="./js/darkfish.js"></script>
+<link href="./css/fonts.css" rel="stylesheet">
+<link href="./css/rdoc.css" rel="stylesheet">
-<body id="top" class="module">
-<nav id="metadata">
- <nav id="home-section" class="section">
- <h3 class="section-header">
- <a href="./index.html">Home</a>
+
+
+<body id="top" role="document" class="module">
+<nav role="navigation">
+ <div id="project-navigation">
+ <div id="home-section" role="region" title="Quick navigation" class="nav-section">
+ <h2>
+ <a href="./index.html" rel="home">Home</a>
+ </h2>
+
+ <div id="table-of-contents-navigation">
+ <a href="./table_of_contents.html#pages">Pages</a>
<a href="./table_of_contents.html#classes">Classes</a>
<a href="./table_of_contents.html#methods">Methods</a>
- </h3>
-</nav>
+ </div>
+</div>
-
- <nav id="search-section" class="section project-section" class="initially-hidden">
+ <div id="search-section" role="search" class="project-section initially-hidden">
<form action="#" method="get" accept-charset="utf-8">
- <h3 class="section-header">
- <input type="text" name="search" placeholder="Search" id="search-field"
+ <div id="search-field-wrapper">
+ <input id="search-field" role="combobox" aria-label="Search"
+ aria-autocomplete="list" aria-controls="search-results"
+ type="text" name="search" placeholder="Search" spellcheck="false"
title="Type to search, Up and Down to navigate, Enter to load">
- </h3>
+ </div>
+
+ <ul id="search-results" aria-label="Search Results"
+ aria-busy="false" aria-expanded="false"
+ aria-atomic="false" class="initially-hidden"></ul>
</form>
+</div>
- <ul id="search-results" class="initially-hidden"></ul>
-</nav>
+ </div>
-
- <div id="file-metadata">
- <nav id="file-list-section" class="section">
- <h3 class="section-header">Defined In</h3>
- <ul>
- <li>lib/rcmd.rb
- <li>lib/rcmd/version.rb
- </ul>
-</nav>
-
-
- </div>
-
<div id="class-metadata">
<!-- Method Quickref -->
-<nav id="method-list-section" class="section">
- <h3 class="section-header">Methods</h3>
+<div id="method-list-section" class="nav-section">
+ <h3>Methods</h3>
- <ul class="link-list">
+ <ul class="link-list" role="directory">
<li ><a href="#method-c-run_command">::run_command</a>
</ul>
-</nav>
+</div>
</div>
-
- <div id="project-metadata">
- <nav id="fileindex-section" class="section project-section">
- <h3 class="section-header">Pages</h3>
-
- <ul>
-
- <li class="file"><a href="./README_md.html">README</a>
-
- </ul>
</nav>
- <nav id="classindex-section" class="section project-section">
- <h3 class="section-header">Class and Module Index</h3>
+<main role="main" aria-labelledby="module-Rcmd">
+ <h1 id="module-Rcmd" class="module">
+ module Rcmd
+ </h1>
- <ul class="link-list">
-
- <li><a href="./OptionParser.html">OptionParser</a>
-
- <li><a href="./Rcmd.html">Rcmd</a>
-
- </ul>
-</nav>
-
- </div>
-</nav>
-
-<div id="documentation">
- <h1 class="module">module Rcmd</h1>
-
- <div id="description" class="description">
+ <section class="description">
<p>This module is for parellel remote (SSH) execution of a single command
string on Multiple hosts. The module itself consists of one method for
execution (Rcmd.run_command) which does not accept any arguments. The
required arguments are set as variables through the use of accessors.</p>
- </div><!-- description -->
+ </section>
<section id="5Buntitled-5D" class="documentation-section">
- <!-- Constants -->
- <section id="constants-list" class="section">
- <h3 class="section-header">Constants</h3>
+ <section class="constants-list">
+ <header>
+ <h3>Constants</h3>
+ </header>
<dl>
<dt id="VERSION">VERSION
- <dd class="description"><p><code>VERSION</code> - Version number string</p>
+ <dd><p><code>VERSION</code> - Version number string</p>
</dl>
</section>
- <!-- Attributes -->
- <section id="attribute-method-details" class="method-section section">
- <h3 class="section-header">Attributes</h3>
+ <section class="attribute-method-details" class="method-section">
+ <header>
+ <h3>Attributes</h3>
+ </header>
<div id="attribute-c-command" class="method-detail">
<div class="method-heading attribute-method-heading">
<span class="method-name">command</span><span
@@ -232,17 +207,18 @@
<p>What user should we connect as. (Manditory)</p>
</div>
</div>
- </section><!-- attribute-method-details -->
+ </section>
- <!-- Methods -->
- <section id="public-class-5Buntitled-5D-method-details" class="method-section section">
- <h3 class="section-header">Public Class Methods</h3>
+ <section id="public-class-5Buntitled-5D-method-details" class="method-section">
+ <header>
+ <h3>Public Class Methods</h3>
+ </header>
<div id="method-c-run_command" class="method-detail ">
<div class="method-heading">
@@ -264,32 +240,32 @@
creating the threads, the method first checks if the preferred number of
threads is greater then the number of hosts remaining in the host list. If
false (threads > num hosts) then the number of remaining hosts becomes
the thread count. This prevents spawning of unneeded threads.</p>
-<h4 id="method-c-run_command-label-Manditory+values+to+be+set">Manditory values to be set<span><a href="#method-c-run_command-label-Manditory+values+to+be+set">¶</a> <a href="#documentation">↑</a></span></h4>
+<h4 id="method-c-run_command-label-Manditory+values+to+be+set">Manditory values to be set<span><a href="#method-c-run_command-label-Manditory+values+to+be+set">¶</a> <a href="#top">↑</a></span></h4>
<ul><li>
<p><code>:user</code> - User to run the command as</p>
</li><li>
<p><code>:command</code> - Command to be executed</p>
</li><li>
<p><code>:host_list</code> - Array containing the hosts for command execution.</p>
</li><li>
<p><code>:nthreads</code> - Preferred max number of threads</p>
</li></ul>
-<h4 id="method-c-run_command-label-Optional+Values">Optional Values<span><a href="#method-c-run_command-label-Optional+Values">¶</a> <a href="#documentation">↑</a></span></h4>
+<h4 id="method-c-run_command-label-Optional+Values">Optional Values<span><a href="#method-c-run_command-label-Optional+Values">¶</a> <a href="#top">↑</a></span></h4>
<ul><li>
<p><code>:quiet</code> - Do not print to STDOUT. STDERR is always printed</p>
</li></ul>
-<h4 id="method-c-run_command-label-Specifically+for+the+method+only">Specifically for the method only<span><a href="#method-c-run_command-label-Specifically+for+the+method+only">¶</a> <a href="#documentation">↑</a></span></h4>
+<h4 id="method-c-run_command-label-Specifically+for+the+method+only">Specifically for the method only<span><a href="#method-c-run_command-label-Specifically+for+the+method+only">¶</a> <a href="#top">↑</a></span></h4>
<ul><li>
<p><code>:threads</code> - Array of the current threads</p>
</li></ul>
-<h4 id="method-c-run_command-label-Example">Example<span><a href="#method-c-run_command-label-Example">¶</a> <a href="#documentation">↑</a></span></h4>
+<h4 id="method-c-run_command-label-Example">Example<span><a href="#method-c-run_command-label-Example">¶</a> <a href="#top">↑</a></span></h4>
<pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">'rcmd'</span>
<span class="ruby-constant">Rcmd</span>.<span class="ruby-identifier">host_list</span>= [<span class="ruby-string">"host1"</span>, <span class="ruby-string">"host2"</span>, <span class="ruby-string">"host3"</span>, <span class="ruby-string">"host4"</span>, <span class="ruby-string">"host 5"</span>, <span class="ruby-string">"host6"</span>]
<span class="ruby-constant">Rcmd</span>.<span class="ruby-identifier">user</span>= <span class="ruby-string">'root'</span>
<span class="ruby-constant">Rcmd</span>.<span class="ruby-identifier">command</span>= <span class="ruby-string">'rpm -qa kernel\*'</span>
@@ -349,28 +325,27 @@
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">unless</span> <span class="ruby-ivar">@threads</span>.<span class="ruby-identifier">each</span>.<span class="ruby-identifier">map</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">t</span><span class="ruby-operator">|</span> <span class="ruby-identifier">t</span>.<span class="ruby-identifier">alive?</span>}.<span class="ruby-identifier">none?</span>
<span class="ruby-identifier">sleep</span> <span class="ruby-value">1</span>
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
- </div><!-- run_command-source -->
+ </div>
</div>
- </div><!-- run_command-method -->
+ </div>
- </section><!-- public-class-method-details -->
+ </section>
- </section><!-- 5Buntitled-5D -->
+ </section>
+</main>
-</div><!-- documentation -->
-
-<footer id="validator-badges">
- <p><a href="http://validator.w3.org/check/referer">[Validate]</a>
- <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 4.0.0.
- <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3.
+<footer id="validator-badges" role="contentinfo">
+ <p><a href="http://validator.w3.org/check/referer">Validate</a>
+ <p>Generated by <a href="https://rdoc.github.io/rdoc">RDoc</a> 5.0.0.
+ <p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>