doc/rdocs/README_md.html in rcmd-1.5.7 vs doc/rdocs/README_md.html in rcmd-1.5.8
- old
+ new
@@ -1,107 +1,100 @@
<!DOCTYPE html>
<html>
<head>
-<meta content="text/html; charset=UTF-8" http-equiv="Content-Type">
+<meta charset="UTF-8">
<title>README - 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 class="file">
-<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="file">
+<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="table-of-contents">
- <nav class="section">
- <h3 class="section-header">Table of Contents</h3>
- <ul>
- <li><a href="#label-Description">Description</a>
- <li><a href="#label-Features">Features</a>
- <li><a href="#label-Installation">Installation</a>
- <li><a href="#label-Usage+Examples">Usage Examples</a>
- <li><a href="#label-Help+Screen">Help Screen</a>
- <li><a href="#label-Specifying+nodes+manually">Specifying nodes manually</a>
- <li><a href="#label-Piping+list+of+nodes">Piping list of nodes</a>
- <li><a href="#label-Using+a+database+for+obtaining+nodes">Using a database for obtaining nodes</a>
- <li><a href="#label-Development">Development</a>
- </ul>
- </nav>
+<div class="nav-section">
+ <h3>Table of Contents</h3>
+
+ <ul class="link-list" role="directory">
+ <li><a href="#label-Description">Description</a>
+ <li><a href="#label-Features">Features</a>
+ <li><a href="#label-Installation">Installation</a>
+ <li><a href="#label-Usage+Examples">Usage Examples</a>
+ <li><a href="#label-Help+Screen">Help Screen</a>
+ <li><a href="#label-Specifying+nodes+manually">Specifying nodes manually</a>
+ <li><a href="#label-Piping+list+of+nodes">Piping list of nodes</a>
+ <li><a href="#label-Using+regex+to+build+node+list">Using regex to build node list</a>
+ <li><a href="#label-Development">Development</a>
+ </ul>
</div>
<div id="project-metadata">
- <nav id="fileindex-section" class="section project-section">
- <h3 class="section-header">Pages</h3>
+ <div id="fileindex-section" class="nav-section">
+ <h3>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>
-
<ul class="link-list">
- <li><a href="./OptionParser.html">OptionParser</a>
+ <li><a href="./README_md.html">README</a>
- <li><a href="./Rcmd.html">Rcmd</a>
-
</ul>
-</nav>
+</div>
</div>
</nav>
-<div id="documentation" class="description">
-
-<h1 id="label-Description">Description<span><a href="#label-Description">¶</a> <a href="#documentation">↑</a></span></h1>
+<main role="main" aria-label="Page README.md">
+<h1 id="label-Description">Description<span><a href="#label-Description">¶</a> <a href="#top">↑</a></span></h1>
+
<p>rcmd (remote command) is a command line utility written in Ruby for
-executing the same command on
-multiple systems through ssh. This is done by
-assigning a host to a
-thread and creating the ssh sessions in those
+executing the same command on multiple systems through ssh. This is done by
+assigning a host to a thread and creating the ssh sessions in those
threads.</p>
-<h2 id="label-Features">Features<span><a href="#label-Features">¶</a> <a href="#documentation">↑</a></span></h2>
+<h2 id="label-Features">Features<span><a href="#label-Features">¶</a> <a href="#top">↑</a></span></h2>
<ul><li>
<p>Command line switch for setting number of threads to be used at a time.
(Default is 4)</p>
</li><li>
<p>A comma seperated list of hosts piped from another command can be used as
@@ -113,100 +106,95 @@
<p>Output shows which host the output is from</p>
</li><li>
<p>Stdout can be suppressed, only allowing for stderr to be shown</p>
</li></ul>
-<h2 id="label-Installation">Installation<span><a href="#label-Installation">¶</a> <a href="#documentation">↑</a></span></h2>
+<h2 id="label-Installation">Installation<span><a href="#label-Installation">¶</a> <a href="#top">↑</a></span></h2>
<p>rcmd is available as a gem and kan be installed with <code>gem install
rcmd</code></p>
-<h1 id="label-Usage+Examples">Usage Examples<span><a href="#label-Usage+Examples">¶</a> <a href="#documentation">↑</a></span></h1>
+<h1 id="label-Usage+Examples">Usage Examples<span><a href="#label-Usage+Examples">¶</a> <a href="#top">↑</a></span></h1>
-<h2 id="label-Help+Screen">Help Screen<span><a href="#label-Help+Screen">¶</a> <a href="#documentation">↑</a></span></h2>
+<h2 id="label-Help+Screen">Help Screen<span><a href="#label-Help+Screen">¶</a> <a href="#top">↑</a></span></h2>
-<pre>daibhidh@darkstar:~/$ rcmd --help
-Usage: rcmd [options]
+<pre>Usage: rcmd [options]
-u, --username username Username for SSH connections
-n, --nodes x,y,z Comma seperated list of nodes. use '-' for a space seperated list piped from another command
+ -r, --regexp regex Use Regex to build host list (ruby regexp)
-t, --threads threads Number of threads to run
-c, --command <command> Quoted string containing the command to be run
-q, --quiet Suppress stdout of commands. stderr will still be displayed
- -v, --version Print what version of the command is in use</pre>
+ -v, --version Print what version of the command is in use
+ -D, --debug Print debug information</pre>
-<h2 id="label-Specifying+nodes+manually">Specifying nodes manually<span><a href="#label-Specifying+nodes+manually">¶</a> <a href="#documentation">↑</a></span></h2>
+<h2 id="label-Specifying+nodes+manually">Specifying nodes manually<span><a href="#label-Specifying+nodes+manually">¶</a> <a href="#top">↑</a></span></h2>
<p>Specifying a comma seperated list of hosts and timing the total execution
-time.
-```bash
-daibhidh@darkstar:~/$ time rcmd -n node1,node2,node3,node4 -c
-'cat /etc/redhat-release'
-node2 :: Red Hat Enterprise Linux
-ComputeNode release 6.8 (Santiago)
-node1 :: Red Hat Enterprise Linux
-ComputeNode release 6.8 (Santiago)
-node4 :: Red Hat Enterprise Linux
-ComputeNode release 6.9 (Santiago)
-node3 :: Red Hat Enterprise Linux
+time. “`bash daibhidh@darkstar:~/$ time rcmd -n node1,node2,node3,node4 -c
+'cat /etc/redhat-release' node2 :: Red Hat Enterprise Linux
+ComputeNode release 6.8 (Santiago) node1 :: Red Hat Enterprise Linux
+ComputeNode release 6.8 (Santiago) node4 :: Red Hat Enterprise Linux
+ComputeNode release 6.9 (Santiago) node3 :: Red Hat Enterprise Linux
ComputeNode release 6.9 (Santiago)</p>
-<p>real 0m2.749s
-user 0m0.272s
-sys 0m0.050s
-```</p>
+<p>real 0m2.749s user 0m0.272s sys 0m0.050s “`</p>
-<h2 id="label-Piping+list+of+nodes">Piping list of nodes<span><a href="#label-Piping+list+of+nodes">¶</a> <a href="#documentation">↑</a></span></h2>
+<h2 id="label-Piping+list+of+nodes">Piping list of nodes<span><a href="#label-Piping+list+of+nodes">¶</a> <a href="#top">↑</a></span></h2>
<p>Using the hammer cli to get a list of hosts from a RedHat Satellite and
-providing it to rcmd as the node
-list.
-<code>bash
-daibhidh@darkstar:~/$ hammer --output base host list
---organization org | awk '/Name:/ {print $2}' | rcmd -n - -c
-'cat /etc/redhat-release'
-node1.example.com :: Red Hat Enterprise
-Linux ComputeNode release 6.8 (Santiago)
-node3.example.com :: Red Hat
-Enterprise Linux ComputeNode release 6.9 (Santiago)
-node2.example.com ::
-Red Hat Enterprise Linux ComputeNode release 6.8
-(Santiago)
-node4.example.com :: Red Hat Enterprise Linux ComputeNode
-release 6.9 (Santiago)
-</code></p>
+providing it to rcmd as the node list. <code>bash daibhidh@darkstar:~/$
+hammer --output base host list --organization org | awk '/Name:/ {print
+$2}' | rcmd -n - -c 'cat /etc/redhat-release' node1.example.com
+:: Red Hat Enterprise Linux ComputeNode release 6.8 (Santiago)
+node3.example.com :: Red Hat Enterprise Linux ComputeNode release 6.9
+(Santiago) node2.example.com :: Red Hat Enterprise Linux ComputeNode
+release 6.8 (Santiago) node4.example.com :: Red Hat Enterprise Linux
+ComputeNode release 6.9 (Santiago) </code></p>
-<h2 id="label-Using+a+database+for+obtaining+nodes">Using a database for obtaining nodes<span><a href="#label-Using+a+database+for+obtaining+nodes">¶</a> <a href="#documentation">↑</a></span></h2>
+<h2 id="label-Using+regex+to+build+node+list">Using regex to build node list<span><a href="#label-Using+regex+to+build+node+list">¶</a> <a href="#top">↑</a></span></h2>
-<p>TODO</p>
+<pre>daibhidh@darkstar:~/$ rcmd -r 'node([1-9]|1[1-2])$' -c 'hostname -f'
+node2 :: node2.example.com
+node1 :: node1.example.com
+node4 :: node4.example.com
+node3 :: node3.example.com
+node5 :: node5.example.com
+node6 :: node6.example.com
+node8 :: node8.example.com
+node7 :: node7.example.com
+node11 :: CONNECT ERROR :: Unable to connect to host!
+node9 :: node9.example.com
+node12 :: node12.example.com</pre>
-<h1 id="label-Development">Development<span><a href="#label-Development">¶</a> <a href="#documentation">↑</a></span></h1>
+<h1 id="label-Development">Development<span><a href="#label-Development">¶</a> <a href="#top">↑</a></span></h1>
<p>If you are wanting to modify the code by all means do so. If you clone this
repository you can then run <code>bundle install</code> to install the
dependencies needed. Tests are performed with <em>rspec</em> and can be run
with <em>rake</em>.</p>
<p>Available Rake tasks are:</p>
-<pre>rake build # Build rcmd-1.5.5.gem into the pkg directory
-rake clean # Remove any temporary products
-rake clobber # Remove any generated files
-rake clobber_rdoc # Remove RDoc HTML files
-rake console # Open an IRB console with this gem loaded
-rake install # Build and install rcmd-1.5.5.gem into system gems
-rake install:local # Build and install rcmd-1.5.5.gem into system gems without network access
-rake rdoc # Build RDoc HTML files
-rake reinstall # Remove, build, and install gem
-rake release[remote] # Create tag v1.5.5 and build and push rcmd-1.5.5.gem to Rubygems
-rake rerdoc # Rebuild RDoc HTML files
-rake spec # Run RSpec code examples</pre>
+<pre class="ruby"><span class="ruby-identifier">rake</span> <span class="ruby-identifier">build</span> <span class="ruby-comment"># Build rcmd-1.5.5.gem into the pkg directory</span>
+<span class="ruby-identifier">rake</span> <span class="ruby-identifier">clean</span> <span class="ruby-comment"># Remove any temporary products</span>
+<span class="ruby-identifier">rake</span> <span class="ruby-identifier">clobber</span> <span class="ruby-comment"># Remove any generated files</span>
+<span class="ruby-identifier">rake</span> <span class="ruby-identifier">clobber_rdoc</span> <span class="ruby-comment"># Remove RDoc HTML files</span>
+<span class="ruby-identifier">rake</span> <span class="ruby-identifier">console</span> <span class="ruby-comment"># Open an IRB console with this gem loaded</span>
+<span class="ruby-identifier">rake</span> <span class="ruby-identifier">install</span> <span class="ruby-comment"># Build and install rcmd-1.5.5.gem into system gems</span>
+<span class="ruby-identifier">rake</span> <span class="ruby-identifier">install</span>:<span class="ruby-identifier">local</span> <span class="ruby-comment"># Build and install rcmd-1.5.5.gem into system gems without network access</span>
+<span class="ruby-identifier">rake</span> <span class="ruby-identifier">rdoc</span> <span class="ruby-comment"># Build RDoc HTML files</span>
+<span class="ruby-identifier">rake</span> <span class="ruby-identifier">reinstall</span> <span class="ruby-comment"># Remove, build, and install gem</span>
+<span class="ruby-identifier">rake</span> <span class="ruby-identifier">release</span>[<span class="ruby-identifier">remote</span>] <span class="ruby-comment"># Create tag v1.5.5 and build and push rcmd-1.5.5.gem to Rubygems</span>
+<span class="ruby-identifier">rake</span> <span class="ruby-identifier">rerdoc</span> <span class="ruby-comment"># Rebuild RDoc HTML files</span>
+<span class="ruby-identifier">rake</span> <span class="ruby-identifier">spec</span> <span class="ruby-comment"># Run RSpec code examples</span>
+</pre>
+</main>
-</div>
-
-<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>