diff options
Diffstat (limited to 'files/README_rdoc.html')
| -rw-r--r-- | files/README_rdoc.html | 20 |
1 files changed, 10 insertions, 10 deletions
diff --git a/files/README_rdoc.html b/files/README_rdoc.html index 95f2884..7a4adee 100644 --- a/files/README_rdoc.html +++ b/files/README_rdoc.html @@ -25,20 +25,20 @@ <body class='page'> <div class='file' id='wrapper'> <div class='header'> - <h1 class='name'>README.rdoc</h1> + <div class='name'>README.rdoc</div> <div class='paths'> README.rdoc </div> <div class='last-update'> Last Update: - <span class='datetime'>2013-02-06 11:04:09 -0800</span> + <span class='datetime'>2015-04-11 12:56:28 -0700</span> </div> </div> <div id='content'> <div id='text'> <div id='description'> - <h1 id="label-Net%3A%3ASSH%3A%3AMulti"><a href="../classes/Net/SSH/Multi.html">Net::SSH::Multi</a></h1> + <h1><a href="../classes/Net/SSH/Multi.html">Net::SSH::Multi</a></h1> <ul><li> <p>Docs: <a href="http://net-ssh.github.com/net-ssh-multi">net-ssh.github.com/net-ssh-multi</a></p> @@ -54,7 +54,7 @@ <p><em>As of v1.1.1, all gem releases are signed. See INSTALL.</em></p> - <h2 id="label-DESCRIPTION%3A">DESCRIPTION:</h2> + <h2>DESCRIPTION:</h2> <p><a href="../classes/Net/SSH/Multi.html">Net::SSH::Multi</a> is a library for controlling multiple <a href="../classes/Net/SSH.html">Net::SSH</a> @@ -68,7 +68,7 @@ parallel, and allows commands to be executed on subsets of servers (defined by groups).</p> - <h2 id="label-FEATURES%3A">FEATURES:</h2> + <h2>FEATURES:</h2> <ul><li> <p>Easily manage multiple connections</p> </li><li> @@ -82,17 +82,17 @@ tunneled, or even specify a different gateway machine for each server</p> </li></ul> - <h2 id="label-SYNOPSIS%3A">SYNOPSIS:</h2> + <h2>SYNOPSIS:</h2> <p>In a nutshell:</p> - <pre class="ruby"><span class="ruby-identifier">require</span> <span class="ruby-string">'net/ssh/multi'</span>

<span class="ruby-constant">Net</span><span class="ruby-operator">::</span><span class="ruby-constant">SSH</span><span class="ruby-operator">::</span><span class="ruby-constant">Multi</span>.<span class="ruby-identifier">start</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">session</span><span class="ruby-operator">|</span>
 <span class="ruby-comment"># access servers via a gateway</span>
 <span class="ruby-identifier">session</span>.<span class="ruby-identifier">via</span> <span class="ruby-string">'gateway'</span>, <span class="ruby-string">'gateway-user'</span>

 <span class="ruby-comment"># define the servers we want to use</span>
 <span class="ruby-identifier">session</span>.<span class="ruby-identifier">use</span> <span class="ruby-string">'user1@host1'</span>
 <span class="ruby-identifier">session</span>.<span class="ruby-identifier">use</span> <span class="ruby-string">'user2@host2'</span>

 <span class="ruby-comment"># define servers in groups for more granular access</span>
 <span class="ruby-identifier">session</span>.<span class="ruby-identifier">group</span> :<span class="ruby-identifier">app</span> <span class="ruby-keyword">do</span>
 <span class="ruby-identifier">session</span>.<span class="ruby-identifier">use</span> <span class="ruby-string">'user@app1'</span>
 <span class="ruby-identifier">session</span>.<span class="ruby-identifier">use</span> <span class="ruby-string">'user@app2'</span>
 <span class="ruby-keyword">end</span>

 <span class="ruby-comment"># execute commands on all servers</span>
 <span class="ruby-identifier">session</span>.<span class="ruby-identifier">exec</span> <span class="ruby-string">"uptime"</span>

 <span class="ruby-comment"># execute commands on a subset of servers</span>
 <span class="ruby-identifier">session</span>.<span class="ruby-identifier">with</span>(:<span class="ruby-identifier">app</span>).<span class="ruby-identifier">exec</span> <span class="ruby-string">"hostname"</span>

 <span class="ruby-comment"># run the aggregated event loop</span>
 <span class="ruby-identifier">session</span>.<span class="ruby-identifier">loop</span>
<span class="ruby-keyword">end</span></pre> + <pre>require 'net/ssh/multi'
Net::SSH::Multi.start do |session|
 # access servers via a gateway
 session.via 'gateway', 'gateway-user'

 # define the servers we want to use
 session.use 'user1@host1'
 session.use 'user2@host2'

 # define servers in groups for more granular access
 session.group :app do
 session.use 'user@app1'
 session.use 'user@app2'
 end

 # execute commands on all servers
 session.exec "uptime"

 # execute commands on a subset of servers
 session.with(:app).exec "hostname"

 # run the aggregated event loop
 session.loop
end</pre> <p>See <a href="../classes/Net/SSH/Multi/Session.html">Net::SSH::Multi::Session</a> for more documentation.</p> - <h2 id="label-REQUIREMENTS%3A">REQUIREMENTS:</h2> + <h2>REQUIREMENTS:</h2> <ul><li> <p>net-ssh (version 2)</p> </li><li> @@ -106,7 +106,7 @@ <p>Mocha (for the tests)</p> </li></ul> - <h2 id="label-INSTALL%3A">INSTALL:</h2> + <h2>INSTALL:</h2> <ul><li> <p>gem install net-ssh-multi</p> </li></ul> @@ -127,7 +127,7 @@ data signature". If you're still having trouble let me know and I'll give you a hand.</p> - <h2 id="label-LICENSE%3A">LICENSE:</h2> + <h2>LICENSE:</h2> <p>(The MIT License)</p> |