rumai 3.2.2 → 3.2.3

data/CREDITS

@@ -1,5 +1,27 @@
-- Christoph Blank <http://textmode.at>
-- ghedamat <http://github.com/ghedamat>
-- Gigamo <http://github.com/gigamo>
-- Michael Andrus <http://github.com/centyx>
-- Simon Hafner <http://github.com/Tass>
+%#----------------------------------------------------------------------------
+## AUTHORS
+%#----------------------------------------------------------------------------
+
+Suraj N. Kurapati
+
+%#----------------------------------------------------------------------------
+## CREDITS
+%#----------------------------------------------------------------------------
+
+Christoph Blank,
+Simon Hafner,
+Michael Andrus,
+Nathan Neff,
+[Gigamo],
+[ghedamat]
+
+%# XXX: only link to these contributors because they do not have real names
+[Gigamo]: http://github.com/gigamo
+[ghedamat]: http://github.com/ghedamat
+
+%#----------------------------------------------------------------------------
+## LICENSE
+%#----------------------------------------------------------------------------
+
+%# See the file named "LICENSE".
+%< "LICENSE"

data/bin/rumai

@@ -17,25 +17,20 @@
 #   -v, --version : Show version number and exit.
 #
 
-$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 require 'rumai'
 
 # parse command line
 if ARGV.delete('-h') or ARGV.delete('--help')
-  puts
-  puts Rumai.inspect
-  puts Rumai::TAGLINE
-  puts
-  puts
-  puts File.read(__FILE__)[/^#(\r?\n)(.*?)\1\1/m, 2].gsub(/^# ?/, '')
-  puts
-  puts
-  puts 'Read the user manual for more information:'
-  puts
-  puts "  #{Rumai::INSTDIR}/doc/index.html"
-  puts
-  puts "  #{Rumai::WEBSITE}"
-  puts
+  # try to display UNIX version of help manual
+  man_path = File.join(Rumai::INSTDIR, 'man')
+  unless system 'man', '-M', man_path, '-a', 'rumai'
+    # try to display HTML version of help manual
+    man_html = man_path + '.html'
+    unless %w[$BROWSER open start].any? {|b| system "#{b} #{man_html}" }
+      # no luck; direct user to project website
+      puts "See #{Rumai::WEBSITE}"
+    end
+  end
   exit
 elsif ARGV.delete('-v') or ARGV.delete('--version')
   puts Rumai::VERSION
@@ -43,27 +38,7 @@ elsif ARGV.delete('-v') or ARGV.delete('--version')
 end
 
 # start IRB session
-require 'irb'
-require 'irb/completion' # enable TAB-completion
-
-module IRB
-  ##
-  # Starts an IRB session *inside* the given object.
-  #
-  # This code was adapted from a snippet on Massimiliano Mirra's website:
-  # http://www.therubymine.com/articles/2007/01/29/programmare-dallinterno
-  #
-  def self.start_session context
-    IRB.setup nil
-
-    env = IRB::WorkSpace.new(context)
-    irb = IRB::Irb.new(env)
-    IRB.conf[:MAIN_CONTEXT] = irb.context
-
-    catch :IRB_EXIT do
-      irb.eval_input
-    end
-  end
-end
+require 'rumai/irb'
+require 'irb/completion'
 
 IRB.start_session Rumai

data/lib/rumai/inochi.rb

@@ -18,12 +18,12 @@ module Rumai
   ##
   # Number of this release of this project.
   #
-  VERSION = "3.2.2"
+  VERSION = "3.2.3"
 
   ##
   # Date of this release of this project.
   #
-  RELDATE = "2010-04-01"
+  RELDATE = "2010-04-28"
 
   ##
   # Description of this release of this project.
@@ -74,30 +74,21 @@ module Rumai
   #   }
   #
   DEVTIME = {
-    "inochi" => [ "~> 2" ], # for managing this project
+    "inochi" => [ ">= 3.0.0", "< 4" ],
     "dfect"  => [ "~> 2" ], # for unit testing
   }
 
-  ##
-  # Loads the correct version (as defined by the {RUNTIME} or {DEVTIME}
-  # constant in this module) of the given gem or the gem that contains
-  # the given library.
-  #
-  def self.require gem_name_or_library
-    # prepare the correct version of the gem for loading
-    if respond_to? :gem
-      gem_name = gem_name_or_library.to_s.sub(%r{/.*$}, '')
-      if gem_version = RUNTIME[gem_name] || DEVTIME[gem_name]
+  # establish gem version dependencies
+  if respond_to? :gem
+    [RUNTIME, DEVTIME].each do |deps|
+      deps.each do |gem_name, gem_version|
         begin
-          gem gem_name, *gem_version
+          gem gem_name, *Array(gem_version)
         rescue LoadError => error
           warn "#{self.inspect}: #{error}"
         end
       end
     end
-
-    # do the loading
-    super
   end
 
 end

data/lib/rumai/irb.rb

@@ -0,0 +1,21 @@
+require 'irb'
+
+module IRB
+  ##
+  # Starts an IRB session *inside* the given object.
+  #
+  # This code was adapted from a snippet on Massimiliano Mirra's website:
+  # http://www.therubymine.com/articles/2007/01/29/programmare-dallinterno
+  #
+  def self.start_session context
+    IRB.setup nil
+
+    env = IRB::WorkSpace.new(context)
+    irb = IRB::Irb.new(env)
+    IRB.conf[:MAIN_CONTEXT] = irb.context
+
+    catch :IRB_EXIT do
+      irb.eval_input
+    end
+  end
+end

data/man.html

@@ -0,0 +1,914 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <meta http-equiv='content-type' value='text/html;charset=utf8'>
+  <meta name='generator' value='Ronn/v0.5'>
+  <title>rumai(1) - Ruby interface to the wmii window manager</title>
+  <style type='text/css'>
+    body {margin:0}
+    #man, #man code, #man pre, #man tt, #man kbd, #man samp {
+      font-family:consolas,monospace;
+      font-size:16px;
+      line-height:1.3;
+      color:#343331;
+      background:#fff; }
+    #man { max-width:87ex; margin:0 3ex 1ex 1ex; text-align:justify; }
+    #man div.man-navigation {
+      position:fixed;
+      top:0;
+      left:91ex;
+      height:100%;
+      width:100%;
+      padding:1ex 0 0 2ex;
+      border-left:0.5ex solid #DCDCDC;
+      background-color: #F5F5F5;
+    }
+    #man div.man-navigation a { display:block; margin-bottom:1.5ex }
+    #man h1, #man h2, #man h3 { color:#232221;clear:left }
+    #man h1 { font-size:28px; margin:15px 0 30px 0; text-align:center }
+    #man h2 { font-size:18px; margin-bottom:0; margin-top:10px; line-height:1.3; }
+    #man h3 { font-size:16px; margin:0 0 0 4ex; }
+    #man p, #man ul, #man ol, #man dl, #man pre { margin:0 0 18px 0; }
+    #man pre {
+      color:#333231;
+      background:#edeceb;
+      padding:5px 7px;
+      margin:0px 0 20px 0;
+      border-left:2ex solid #ddd}
+    #man pre + h2, #man pre + h3 {
+      margin-top:22px;
+    }
+    #man h2 + pre, #man h3 + pre {
+      margin-top:5px;
+    }
+    #man > p, #man > ul, #man > ol, #man > dl, #man > pre { margin-left:8ex; }
+    #man dt { margin:0; clear:left }
+    #man dt.flush { float:left; width:8ex }
+    #man dd { margin:0 0 0 9ex }
+    #man code, #man strong, #man b { font-weight:bold; color:#131211; }
+    #man pre code { font-weight:normal; color:#232221; background:inherit }
+    #man em, var, u {
+      font-style:normal; color:#333231; border-bottom:1px solid #999; }
+    #man h1.man-title { display:none; }
+    #man ol.man, #man ol.man li { margin:2px 0 10px 0; padding:0;
+      float:left; width:33%; list-style-type:none;
+      text-transform:uppercase; font-size:18px; color:#999;
+      letter-spacing:1px;}
+    #man ol.man { width:100%; }
+    #man ol.man li.tl { text-align:left }
+    #man ol.man li.tc { text-align:center;letter-spacing:4px }
+    #man ol.man li.tr { text-align:right; float: right }
+    #man ol.man a { color:#999 }
+    #man ol.man a:hover { color:#333231 }
+    #man img { display:block; margin:auto }
+  </style>
+  <style type='text/css' media='print'>
+    #man { max-width:none }
+    #man div.man-navigation { display:none }
+    #man a[href]:not([href^="#"]):not([data-bare-link]):after {
+      content:" " attr(href);
+    }
+  </style>
+</head>
+<body>
+<div id='man'>
+
+<div class='man-navigation'><a href='#NAME'>NAME</a> <a href='#SYNOPSIS'>SYNOPSIS</a> <a href='#DESCRIPTION'>DESCRIPTION</a> <a href='#OPTIONS'>OPTIONS</a> <a href='#EXAMPLES'>EXAMPLES</a> <a href='#HACKING'>HACKING</a> <a href='#VERSIONS'>VERSIONS</a> <a href='#AUTHORS'>AUTHORS</a> <a href='#CREDITS'>CREDITS</a> <a href='#LICENSE'>LICENSE</a> <a href='#SEE-ALSO'>SEE ALSO</a></div>
+
+<h1 class='man-title'>rumai(1)</h1>
+
+<ol class='head man'>
+  <li class='tl'>rumai(1)</li>
+  <li class='tc'>Version 3.2.3</li>
+  <li class='tr'>rumai(1)</li>
+</ol>
+
+<h2 id='NAME'>NAME</h2>
+<p><code>rumai</code> - Ruby interface to the wmii window manager</p>
+
+<p>Rumai is a pure <a href="http://ruby-lang.org">Ruby</a> interface to the <a href="http://wmii.suckless.org">wmii</a> window manager.  Its name is a
+portmanteau of "<em>Ru</em>by" and "w<em>mi</em>i" (which I pronounce as "vim eye").</p>
+
+<h3 id="Features">Features</h3>
+
+<ul>
+<li><p>Provides an interactive shell for live experimentation.</p></li>
+<li><p>Arranges clients, columns, views, and tags dynamically.</p></li>
+<li><p>Talks directly to wmii's <a href="http://libs.suckless.org/libixp">IXP filesystem interface</a>.</p></li>
+<li><p>Includes a pure Ruby client for the <a href="http://cm.bell-labs.com/magic/man2html/5/intro">9P2000 protocol</a>.</p></li>
+<li><p>Powers <a href="http://github.com/sunaku/wmiirc">my personal</a> wmiirc and
+<a href="http://github.com/sunaku/wmiirc/network">many others</a> like it.</p></li>
+</ul>
+
+
+<h3 id="Resources">Resources</h3>
+
+<dl>
+<dt>Issue tracker (report bugs, request features, get help)</dt><dd><p><a href="http://github.com/sunaku/rumai/issues" data-bare-link="true">http://github.com/sunaku/rumai/issues</a></p></dd>
+<dt>Source code (browse online or obtain with <a href="http://git-scm.com">Git</a>)</dt><dd><p><a href="http://github.com/sunaku/rumai" data-bare-link="true">http://github.com/sunaku/rumai</a></p></dd>
+<dt>API documentation</dt><dd><p><a href="http://snk.tuxfamily.org/lib/rumai/api/" data-bare-link="true">http://snk.tuxfamily.org/lib/rumai/api/</a></p></dd>
+<dt>Announcements feed</dt><dd><p><a href="http://snk.tuxfamily.org/lib/rumai/ann.xml" data-bare-link="true">http://snk.tuxfamily.org/lib/rumai/ann.xml</a></p></dd>
+<dt>Official website</dt><dd><p><a href="http://snk.tuxfamily.org/lib/ember/" data-bare-link="true">http://snk.tuxfamily.org/lib/ember/</a></p></dd>
+</dl>
+
+
+<h3 id="Setup">Setup</h3>
+
+<p>Prerequisites:</p>
+
+<ul>
+<li><p><a href="http://ruby-lang.org">Ruby</a> 1.8.6 or newer.</p></li>
+<li><p><a href="http://rubygems.org">RubyGems</a> 1.3.6 or newer.</p></li>
+<li><p><a href="http://wmii.suckless.org">wmii</a> 3.9 or newer.</p></li>
+</ul>
+
+
+<p>Installing:</p>
+
+<pre><code>gem install rumai
+</code></pre>
+
+<p>Upgrading:</p>
+
+<pre><code>gem update rumai
+</code></pre>
+
+<p>Removing:</p>
+
+<pre><code>gem uninstall rumai
+</code></pre>
+
+<h2 id="SYNOPSIS">SYNOPSIS</h2>
+
+<p><code>rumai</code> [<var>OPTIONS</var>] [<var>IRB_OPTIONS</var>]</p>
+
+<h2 id="DESCRIPTION">DESCRIPTION</h2>
+
+<p>Starts an interactive Ruby shell (IRB) session by passing the given
+<var>IRB_OPTIONS</var> to irb(1).  This puts you at a command prompt as follows:</p>
+
+<pre><code>irb(Rumai):001:0&gt;
+</code></pre>
+
+<p>The <code>irb(Rumai)</code> token in the command prompt indicates that commands will be
+evaluated <em>inside</em> the <code>Rumai</code> module.  As a result, you can omit the "Rumai"
+prefix from your commands if you wish.</p>
+
+<p>For example, to get the currently selected client, you can type <code>curr_client</code>
+instead of <code>Rumai.curr_client</code> at the prompt.  Both commands achieve the same
+effect.</p>
+
+<p>The next thing to notice is that <em>TAB completion</em> is enabled.  So you can type
+part of a command and press the TAB key to see a list of possible completions.</p>
+
+<h2 id="OPTIONS">OPTIONS</h2>
+
+<dl>
+<dt><code>-h</code>, <code>--help</code></dt><dd><p>Display this manual and exit.</p></dd>
+<dt><code>-v</code>, <code>--version</code></dt><dd><p>Print version number and exit.</p></dd>
+</dl>
+
+
+<h2 id="EXAMPLES">EXAMPLES</h2>
+
+<p>Now that you know how to start the interactive shell (see <strong>DESCRIPTION</strong>
+above) let us walk through a series of examples that highlight the main
+features of Rumai.  You can follow along by copying &amp; pasting the presented
+commands into the interactive shell.</p>
+
+<h3 id="Automated-client-arrangement">Automated client arrangement</h3>
+
+<p>Launch a few terminals so that we have something to work with:</p>
+
+<pre><code>colors = %w[ red green blue black orange brown gray navy gold ]
+colors.each {|c| system "xterm -bg #{c} -title #{c} -e sh -c read &amp;" }
+</code></pre>
+
+<p>Arrange all clients in a grid:</p>
+
+<pre><code>curr_view.arrange_in_grid
+</code></pre>
+
+<p>Arrange all clients in a diamond shape:</p>
+
+<pre><code>curr_view.arrange_in_diamond
+</code></pre>
+
+<p>Arrange all clients like LarsWM does:</p>
+
+<pre><code>curr_view.arrange_as_larswm
+</code></pre>
+
+<p>Close the terminals we launched earlier:</p>
+
+<pre><code>terms = curr_view.clients.select {|c| colors.include? c.label.read }
+terms.each {|c| c.kill }
+</code></pre>
+
+<h3 id="Multiple-client-grouping">Multiple client grouping</h3>
+
+<p>Launch a few terminals so that we have something to work with:</p>
+
+<pre><code>colors = %w[ red green blue black orange brown gray navy gold ]
+colors.each {|c| system "xterm -bg #{c} -title #{c} -e sh -c read &amp;" }
+</code></pre>
+
+<p>Add the red, green, and blue terminals into the "grouping":</p>
+
+<pre><code>terms = curr_view.clients.select do |c|
+  %w[red green blue].include? c.label.read
+end
+terms.each {|c| c.group }
+</code></pre>
+
+<p>You should now see a new button labelled as "@" on the left-hand side of
+wmii's bar, indicating that there is now a new view labelled "@" in wmii.
+Let us inspect what clients this mysterious view contains:</p>
+
+<pre><code>v = View.new "@"
+puts v.clients.map {|c| c.label.read }
+</code></pre>
+
+<p>Aha! The mysterious view contains the red, green, and blue clients we
+recently "grouped". Thus, by adding a client to the "grouping", we are
+simply tagging the client with the "@" token.</p>
+
+<p>Now that we have put some clients into the "grouping", let us move all
+clients in the grouping to the floating area in the current view:</p>
+
+<pre><code>grouping.each {|c| c.send "toggle" }
+</code></pre>
+
+<p>Neat! Let us bring them back into the managed area:</p>
+
+<pre><code>grouping.each {|c| c.send "toggle" }
+</code></pre>
+
+<p>Close the terminals we launched earlier:</p>
+
+<pre><code>terms = curr_view.clients.select {|c| colors.include? c.label.read }
+terms.each {|c| c.kill }
+</code></pre>
+
+<p>In summary, you can select multiple clients (by adding them to the
+"grouping") and perform operations on them. This is useful when you want
+to do something with a group of clients but do not want to manually focus
+one, perform the action, focus the next one, and so on.</p>
+
+<p>Another important aspect is that selected clients stay selected until they
+are unselected. This allows you to continue performing tasks on the
+selection without having to reselect the same clients after every
+operation.</p>
+
+<h3 id="Easy-column-manipulation">Easy column manipulation</h3>
+
+<p>Launch a few terminals so that we have something to work with:</p>
+
+<pre><code>colors = %w[ red green blue black orange brown gray navy gold ]
+colors.each {|c| system "xterm -bg #{c} -title #{c} -e sh -c read &amp;" }
+</code></pre>
+
+<p>You can insert a group of clients to the top, bottom, or after the
+currently focused client of <em>any</em> column using Array-like methods.</p>
+
+<p>Give each client its own column (one client per column):</p>
+
+<pre><code>curr_view.each_column {|c| c.length = 1 }
+</code></pre>
+
+<p>Put (at most) three clients in every column:</p>
+
+<pre><code>curr_view.each_column {|c| c.length = 3 }
+</code></pre>
+
+<p>Move the red, green, and blue clients into the floating area:</p>
+
+<pre><code>rgb = %w[red green blue]
+terms = curr_view.clients.select {|c| rgb.include? c.label.read }
+curr_view.areas[0].push terms
+</code></pre>
+
+<p>Slurp all floating clients into the last column:</p>
+
+<pre><code>list = curr_view.areas
+a, b = list.first, list.last
+b.concat a
+</code></pre>
+
+<p>Set the last column's layout to stacking mode:</p>
+
+<pre><code>b.layout = 'stack'
+</code></pre>
+
+<p>Move the red, green, and blue clients to the top of the second column:</p>
+
+<pre><code>curr_view.areas[2].unshift terms
+</code></pre>
+
+<p>Move the red, green, and blue clients to the bottom of the third column:</p>
+
+<pre><code>curr_view.areas[3].push terms
+</code></pre>
+
+<p>Close the terminals we launched earlier:</p>
+
+<pre><code>terms = curr_view.clients.select {|c| colors.include? c.label.read }
+terms.each {|c| c.kill }
+</code></pre>
+
+<h3 id="Easy-client-manipulation">Easy client manipulation</h3>
+
+<p>Launch a few terminals so that we have something to work with:</p>
+
+<pre><code>colors = %w[ red green blue black orange brown gray navy gold ]
+colors.each {|c| system "xterm -bg #{c} -title #{c} -e sh -c read &amp;" }
+</code></pre>
+
+<p>Obtain a reference to the red client:</p>
+
+<pre><code>red = curr_view.clients.find {|c| c.label.read == "red" }
+</code></pre>
+
+<p>Show the red client's current tags:</p>
+
+<pre><code>red.tags
+</code></pre>
+
+<p>Add the "foo" and "bar" tags to the red client:</p>
+
+<pre><code>red.tag "foo", "bar"
+</code></pre>
+
+<p>Remove the "bar" tag from the red client:</p>
+
+<pre><code>red.untag "bar"
+</code></pre>
+
+<p>Do complex operations on the red client's tags:</p>
+
+<pre><code>red.with_tags { concat %w[a b c]; push 'z'; delete 'c' }
+</code></pre>
+
+<p>Focus the next client after the red client:</p>
+
+<pre><code>red.next.focus
+curr_client == red.next #=&gt; true
+</code></pre>
+
+<p>Notice that by focusing a client, we make it the current client.</p>
+
+<p>Focus the red client on a different view:</p>
+
+<pre><code>orig = curr_view
+v = red.views.last
+red.focus v
+</code></pre>
+
+<p>Return to the original view:</p>
+
+<pre><code>orig.focus
+</code></pre>
+
+<p>Send the red client to the last column:</p>
+
+<pre><code>red.send curr_view.areas.last
+</code></pre>
+
+<p>Close the terminals we launched earlier:</p>
+
+<pre><code>terms = curr_view.clients.select {|c| colors.include? c.label.read }
+terms.each {|c| c.kill }
+</code></pre>
+
+<h3 id="Traversing-the-file-system">Traversing the file system</h3>
+
+<p>Show the root node of wmii's IXP file system:</p>
+
+<pre><code>fs
+</code></pre>
+
+<p>Show the names of all files at the root level:</p>
+
+<pre><code>fs.entries
+</code></pre>
+
+<p>Show the parent of the root node:</p>
+
+<pre><code>fs.parent
+</code></pre>
+
+<p>Show the children of the root node:</p>
+
+<pre><code>fs.children
+</code></pre>
+
+<p>Navigate into to the <code>/lbar/</code> directory:</p>
+
+<pre><code>n1 = fs.lbar
+n2 = fs['lbar']
+n1 == n2 #=&gt; true
+left_bar = n1
+</code></pre>
+
+<p>Notice that you can traverse the file system hierarchy by simply calling
+methods on node objects.  Alternatively, you can traverse by specifying an
+arbitrary sub-path (relative path) using the <code>[]</code> operator on a node.</p>
+
+<p>Create a new temporary button:</p>
+
+<pre><code>b = left_bar.rumai_example # path of new button
+b.exist? #=&gt; false
+b.create
+b.exist? #=&gt; true
+</code></pre>
+
+<p>You should now see an empty button on the left-hand side of the wmii bar.</p>
+
+<p>Color the button black-on-white and label it as "hello world":</p>
+
+<pre><code>content = "#000000 #ffffff #000000 hello world"
+b.write content
+b.read == content #=&gt; true
+</code></pre>
+
+<p>Remove the temporary button:</p>
+
+<pre><code>b.remove
+b.exist? #=&gt; false
+</code></pre>
+
+<h2 id="HACKING">HACKING</h2>
+
+<p>This section is meant for people who want to develop Rumai's source code.</p>
+
+<h3 id="Prerequisites">Prerequisites</h3>
+
+<p>Install Ruby libraries necessary for development:</p>
+
+<pre><code>gem install rumai --development
+</code></pre>
+
+<h3 id="Infrastructure">Infrastructure</h3>
+
+<p><a href="http://snk.tuxfamily.org/lib/inochi/">Inochi</a> serves as the project infrastructure for Rumai.  It handles tasks
+such as building this help manual and API documentation, and packaging,
+announcing, and publishing new releases.  See its help manual and list of
+tasks to get started:</p>
+
+<pre><code>inochi --help     # display help manual
+inochi --tasks    # list available tasks
+</code></pre>
+
+<h3 id="-LOAD_PATH-setup">$LOAD_PATH setup</h3>
+
+<p>Ensure that the <code>lib/</code> directory is listed in Ruby's <code>$LOAD_PATH</code> before you
+use any libraries therein or run any executables in the <code>bin/</code> directory.</p>
+
+<p>This can be achieved by passing an option to Ruby:</p>
+
+<pre><code>ruby -Ilib bin/rumai
+irb -Ilib -r rumai
+</code></pre>
+
+<p>Or by setting the <code>$RUBYLIB</code> environment variable:</p>
+
+<pre><code>export RUBYLIB=lib   # bash, ksh, zsh
+setenv RUBYLIB lib   # csh
+set -x RUBYLIB lib   # fish
+
+ruby bin/rumai
+irb -r rumai
+</code></pre>
+
+<p>Or by installing the <a href="http://github.com/chneukirchen/rup">ruby-wrapper</a> tool.</p>
+
+<h3 id="RubyGems-setup">RubyGems setup</h3>
+
+<p>If you use Ruby 1.8 or older, then ensure that RubyGems is activated before
+you use any libraries in the <code>lib/</code> directory or run any executables in the
+<code>bin/</code> directory.</p>
+
+<p>This can be achieved by passing an option to Ruby:</p>
+
+<pre><code>ruby -rubygems bin/rumai
+irb -rubygems -r rumai
+</code></pre>
+
+<p>Or by setting the <code>$RUBYOPT</code> environment variable:</p>
+
+<pre><code>export RUBYOPT=-rubygems   # bash, ksh, zsh
+setenv RUBYOPT -rubygems   # csh
+set -x RUBYOPT -rubygems   # fish
+</code></pre>
+
+<h3 id="Running-tests">Running tests</h3>
+
+<p>Simply execute the included test runner, which sets up Ruby's <code>$LOAD_PATH</code> for
+testing, loads the included <code>test/test_helper.rb</code> file, and then evaluates all
+<code>test/**/*_test.rb</code> files:</p>
+
+<pre><code>test/runner
+</code></pre>
+
+<p>Its exit status will indicate whether all tests have passed.  It may also
+print additional pass/fail information depending on the testing library used
+in the <code>test/test_helper.rb</code> file.</p>
+
+<h3 id="Contributing">Contributing</h3>
+
+<p>Fork this project on GitHub (see <strong>Resources</strong> above) and send a pull request.</p>
+
+<h2 id="VERSIONS">VERSIONS</h2>
+
+<p>This section contains release notes of current and past releases.</p>
+
+<h3 id="Version-3-2-3-2010-04-28-">Version 3.2.3 (2010-04-28)</h3>
+
+<p>This release adds a UNIX manual page and requires wmii 3.9 or newer.</p>
+
+<p>Bug fixes:</p>
+
+<ul>
+<li><p><code>Rumai::Area#unshift</code> needs wmii 3.9 or newer.
+The help manual has been corrected accordingly.</p>
+
+<p>Thanks to <a href="http://github.com/ghedamat">ghedamat</a> for reporting <a href="http://github.com/sunaku/wmiirc/issues/8">this issue</a>.</p></li>
+</ul>
+
+
+<p>Housekeeping:</p>
+
+<ul>
+<li><p>Upgrade to Inochi 3.0.0.  Run <code>rumai --help</code> to see the UNIX manual page!</p></li>
+<li><p>Move IRB session creation code from rumai(1) into <code>rumai/irb</code> sub-library.</p></li>
+</ul>
+
+
+<h3 id="Version-3-2-2-2010-04-01-">Version 3.2.2 (2010-04-01)</h3>
+
+<p>This release fixes some warnings that appeared during installation and
+performs some minor housekeeping.</p>
+
+<p>Bug fixes:</p>
+
+<dl>
+<dt>Warnings of the following form appeared during gem installation:</dt><dd><p></p>
+
+<pre><code>Unrecognized directive '...' in lib/rumai/inochi.yaml
+</code></pre>
+
+<p>Thanks to <a href="http://github.com/ghedamat">ghedamat</a> for reporting this.</p></dd>
+</dl>
+
+
+<p>Housekeeping:</p>
+
+<ul>
+<li>Upgrade to Inochi 2.0.0-rc2 for managing this project.</li>
+</ul>
+
+
+<h3 id="Version-3-2-1-2010-03-22-">Version 3.2.1 (2010-03-22)</h3>
+
+<p>This release improves multi-threading support in Rumai's pure-Ruby
+implementation of the <a href="http://libs.suckless.org/libixp">IXP file-system interface</a>.</p>
+
+<p>Thank you:</p>
+
+<ul>
+<li><a href="http://github.com/gigamo">Gigamo</a> reported the issue of status bar applets not refreshing
+according to their prescribed schedule (this is particularly noticable
+in the clock applet) and verified my fix for the problem.</li>
+</ul>
+
+
+<p>Bug fixes:</p>
+
+<ul>
+<li>Perform a blocking I/O read to recieve a 9P2000 message in
+<code>Rumai::IXP::Agent#recv</code> only if recieve buffer is empty.  This gives
+other threads a chance to check the recieve buffer for their response.
+instead of being blocked by us as we greedily hold on to the 9P2000
+message stream until our expected response arrives.</li>
+</ul>
+
+
+<p>Housekeeping:</p>
+
+<ul>
+<li>Upgrade to Inochi 2.0.0-rc1 and Dfect 2.0.0.</li>
+</ul>
+
+
+<h3 id="Version-3-2-0-2009-11-17-">Version 3.2.0 (2009-11-17)</h3>
+
+<p>This release adds a new automated view arrangement, simplifies the IXP
+transport layer, and cleans up the code and API documentation.</p>
+
+<p>New features:</p>
+
+<ul>
+<li><p>Add <code>Rumai::View#arrange_in_stacks</code> automated view arrangement.</p></li>
+<li><p>Convert <code>:stack</code> and <code>:max</code> arguments into wmii 3.9 syntax in
+<code>Rumai::Area#layout=</code>.</p></li>
+</ul>
+
+
+<p>Bug fixes:</p>
+
+<ul>
+<li>Rewrote IXP transport layer (<code>Rumai::IXP::Agent</code>) to <em>not</em> use a
+background thread, according to <a href="http://www.x.org/releases/X11R7.5/doc/libxcb/tutorial/#requestsreplies">the XCB cookie approach</a>.</li>
+</ul>
+
+
+<p>Housekeeping:</p>
+
+<ul>
+<li><p>Clean up some code and API docs.</p></li>
+<li><p>Reduce amount of string concatenation in <code>Struct#to_9p</code>.</p></li>
+</ul>
+
+
+<h3 id="Version-3-1-1-2009-11-16-">Version 3.1.1 (2009-11-16)</h3>
+
+<p>This release fixes bugs in automated view arrangements and updates the user
+manual.</p>
+
+<p>Thank you:</p>
+
+<ul>
+<li>Nathan Neff reported the client ordering bug in automated view
+arrangements.</li>
+</ul>
+
+
+<p>Bug fixes:</p>
+
+<ul>
+<li><p>The relative order of clients was not being preserved during view
+arrangements.</p></li>
+<li><p>Focus on the current view was lost after automated view arrangement was
+applied if the current view was not the first view on which the initially
+focused (before the automated arrangement was applied) client appeared.</p></li>
+</ul>
+
+
+<h3 id="Version-3-1-0-2009-10-02-">Version 3.1.0 (2009-10-02)</h3>
+
+<p>This release adds new methods, fixes some bugs, and revises the manual.</p>
+
+<p>New features:</p>
+
+<ul>
+<li><p>Add <code>Client#float</code> methods to manipulate floating status.</p></li>
+<li><p>Add <code>Client#manage</code> methods to manipulate managed status.</p></li>
+<li><p>The <code>Client#tags=</code> method now accepts '~' and '!' tag prefixes.</p></li>
+</ul>
+
+
+<p>Bug fixes:</p>
+
+<ul>
+<li><p>There is no <code>View#move_focus</code> method, only <code>View#select</code>.</p></li>
+<li><p>Assertion failure in test suite because all files in <code>/rbar</code>
+(inside wmii's IXP filesystem) contain an automatic color header when
+read.</p></li>
+</ul>
+
+
+<p>Housekeeping:</p>
+
+<ul>
+<li><p>Use simpler Copyright reminder at the top of every file.</p></li>
+<li><p>Open source is for fun, so <a href="http://loiclemeur.com/english/2009/03/never-criticize-your-competitors.html">be
+nice</a>:
+speak of "related works" instead of "competitors".</p></li>
+</ul>
+
+
+<h3 id="Version-3-0-0-2009-05-11-">Version 3.0.0 (2009-05-11)</h3>
+
+<p>This release revises method names, adds new methods, and fixes a bug.</p>
+
+<p>Incompatible changes:</p>
+
+<ul>
+<li><p>Rename <code>#toggle_</code> methods to use <code>!</code> suffix in their names.</p></li>
+<li><p>Rename <code>#float</code> methods to <code>#floating</code>.</p></li>
+<li><p>Rename <code>View#floater</code> method to <code>View#floating_area</code>.</p></li>
+</ul>
+
+
+<p>New features:</p>
+
+<ul>
+<li><p>Add <code>Client#stick</code> methods to manipulate sticky status.</p></li>
+<li><p>Add <code>Client#fullscreen</code> methods to manipulate fullscreen status.</p></li>
+<li><p>Add <code>Client#slay</code> method which is a forceful version of <code>#kill</code>.</p></li>
+<li><p>Add <code>View#select</code> method to move focus relatively inside a view.</p></li>
+<li><p>Add <code>Area::floating</code> method for symmetry with <code>Area::curr</code>.</p></li>
+<li><p>Add <code>View#managed_area</code> aliases for <code>View#column</code> methods.</p></li>
+</ul>
+
+
+<p>Bug fixes:</p>
+
+<ul>
+<li><p>Fix error when unzooming clients from temporary view.</p></li>
+<li><p>Fix code that launches temporary terminals in the Tutorial.</p>
+
+<p>Use the <code>/bin/sh</code> version of the <strong>read</strong> command for portability.</p></li>
+</ul>
+
+
+<p>Housekeeping:</p>
+
+<ul>
+<li><p>Use <code>Client#send</code> instead of <code>#swap</code> in automated arrangements because
+it causes less traffic on /event/.</p></li>
+<li><p>Add old release notes from blog to user manual.</p></li>
+</ul>
+
+
+<h3 id="Version-2-1-0-2009-05-09-">Version 2.1.0 (2009-05-09)</h3>
+
+<p>This release improves client arrangement, fixes several bugs, and cleans up
+the code.</p>
+
+<p>Thank you:</p>
+
+<ul>
+<li>Simon Hafner reported several bugs.</li>
+<li>Michael Andrus verified bug fixes.</li>
+</ul>
+
+
+<p>New features:</p>
+
+<ul>
+<li><p>Focus is now restored on the initially focused client after applying
+automated client arrangements.</p></li>
+<li><p>The push(), insert(), and unshift() instance methods of the
+<code>Rumai::Area</code> class now preserve the order of inserted clients.</p></li>
+<li><p>The <code>Rumai::View#arrange_in_grid()</code> method now accepts 1 as a parameter.
+This invocation causes every column to contain at most 1 client.</p></li>
+</ul>
+
+
+<p>Bug fixes:</p>
+
+<ul>
+<li><p>Fix error caused by focusing the top/bottom client in the destination
+area before sending new clients into that area.</p></li>
+<li><p>Fix error when importing clients into an empty area.</p></li>
+</ul>
+
+
+<p>Housekeeping:</p>
+
+<ul>
+<li><p>Use snake_case instead of camelCase for variable names.</p></li>
+<li><p>Add copyright notice at the top of every file.</p></li>
+<li><p>Plenty of code formatting and beautification.</p></li>
+</ul>
+
+
+<h3 id="Version-2-0-2-2009-02-26-">Version 2.0.2 (2009-02-26)</h3>
+
+<p>This release fixes a connection bug.</p>
+
+<p>Thank you:</p>
+
+<ul>
+<li>Simon Hafner reported and helped debug the <code>$DISPLAY</code> bug.</li>
+</ul>
+
+
+<p>Bug fixes:</p>
+
+<ul>
+<li>wmii omits the fractional portion of <code>$DISPLAY</code> in its socket file path.
+Rumai was trying to connect with the entire <code>$DISPLAY</code> value (including
+the fractional portion) and thus could not find wmii's socket file.</li>
+</ul>
+
+
+<h3 id="Version-2-0-1-2009-01-25-">Version 2.0.1 (2009-01-25)</h3>
+
+<p>This release simplifies project administrivia using <a href="http://snk.tuxfamily.org/lib/inochi/">Inochi</a>, improves the unit tests, and revises the user
+manual.</p>
+
+<p>Bug fixes:</p>
+
+<ul>
+<li>The rumai/ixp/message library's unit test failed if
+<code>/rbar/status</code> did not already exist in wmii.</li>
+</ul>
+
+
+<p>Housekeeping:</p>
+
+<ul>
+<li><p>Store IXP socket address in <code>Rumai::IXP_SOCK_ADDR</code>.</p></li>
+<li><p>Added missing test cases for (TR)create and (TR)remove messages in the
+unit test for the rumai/ixp/message library.</p></li>
+</ul>
+
+
+<h3 id="Version-2-0-0-2008-02-04-">Version 2.0.0 (2008-02-04)</h3>
+
+<p>This release adds support for wmii 3.6, improves the performance of the IXP
+library, and fixes some bugs.</p>
+
+<p>Thank you:</p>
+
+<ul>
+<li>Christoph Blank tested Rumai 1.0.0 under wmii 3.6 and reported bugs.</li>
+</ul>
+
+
+<p>Incompatible changes:</p>
+
+<ul>
+<li><p>wmii version 3.6 or newer is now required.</p></li>
+<li><p>The <code>Rumai::IXP::Agent::FidStream#read_partial</code> method has been replaced
+by <code>Rumai::IXP::Agent::FidStream#read(true)</code> for efficiency.</p></li>
+<li><p>The <code>Rumai::IXP::Agent::FidStream#write</code> method no longer writes to
+the beginning of the stream. Instead, it writes to the current position
+in the stream.</p></li>
+<li><p>The <code>Rumai::View#floating_area</code> method has been renamed to
+<code>Rumai::View#floater</code> for brevity.</p></li>
+</ul>
+
+
+<p>New features:</p>
+
+<ul>
+<li><p>Added several more methods (such as rewind, pos=, eof?, and so on) from
+Ruby's IO class to the <code>Rumai::IXP::Agent::FidStream</code> class.</p></li>
+<li><p>Added the <code>Rumai::Client#kill</code> method to simplify client termination.</p></li>
+</ul>
+
+
+<p>Bug fixes:</p>
+
+<ul>
+<li>Fixed a race condition in <code>Rumai::Agent#talk</code> which would cause Rumai to
+hang when multiple threads used it.</li>
+</ul>
+
+
+<h3 id="Version-1-0-0-2008-01-26-">Version 1.0.0 (2008-01-26)</h3>
+
+<p>This is the first release of Rumai, the evolution of
+<a href="http://article.gmane.org/gmane.comp.window-managers.wmii/1704">wmii-irb</a>,
+which lets you manipulate the <a href="http://wmii.suckless.org">wmii</a> window manager through <a href="http://ruby-lang.org">Ruby</a>.  Enjoy!</p>
+
+<h2 id="AUTHORS">AUTHORS</h2>
+
+<p>Suraj N. Kurapati</p>
+
+<h2 id="CREDITS">CREDITS</h2>
+
+<p>Christoph Blank,
+Simon Hafner,
+Michael Andrus,
+Nathan Neff,
+<a href="http://github.com/gigamo">Gigamo</a>,
+<a href="http://github.com/ghedamat">ghedamat</a></p>
+
+<h2 id="LICENSE">LICENSE</h2>
+
+<p>(the ISC license)</p>
+
+<p>Copyright 2006 Suraj N. Kurapati <a href="&#x6d;&#97;&#105;&#108;&#x74;&#x6f;&#58;&#x73;&#117;&#110;&#97;&#x6b;&#117;&#64;&#103;&#109;&#97;&#105;&#x6c;&#46;&#x63;&#x6f;&#109;" data-bare-link="true">&#115;&#x75;&#110;&#x61;&#107;&#117;&#x40;&#x67;&#x6d;&#x61;&#x69;&#x6c;&#46;&#x63;&#x6f;&#109;</a></p>
+
+<p>Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.</p>
+
+<p>THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.</p>
+
+<h2 id="SEE-ALSO">SEE ALSO</h2>
+
+<p>irb(1),
+wmiir(1),
+wmii(1)</p>
+
+
+<ol class='foot man'>
+  <li class='tl'></li>
+  <li class='tc'>April 2010</li>
+  <li class='tr'>rumai(1)</li>
+</ol>
+
+</div>
+</body>
+</html>