rumai 1.0.0

data/doc/guide.erb

@@ -0,0 +1,390 @@
+<%
+  require 'lib/rumai/nfo'
+
+  # local variables for this document
+  download_url    = 'http://rubyforge.org/frs/?group_id=5005'
+  source_repo_url = File.join(Rumai::NFO[:website], 'src')
+  feed_url        = File.join(Rumai::NFO[:website], 'news.xml')
+
+  ruby_url        = 'http://ruby-lang.org'
+  wmii_url        = 'http://www.suckless.org/wiki/wmii'
+  wmii_ixp_url    = 'http://www.suckless.org/wiki/libs/libixp'
+  p9p_url         = 'http://cm.bell-labs.com/magic/man2html/5/intro'
+
+  # parameters for the HTML format
+  $title   = "#{Rumai::NFO} user guide"
+  $authors = { 'Suraj N. Kurapati' => 'http://snk.tuxfamily.org' }
+  $feeds   = { feed_url => :rss }
+
+  # parameters for Gerbil
+  $unindent = '  '
+%>
+
+<% chapter "Introduction" do %>
+  Rumai is a library for manipulating the "wmii":<%= wmii_url %> window manager through "Ruby":<%= ruby_url %>. It excels at *dynamic arrangement* of clients, columns, views, and tags.
+
+  Rumai also provides (1) an <%= xref 'shell', 'interactive shell' %> for live entertainment, and (2) a *pure Ruby client* for the "9P2000 protocol":<%= p9p_url %>, which it uses to communicate with wmii's "IXP file-system interface":<%= wmii_ixp_url %>.
+
+  Rumai is *open-source software* (see <%= xref "License" %>) so feel free to contribute your improvements to and discuss your ideas with the author. You can obtain the source code from the project "Darcs":http://darcs.net repository by running the following command:
+
+    darcs get <%= source_repo_url %> rumai
+
+  <% section "Resources" do %>
+    * "News feed":<%= feed_url %>
+      - project news and release announcements.
+    * "Download area":<%= download_url %>
+      - place to obtain release packages.
+    * "API reference":api/index.html
+      - documentation for all provided Ruby code.
+    * Support / feedback
+      - send an e-mail to the author (see address in <%= xref "License" %>).
+  <% end %>
+
+  <% section "License" do %>
+    <%=h File.read('LICENSE') %>
+  <% end %>
+<% end %>
+
+<% chapter "Setup" do %>
+  <% section "Requirements" do %>
+    Your system needs the following software to run Rumai.
+
+    |_. Software |_. Notes |
+    | "Ruby":<%= ruby_url %> | Version 1.8.x is required. |
+    | "wmii":<%= wmii_url %> | wmii-snap20070516 or newer is required. |
+  <% end %>
+
+  <% section "Installation" do %>
+    If your system has "RubyGems":http://rubygems.org/, then you can install Rumai by running the following commands:
+
+      gem install rumai
+      rumai -v
+
+    Otherwise, follow these instructions:
+    # Download the newest release package from "the download area":<%= download_url %>.
+    # Extract the release package anywhere you want on your system.
+    # Go inside the extracted directory and run the following command:
+
+      ruby bin/rumai -v
+
+    If the installation was successful, then you will see output like this: <pre><%=h `ruby bin/rumai -v` %></pre>
+
+    Otherwise, you can e-mail the author (see address in <%= xref "License" %>) for help.
+  <% end %>
+
+  <% section "Manifest" do %>
+    Now that Rumai is installed on your system, let us examine its installation directory.
+    * If you installed Rumai manually, then you already know the location of its installation directory.
+    * If you installed Rumai using RubyGems, then run <pre>rumai -v</pre> and select the right-most item in the output--that is the path of Rumai's installation directory.
+
+    Inside Rumai's installation directory, you will see (among other things) the following items:
+    * <tt>bin/</tt> - contains executable programs.
+    ** <tt>rumai</tt> - the interactive shell.
+    * <tt>lib/</tt>
+    ** <tt>rumai.rb</tt> - the main Rumai library.
+    ** <tt>rumai/</tt>
+    *** <tt>ixp.rb</tt> - the pure Ruby client for the "9P2000 protocol":<%= p9p_url %>.
+    * <tt>doc/</tt> - contains the user guide and other documentation.
+    ** <tt>guide.erb</tt> - the source file of this user guide.
+    ** <tt>api/</tt> - contains API reference documentation.
+    * <tt>LICENSE</tt> - the project license and copyright notice.
+  <% end %>
+
+  <% section 'Version numbering system' do %>
+    Rumai uses the "RubyGems rational versioning policy":http://www.rubygems.org/read/chapter/7 to number its releases. This *major.minor.patch* numbering policy "is summarized":http://ablog.apress.com/?p=738 as follows.
+
+    | Version number components: |_. Major |_. Minor |_. Patch |
+    |_. Backwards compatible?    | no      | yes     | yes     |
+    |_. New features?            | yes     | yes     | no      |
+    |_. Bug fixes?               | yes     | yes     | yes     |
+  <% end %>
+<% end %>
+
+<% chapter "Usage" do %>
+  <% section "Concepts" do %>
+    If you wish to wield the power of Rumai more effectively, you should understand the following basic concepts:
+    * A *client* is any graphical program that is running in your X session.  In other words, any *window* in your wmii session is a *client*.
+    * A *tag* is an arbitrary string (a label) that can be associated with one or more clients.
+    * A *view* is a graphical representation of a *tag*.  It shows all clients associated with a particular tag.
+    * An *area* is a region inside a *view*. It contains clients.
+    ** A *managed area* or *column* is a region where clients cannot overlap each other.
+    ** The *floating area* is an area whose clients (1) can overlap each other and (2) _float above_ the managed areas.
+  <% end %>
+
+  <% section "Interactive shell", 'shell' do %>
+    Run the following command to start Rumai's interactive shell (IRB):
+
+      rumai
+
+    You should now see a command prompt like this:
+
+      irb(Rumai):001:0>
+
+    The "irb(*Rumai*)" token in the prompt indicates that commands will be evaluated _inside_ the @Rumai@ module.  As a result, you can omit the "Rumai" prefix from your commands if you wish.
+
+    For example, to get the current client object, you can type @curr_client@ instead of having to type @Rumai.curr_client@ at the prompt.  However, note that both commands both achieve the same effect and are thereby equivalent.
+
+    The next thing to note is that *tab completion* is enabled by default. Consequently, you can type part of a command and press the TAB key to see a list of possible completions.
+
+    Finally, the interactive shell is a standard IRB session.  As a result your <tt>~/.irbrc</tt> file is read and processed by default.  Furthermore, you can pass the standard IRB command-line options to the *rumai* command.
+
+    <% section "Live demonstration" do %>
+      Now that you have a command prompt, let us walk through a quick demonstration that highlights the main features of Rumai.  You can follow along by copying & pasting the presented commands into the interactive shell.
+
+      <%
+        open_terms = %q{
+          Launch a few terminals so that we have something to work with:
+          <code>
+          colors = %w[ red green blue black orange brown gray navy gold ]
+          colors.each {|c| system "xterm -bg #{c} -title #{c} -e read &" }
+          </code>
+        }.gsub(/^\s+/, '')
+
+        close_terms = %q{
+          Close the terminals we launched earlier:
+          <code>
+          terms = curr_view.clients.select {|c| colors.include? c.label.read }
+          terms.each {|c| c.ctl.write "kill" }
+          </code>
+        }.gsub(/^\s+/, '')
+      %>
+
+      <% section "Automated client arrangement" do %>
+        <%= open_terms %>
+
+        Arrange all clients in a grid:
+        <code>
+        curr_view.arrange_in_grid
+        </code>
+
+        Arrange all clients in a diamond shape:
+        <code>
+        curr_view.arrange_in_diamond
+        </code>
+
+        Arrange all clients like LarsWM does:
+        <code>
+        curr_view.arrange_as_larswm
+        </code>
+
+        <%= close_terms %>
+      <% end %>
+
+      <% section "Multiple client grouping" do %>
+        <%= open_terms %>
+
+        Add the red, green, and blue terminals into the "grouping":
+        <code>
+        terms = curr_view.clients.select {|c| %w[red green blue].include? c.label.read }
+        terms.each {|c| c.group }
+        </code>
+
+        You should now see a new button labelled as "<notextile>@</notextile>" on the left-hand side of wmii's bar, indicating that there is now a new view labelled "<notextile>@</notextile>" in wmii. Let us inspect what clients this mysterious view contains:
+        <code>
+        v = View.new "@"
+        puts v.clients.map {|c| c.label.read }
+        </code>
+
+        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.
+
+        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:
+        <code>
+        grouping.each {|c| c.send "toggle" }
+        </code>
+
+        Neat! Let us bring them back into the managed area:
+        <code>
+        grouping.each {|c| c.send "toggle" }
+        </code>
+
+        <%= close_terms %>
+
+        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.
+
+        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.
+      <% end %>
+
+      <% section "Easy column manipulation" do %>
+        <%= open_terms %>
+
+        You can insert a group of clients to the top, bottom, or after the currently focused client of _any_ column using Array-like methods.
+
+        Give each client its own column (one client per column):
+        <code>
+        curr_view.each_column {|c| c.length = 1 }
+        </code>
+
+        Put (at most) three clients in every column:
+        <code>
+        curr_view.each_column {|c| c.length = 3 }
+        </code>
+
+        Move the red, green, and blue clients into the floating area:
+        <code>
+        terms = curr_view.clients.select {|c| %w[red green blue].include? c.label.read }
+        curr_view.areas[0].push terms
+        </code>
+
+        Slurp all floating clients into the last column:
+        <code>
+        list = curr_view.areas
+        a, b = list.first, list.last
+        b.concat a
+        </code>
+
+        Set the last column's layout to stacking mode:
+        <code>
+        b.layout = 'stack'
+        </code>
+
+        Move the red, green, and blue clients to the top of the second column:
+        <code>
+        curr_view.areas[2].unshift terms
+        </code>
+
+        Move the red, green, and blue clients to the bottom of the third column:
+        <code>
+        curr_view.areas[3].push terms
+        </code>
+
+        <%= close_terms %>
+      <% end %>
+
+      <% section "Easy client manipulation" do %>
+        <%= open_terms %>
+
+        Obtain a reference to the red client:
+        <code>
+        red = curr_view.clients.find {|c| c.label.read == "red" }
+        </code>
+
+        Show the red client's current tags:
+        <code>
+        red.tags
+        </code>
+
+        Add the "foo" and "bar" tags to the red client:
+        <code>
+        red.tag "foo", "bar"
+        </code>
+
+        Remove the "bar" tag from the red client:
+        <code>
+        red.untag "bar"
+        </code>
+
+        Do complex operations on the red client's tags:
+        <code>
+        red.with_tags { concat %w[a b c]; push 'z'; delete 'c' }
+        </code>
+
+        Focus the next client after the red client:
+        <code>
+        red.next.focus ; curr_client == red.next #=> true
+        </code>
+
+        Notice that by focusing a client, we make it the current client.
+
+        Focus the red client on a different view:
+        <code>
+        orig = curr_view
+        v = red.views.last
+        red.focus v
+        </code>
+
+        Return to the original view:
+        <code>
+        orig.focus
+        </code>
+
+        Send the red client to the last column:
+        <code>
+        red.send curr_view.areas.last
+        </code>
+
+        <%= close_terms %>
+      <% end %>
+
+      <% section "Traversing the file system" do %>
+        Show the root node of wmii's IXP file system:
+        <code>
+        fs
+        </code>
+
+        Show the names of all files at the root level:
+        <code>
+        fs.entries
+        </code>
+
+        Show the parent of the root node:
+        <code>
+        fs.parent
+        </code>
+
+        Show the children of the root node:
+        <code>
+        fs.children
+        </code>
+
+        Navigate into to the <tt>/lbar/</tt> directory:
+        <code>
+        n1 = fs.lbar
+        n2 = fs['lbar']
+        n1 == n2 #=> true
+        left_bar = n1
+        </code>
+
+        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 @[]@ operator on a node.
+
+        Create a new temporary button:
+        <code>
+        b = left_bar.rumai_example # path of new button
+        b.exist? #=> false
+        b.create
+        b.exist? #=> true
+        </code>
+
+        You should now see an empty button on the left-hand side of the wmii bar.
+
+        Color the button black-on-white and label it as "hello world":
+        <code>
+        content = "#000000 #ffffff #000000 hello world"
+        b.write content
+        b.read == content #=> true
+        </code>
+
+        Remove the temporary button:
+        <code>
+        b.remove
+        b.exist? #=> false
+        </code>
+      <% end %>
+    <% end %>
+
+    <% section "Available commands" do %>
+      The following table lists all methods provided by the @Rumai@ module and its subordinates.  See the "API documentation":api/index.html for more extensive documentation.
+
+      |_. Method declaration |_. Description |
+      <%
+        # load library for parsing method documentation
+        require 'gerbil/rdoc'
+
+        Dir['lib/rumai/*.rb'].each do |f|
+          RDoc::TopLevel.parse_file f
+        end
+
+        RDoc::TopLevel.all_methods.sort_by {|m| m.full_name }.each do |m|
+      %>
+      | <code><%= m.decl %></code> | <noformat><%= m.comment_html %></noformat> |
+      <% end %>
+    <% end %>
+  <% end %>
+
+  <% section "Scripting your wmiirc", 'wmiirc' do %>
+    One important application of Rumai is the support of Ruby-based <tt>wmiirc</tt> configuration files. For a solid example of such application, take a look at my personal <tt>wmiirc</tt> which uses Rumai extensively:
+
+      darcs get http://snk.tuxfamily.org/src/wmiirc
+
+    Alternatively, you can "browse the contents of the above repository":http://snk.tuxfamily.org/src/wmiirc in your web browser.
+  <% end %>
+<% end %>

data/doc/guide.html

@@ -0,0 +1,2035 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html>
+  <head>
+    <meta http-equiv="content-type" content="text/html; charset=utf-8"/>
+    <meta name="date" content="26 January 2008"/>
+    <meta name="author" content="Suraj N. Kurapati"/>
+    <meta name="generator" content="Gerbil 1.1.0"/>
+    <link rel="alternate" type="application/rss+xml" href="http://rumai.rubyforge.org/news.xml"/>
+    <title>Rumai 1.0.0 user guide</title>
+
+    <style type="text/css" media="screen">
+      body
+{
+  color              : #000000;
+  background-color   : #FFFFFF;
+  line-height        : 1.5em;
+  font-family        : Calibri, Verdana, sans-serif;
+}
+
+/* emphasis */
+
+  em,
+  blockquote
+  {
+    font-family      : Cambria, Georgia, serif;
+  }
+
+/* headings */
+
+  h1,
+  h2,
+  h3,
+  h4,
+  h5,
+  h6,
+  .title
+  {
+    font-weight      : lighter;
+    font-family      : Constantia, "Book Antiqua", "URW Bookman L", serif;
+  }
+
+  #lof h1,
+  #lof h2,
+  #lof h3,
+  #lof h4,
+  #lof h5,
+  #lof h6
+  {
+    margin-top       : 1.25em;
+  }
+
+  #content h1,
+  #content h2,
+  #content h3,
+  #content h4,
+  #content h5,
+  #content h6
+  {
+    margin-top       : 2.5em;
+    line-height      : 1.25em;
+  }
+
+  #content h1
+  {
+    font-size        : 2.0em;
+  }
+
+  #content h2
+  {
+    font-size        : 1.8em;
+  }
+
+  #content h3
+  {
+    font-size        : 1.6em;
+  }
+
+  #content h4
+  {
+    font-size        : 1.4em;
+  }
+
+  #content h5
+  {
+    font-size        : 1.2em;
+  }
+
+  #content h6
+  {
+    font-size        : 1.0em;
+  }
+
+/* tables */
+
+  table
+  {
+    border           : none;
+    margin           : auto; /* center horizontally */
+    margin-top       : 1em;
+  }
+
+  th,
+  td
+  {
+    padding          : 1em;
+    border           : 1px solid #C0C0C0;
+    vertical-align   : top;
+    background-color : #FFFFFF;
+  }
+
+  th
+  {
+    background-color : #F5F5F5;
+  }
+
+/* document structure */
+
+  #header
+  {
+    margin-bottom    : 5em;
+    text-align       : center;
+  }
+
+  #abstract
+  {
+    margin-bottom    : 5em;
+  }
+
+  #toc li
+  {
+    list-style-type  : none;
+  }
+
+  #toc li ul
+  {
+    padding-bottom   : 1em;
+    border-left      : thick solid #F5F5F5;
+    _border-left     : none; /* for IE6 */
+  }
+
+  #toc li ul:hover
+  {
+    border-color     : #DCDCDC;
+  }
+
+  #toc > ul
+  {
+    padding-left     : 1em;
+  }
+
+  #references
+  {
+    margin-top       : 5em;
+  }
+
+  #footer
+  {
+    border-top       : thick dotted #DCDCDC;
+    padding-top      : 1em;
+    margin-top       : 5em;
+    text-align       : center;
+  }
+
+/* document nodes */
+
+  .part    > .title,
+  .chapter > .title
+  {
+    padding-bottom   : 0.5em;
+  }
+
+  .part    > .title > big,
+  .chapter > .title > big
+  {
+    display          : block;
+    margin-top       : 0.25em;
+  }
+
+  .part    .title big,
+  .chapter .title big
+  {
+    _display         : block; /* for IE6 */
+    _margin-top      : 0.25em; /* for IE6 */
+    _margin-bottom   : 0.75em; /* for IE6 */
+  }
+
+  .paragraph > .title,
+  .tip       > .title,
+  .note      > .title,
+  .caution   > .title,
+  .warning   > .title,
+  .important > .title,
+  .figure    > .title,
+  .table     > .title,
+  .example   > .title,
+  .equation  > .title,
+  .procedure > .title
+  {
+    font-size        : large;
+    margin-top       : 2em;
+  }
+
+  .paragraph .title,
+  .tip       .title,
+  .note      .title,
+  .caution   .title,
+  .warning   .title,
+  .important .title,
+  .figure    .title,
+  .table     .title,
+  .example   .title,
+  .equation  .title,
+  .procedure .title
+  {
+    _font-size       : large; /* for IE6 */
+    _font-weight     : bold; /* large is not bold in IE6 */
+    _margin-top      : 2em; /* for IE6 */
+  }
+
+  .tip      ,
+  .note     ,
+  .caution  ,
+  .warning  ,
+  .important,
+  .figure   ,
+  .table    ,
+  .example  ,
+  .equation ,
+  .procedure
+  {
+    margin           : 3em;
+  }
+
+  .tip       > .icon,
+  .note      > .icon,
+  .caution   > .icon,
+  .warning   > .icon,
+  .important > .icon
+  {
+    float            : left;
+    margin           : 0 1em 1em 0; /* top right bottom left */
+  }
+
+  .tip       .icon,
+  .note      .icon,
+  .caution   .icon,
+  .warning   .icon,
+  .important .icon
+  {
+    _display         : none; /* IE6 cannot display embedded images */
+  }
+
+  .figure > .title
+  {
+    text-align       : center;
+  }
+
+  .figure .title
+  {
+    _text-align      : center; /* for IE6 */
+  }
+
+  .figure > .content img
+  {
+    display          : block;
+    margin           : auto;
+  }
+
+  .figure .content img
+  {
+    _display         : block; /* for IE6 */
+    _margin          : auto; /* for IE6 */
+  }
+
+      body
+{
+  margin             : auto;
+  padding            : 0.5em;
+  max-width          : 36em;
+}
+
+/* hyperlinks */
+
+  a
+  {
+    color            : #0000FF;
+    text-decoration  : none;
+  }
+
+  a:visited
+  {
+    color            : #800080;
+  }
+
+  a:hover
+  {
+    color            : #FF0000;
+    text-decoration  : underline;
+  }
+
+  a:target
+  {
+    color            : #FF0000;
+    text-decoration  : underline;
+  }
+
+  a.toc:link,
+  a.toc:visited
+  {
+    text-decoration  : none;
+    z-index          : 1;
+  }
+
+  a img
+  {
+    border           : none;
+  }
+
+  /*
+    mark external links with a symbol to help the user
+    distinguish between internal and external links
+  */
+  a:after
+  {
+    content: "∗";
+  }
+
+  a[href^="#"]:after
+  {
+    content: "";
+  }
+
+/* source code */
+
+  tt,
+  code,
+  pre
+  {
+    font-family      : Consolas, "Lucida Console", monospace;
+  }
+
+  tt
+  {
+    font-weight      : bold;
+    color            : #A52A2A;
+    background-color : #FFFAF0;
+  }
+
+  /* output of syntax colorizer */
+  .code
+  {
+    background-color : #FFFFF0;
+  }
+
+  pre
+  {
+    line-height      : normal;
+    border           : 1px dashed #C0C0C0;
+    background-color : #F5FFDF;
+    padding          : 1em;
+    overflow         : auto;
+    cursor           : text;
+  }
+
+  /*
+  pre:hover
+  {
+    border           : none;
+    position         : fixed;
+    z-index          : 1;
+    margin           : 0;
+    top              : 0;
+    left             : 0;
+    right            : 0;
+    bottom           : 0;
+    overflow         : auto;
+    cursor           : text;
+  }
+  */
+
+/* emphasis */
+
+  blockquote
+  {
+    margin           : 1em;
+    border           : 5px dotted #C0C0C0;
+    padding          : 1em;
+    color            : #444;
+  }
+
+  hr
+  {
+    color            : #FF0000; /* for IE6 */
+    background-color : #FF0000; /* for Firefox */
+  }
+
+    </style>
+    <style type="text/css" media="print">
+      body
+{
+  color              : #000000;
+  background-color   : #FFFFFF;
+  line-height        : 1.5em;
+  font-family        : Calibri, Verdana, sans-serif;
+}
+
+/* emphasis */
+
+  em,
+  blockquote
+  {
+    font-family      : Cambria, Georgia, serif;
+  }
+
+/* headings */
+
+  h1,
+  h2,
+  h3,
+  h4,
+  h5,
+  h6,
+  .title
+  {
+    font-weight      : lighter;
+    font-family      : Constantia, "Book Antiqua", "URW Bookman L", serif;
+  }
+
+  #lof h1,
+  #lof h2,
+  #lof h3,
+  #lof h4,
+  #lof h5,
+  #lof h6
+  {
+    margin-top       : 1.25em;
+  }
+
+  #content h1,
+  #content h2,
+  #content h3,
+  #content h4,
+  #content h5,
+  #content h6
+  {
+    margin-top       : 2.5em;
+    line-height      : 1.25em;
+  }
+
+  #content h1
+  {
+    font-size        : 2.0em;
+  }
+
+  #content h2
+  {
+    font-size        : 1.8em;
+  }
+
+  #content h3
+  {
+    font-size        : 1.6em;
+  }
+
+  #content h4
+  {
+    font-size        : 1.4em;
+  }
+
+  #content h5
+  {
+    font-size        : 1.2em;
+  }
+
+  #content h6
+  {
+    font-size        : 1.0em;
+  }
+
+/* tables */
+
+  table
+  {
+    border           : none;
+    margin           : auto; /* center horizontally */
+    margin-top       : 1em;
+  }
+
+  th,
+  td
+  {
+    padding          : 1em;
+    border           : 1px solid #C0C0C0;
+    vertical-align   : top;
+    background-color : #FFFFFF;
+  }
+
+  th
+  {
+    background-color : #F5F5F5;
+  }
+
+/* document structure */
+
+  #header
+  {
+    margin-bottom    : 5em;
+    text-align       : center;
+  }
+
+  #abstract
+  {
+    margin-bottom    : 5em;
+  }
+
+  #toc li
+  {
+    list-style-type  : none;
+  }
+
+  #toc li ul
+  {
+    padding-bottom   : 1em;
+    border-left      : thick solid #F5F5F5;
+    _border-left     : none; /* for IE6 */
+  }
+
+  #toc li ul:hover
+  {
+    border-color     : #DCDCDC;
+  }
+
+  #toc > ul
+  {
+    padding-left     : 1em;
+  }
+
+  #references
+  {
+    margin-top       : 5em;
+  }
+
+  #footer
+  {
+    border-top       : thick dotted #DCDCDC;
+    padding-top      : 1em;
+    margin-top       : 5em;
+    text-align       : center;
+  }
+
+/* document nodes */
+
+  .part    > .title,
+  .chapter > .title
+  {
+    padding-bottom   : 0.5em;
+  }
+
+  .part    > .title > big,
+  .chapter > .title > big
+  {
+    display          : block;
+    margin-top       : 0.25em;
+  }
+
+  .part    .title big,
+  .chapter .title big
+  {
+    _display         : block; /* for IE6 */
+    _margin-top      : 0.25em; /* for IE6 */
+    _margin-bottom   : 0.75em; /* for IE6 */
+  }
+
+  .paragraph > .title,
+  .tip       > .title,
+  .note      > .title,
+  .caution   > .title,
+  .warning   > .title,
+  .important > .title,
+  .figure    > .title,
+  .table     > .title,
+  .example   > .title,
+  .equation  > .title,
+  .procedure > .title
+  {
+    font-size        : large;
+    margin-top       : 2em;
+  }
+
+  .paragraph .title,
+  .tip       .title,
+  .note      .title,
+  .caution   .title,
+  .warning   .title,
+  .important .title,
+  .figure    .title,
+  .table     .title,
+  .example   .title,
+  .equation  .title,
+  .procedure .title
+  {
+    _font-size       : large; /* for IE6 */
+    _font-weight     : bold; /* large is not bold in IE6 */
+    _margin-top      : 2em; /* for IE6 */
+  }
+
+  .tip      ,
+  .note     ,
+  .caution  ,
+  .warning  ,
+  .important,
+  .figure   ,
+  .table    ,
+  .example  ,
+  .equation ,
+  .procedure
+  {
+    margin           : 3em;
+  }
+
+  .tip       > .icon,
+  .note      > .icon,
+  .caution   > .icon,
+  .warning   > .icon,
+  .important > .icon
+  {
+    float            : left;
+    margin           : 0 1em 1em 0; /* top right bottom left */
+  }
+
+  .tip       .icon,
+  .note      .icon,
+  .caution   .icon,
+  .warning   .icon,
+  .important .icon
+  {
+    _display         : none; /* IE6 cannot display embedded images */
+  }
+
+  .figure > .title
+  {
+    text-align       : center;
+  }
+
+  .figure .title
+  {
+    _text-align      : center; /* for IE6 */
+  }
+
+  .figure > .content img
+  {
+    display          : block;
+    margin           : auto;
+  }
+
+  .figure .content img
+  {
+    _display         : block; /* for IE6 */
+    _margin          : auto; /* for IE6 */
+  }
+
+      /* headings */
+
+  h1,
+  h2,
+  h3,
+  h4,
+  h5,
+  h6
+  {
+    font-weight      : normal;
+  }
+
+/* hyperlinks */
+
+  a:link,
+  a:visited,
+  a:active
+  {
+    color            : #0000FF;
+    font-weight      : bold;
+    text-decoration  : underline;
+  }
+
+  a:after
+  {
+    content          : " (" attr(href) ")";
+    font-family      : sans-serif;
+    font-weight      : normal;
+    font-size        : 90%;
+  }
+
+  a[href^="#"]:after
+  {
+    content          : "";
+  }
+
+  a[href^="#"]
+  {
+    color            : #A52A2A;
+    font-weight      : lighter;
+    text-decoration  : none;
+    font-style       : italic;
+  }
+
+  a.toc:link,
+  a.toc:visited
+  {
+    color            : inherit;
+    .color           : #000000; /* for IE6 and IE7 */
+    font-weight      : inherit;
+    text-decoration  : none;
+    font-style       : normal;
+  }
+
+/* source code */
+
+  tt
+  {
+    color            : inherit;
+    background-color : inherit;
+    font-weight      : normal;
+  }
+
+  pre,
+  .code
+  {
+    border           : none;
+    overflow         : visible;
+    background-color : inherit;
+  }
+
+/* document structure */
+
+  #lof
+  {
+    display          : none;
+  }
+
+/* document nodes */
+
+  .part    > .title > big,
+  .chapter > .title > big
+  {
+    padding-bottom   : 0.5em;
+  }
+
+  .part    .title big,
+  .chapter .title big
+  {
+    _padding-bottom  : 0.5em; /* for IE6 */
+  }
+
+    </style>
+  </head>
+  <body>
+    <div id="header">
+      
+      <h1 class="title">Rumai 1.0.0 user guide</h1>
+      <h2 class="authors"><a href="http://snk.tuxfamily.org">Suraj N. Kurapati</a></h2>
+      <h3 class="date">26 January 2008</h3>
+    </div>
+
+
+    <div id="toc"><h1>Contents</h1> <ul><li>1&nbsp;&nbsp;<a id="a-606956178" href="#Introduction">Introduction</a><ul><li>1.1&nbsp;&nbsp;<a id="a-606960438" href="#Resources">Resources</a></li><li>1.2&nbsp;&nbsp;<a id="a-606963908" href="#License">License</a></li></ul></li><li>2&nbsp;&nbsp;<a id="a-606966618" href="#Setup">Setup</a><ul><li>2.1&nbsp;&nbsp;<a id="a-606968098" href="#Requirements">Requirements</a></li><li>2.2&nbsp;&nbsp;<a id="a-606970128" href="#Installation">Installation</a></li><li>2.3&nbsp;&nbsp;<a id="a-606973738" href="#Manifest">Manifest</a></li><li>2.4&nbsp;&nbsp;<a id="a-606975918" href="#Version-numbering-system">Version numbering system</a></li></ul></li><li>3&nbsp;&nbsp;<a id="a-606978438" href="#Usage">Usage</a><ul><li>3.1&nbsp;&nbsp;<a id="a-606979948" href="#Concepts">Concepts</a></li><li>3.2&nbsp;&nbsp;<a id="a-606981988" href="#shell">Interactive shell</a><ul><li>3.2.1&nbsp;&nbsp;<a id="a-606983728" href="#Live-demonstration">Live demonstration</a><ul><li>3.2.1.1&nbsp;&nbsp;<a id="a-606985418" href="#Automated-client-arrangement">Automated client arrangement</a></li><li>3.2.1.2&nbsp;&nbsp;<a id="a-606092078" href="#Multiple-client-grouping">Multiple client grouping</a></li><li>3.2.1.3&nbsp;&nbsp;<a id="a-606113088" href="#Easy-column-manipulation">Easy column manipulation</a></li><li>3.2.1.4&nbsp;&nbsp;<a id="a-606129268" href="#Easy-client-manipulation">Easy client manipulation</a></li><li>3.2.1.5&nbsp;&nbsp;<a id="a-606134168" href="#Traversing-the-file-system">Traversing the file system</a></li></ul></li><li>3.2.2&nbsp;&nbsp;<a id="a-606141278" href="#Available-commands">Available commands</a></li></ul></li><li>3.3&nbsp;&nbsp;<a id="a-607083858" href="#wmiirc">Scripting your wmiirc</a></li></ul></li></ul></div>
+
+    
+
+    <div id="content">
+<div class="chapter">
+  <h1 class="title">
+    Chapter
+    <a class="toc" id="Introduction" href="#a-606956178">1</a>
+
+    <br/>
+
+    <big>Introduction</big>
+  </h1>
+
+  <div class="content"><p>Rumai is a library for manipulating the <a href="http://www.suckless.org/wiki/wmii">wmii</a> window manager through <a href="http://ruby-lang.org">Ruby</a>. It excels at <strong>dynamic arrangement</strong> of clients, columns, views, and tags.</p>
+
+
+	<p>Rumai also provides (1) an <a class="xref" href="#shell">interactive shell</a> for live entertainment, and (2) a <strong>pure Ruby client</strong> for the <a href="http://cm.bell-labs.com/magic/man2html/5/intro">9P2000 protocol</a>, which it uses to communicate with wmii&#8217;s <a href="http://www.suckless.org/wiki/libs/libixp">IXP file-system interface</a>.</p>
+
+
+	<p>Rumai is <strong>open-source software</strong> (see <a class="xref" href="#License">Section 1.2: <em>License</em></a>) so feel free to contribute your improvements to and discuss your ideas with the author. You can obtain the source code from the project <a href="http://darcs.net">Darcs</a> repository by running the following command:</p>
+
+
+	<pre>darcs get http://rumai.rubyforge.org/src rumai</pre>
+
+
+	<p><div class="section">
+  <h2 class="title">
+    <a class="toc" id="Resources" href="#a-606960438">1.1</a>&nbsp;&nbsp;Resources
+  </h2>
+  <div class="content"><ul>
+	<li><a href="http://rumai.rubyforge.org/news.xml">News feed</a>
+  &#8211; project news and release announcements.</li>
+		<li><a href="http://rubyforge.org/frs/?group_id=5005">Download area</a>
+  &#8211; place to obtain release packages.</li>
+		<li><a href="api/index.html">API reference</a>
+  &#8211; documentation for all provided Ruby code.</li>
+		<li>Support / feedback
+  &#8211; send an e-mail to the author (see address in <a class="xref" href="#License">Section 1.2: <em>License</em></a>).</li>
+	</ul></div>
+</div>
+<div class="section">
+  <h2 class="title">
+    <a class="toc" id="License" href="#a-606963908">1.2</a>&nbsp;&nbsp;License
+  </h2>
+  <div class="content"><p>Copyright 2006 Suraj N. Kurapati &lt;SNK at GNA dot ORG&gt;</p>
+
+
+	<p>Permission is hereby granted, free of charge, to any person obtaining a
+copy of this software and associated documentation files (the &quot;Software&quot;),
+to deal in the Software without restriction, including without limitation
+the rights to use, copy, modify, merge, publish, distribute, sublicense,
+and/or sell copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following conditions:</p>
+
+
+	<ul>
+	<li>All copies and substantial portions of the Software (the &quot;Derivatives&quot;)
+and their corresponding machine-readable source code (the &quot;Code&quot;) must
+include the above copyright notice and this permission notice.</li>
+	</ul>
+
+
+	<ul>
+	<li>Upon distribution, the Derivatives must be accompanied either by the Code
+or&mdash;provided that the Code is obtainable for no more than the cost of
+distribution plus a nominal fee&mdash;by information on how to obtain the Code.</li>
+	</ul>
+
+
+	<p><span class="caps">THE SOFTWARE IS PROVIDED</span> &quot;AS IS&quot;, <span class="caps">WITHOUT WARRANTY OF ANY KIND</span>, EXPRESS OR
+IMPLIED, INCLUDING <span class="caps">BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY</span>, FITNESS
+<span class="caps">FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT</span>. IN <span class="caps">NO EVENT SHALL THE AUTHORS OR</span>
+<span class="caps">COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM</span>, DAMAGES <span class="caps">OR OTHER LIABILITY</span>, WHETHER
+<span class="caps">IN AN ACTION OF CONTRACT</span>, TORT <span class="caps">OR OTHERWISE</span>, ARISING FROM, OUT <span class="caps">OF OR IN</span>
+<span class="caps">CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE</span>.</p></div>
+</div></p></div>
+</div>
+<div class="chapter">
+  <h1 class="title">
+    Chapter
+    <a class="toc" id="Setup" href="#a-606966618">2</a>
+
+    <br/>
+
+    <big>Setup</big>
+  </h1>
+
+  <div class="content"><div class="section">
+  <h2 class="title">
+    <a class="toc" id="Requirements" href="#a-606968098">2.1</a>&nbsp;&nbsp;Requirements
+  </h2>
+  <div class="content">Your system needs the following software to run Rumai.
+
+
+	<table border="1">
+		<tr>
+			<th>Software </th>
+			<th>Notes </th>
+		</tr>
+		<tr>
+			<td> <a href="http://ruby-lang.org">Ruby</a> </td>
+			<td> Version 1.8.x is required. </td>
+		</tr>
+		<tr>
+			<td> <a href="http://www.suckless.org/wiki/wmii">wmii</a> </td>
+			<td> wmii-snap20070516 or newer is required. </td>
+		</tr>
+	</table></div>
+</div>
+<div class="section">
+  <h2 class="title">
+    <a class="toc" id="Installation" href="#a-606970128">2.2</a>&nbsp;&nbsp;Installation
+  </h2>
+  <div class="content"><p>If your system has <a href="http://rubygems.org/">RubyGems</a>, then you can install Rumai by running the following commands:</p>
+
+
+	<pre>gem install rumai
+rumai -v</pre>
+
+
+Otherwise, follow these instructions:
+	<ol>
+	<li>Download the newest release package from <a href="http://rubyforge.org/frs/?group_id=5005">the download area</a>.</li>
+		<li>Extract the release package anywhere you want on your system.</li>
+		<li>Go inside the extracted directory and run the following command:</li>
+	</ol>
+
+
+	<pre>ruby bin/rumai -v</pre>
+
+
+	<p>If the installation was successful, then you will see output like this: <pre>Rumai 1.0.0 (2008-01-26) http://rumai.rubyforge.org /home/sun/src/rumai
+</pre></p>
+
+
+	<p>Otherwise, you can e-mail the author (see address in <a class="xref" href="#License">Section 1.2: <em>License</em></a>) for help.</p></div>
+</div>
+<div class="section">
+  <h2 class="title">
+    <a class="toc" id="Manifest" href="#a-606973738">2.3</a>&nbsp;&nbsp;Manifest
+  </h2>
+  <div class="content">Now that Rumai is installed on your system, let us examine its installation directory.
+	<ul>
+	<li>If you installed Rumai manually, then you already know the location of its installation directory.</li>
+		<li>If you installed Rumai using RubyGems, then run <pre>rumai -v</pre> and select the right-most item in the output&mdash;that is the path of Rumai&#8217;s installation directory.</li>
+	</ul>
+
+
+Inside Rumai&#8217;s installation directory, you will see (among other things) the following items:
+	<ul>
+	<li><tt>bin/</tt> &#8211; contains executable programs.
+	<ul>
+	<li><tt>rumai</tt> &#8211; the interactive shell.</li>
+	</ul>
+	</li>
+		<li><tt>lib/</tt>
+	<ul>
+	<li><tt>rumai.rb</tt> &#8211; the main Rumai library.</li>
+		<li><tt>rumai/</tt>
+	<ul>
+	<li><tt>ixp.rb</tt> &#8211; the pure Ruby client for the <a href="http://cm.bell-labs.com/magic/man2html/5/intro">9P2000 protocol</a>.</li>
+	</ul>
+	</li>
+	</ul>
+	</li>
+		<li><tt>doc/</tt> &#8211; contains the user guide and other documentation.
+	<ul>
+	<li><tt>guide.erb</tt> &#8211; the source file of this user guide.</li>
+		<li><tt>api/</tt> &#8211; contains API reference documentation.</li>
+	</ul>
+	</li>
+		<li><tt>LICENSE</tt> &#8211; the project license and copyright notice.</li>
+	</ul></div>
+</div>
+<div class="section">
+  <h2 class="title">
+    <a class="toc" id="Version-numbering-system" href="#a-606975918">2.4</a>&nbsp;&nbsp;Version numbering system
+  </h2>
+  <div class="content">Rumai uses the <a href="http://www.rubygems.org/read/chapter/7">RubyGems rational versioning policy</a> to number its releases. This <strong>major.minor.patch</strong> numbering policy <a href="http://ablog.apress.com/?p=738">is summarized</a> as follows.
+
+
+	<table border="1">
+		<tr>
+			<td> Version number components: </td>
+			<th>Major </th>
+			<th>Minor </th>
+			<th>Patch </th>
+		</tr>
+		<tr>
+			<th>Backwards compatible?    </th>
+			<td> no      </td>
+			<td> yes     </td>
+			<td> yes     </td>
+		</tr>
+		<tr>
+			<th>New features?            </th>
+			<td> yes     </td>
+			<td> yes     </td>
+			<td> no      </td>
+		</tr>
+		<tr>
+			<th>Bug fixes?               </th>
+			<td> yes     </td>
+			<td> yes     </td>
+			<td> yes     </td>
+		</tr>
+	</table></div>
+</div></div>
+</div>
+<div class="chapter">
+  <h1 class="title">
+    Chapter
+    <a class="toc" id="Usage" href="#a-606978438">3</a>
+
+    <br/>
+
+    <big>Usage</big>
+  </h1>
+
+  <div class="content"><div class="section">
+  <h2 class="title">
+    <a class="toc" id="Concepts" href="#a-606979948">3.1</a>&nbsp;&nbsp;Concepts
+  </h2>
+  <div class="content">If you wish to wield the power of Rumai more effectively, you should understand the following basic concepts:
+	<ul>
+	<li>A <strong>client</strong> is any graphical program that is running in your X session.  In other words, any <strong>window</strong> in your wmii session is a <strong>client</strong>.</li>
+		<li>A <strong>tag</strong> is an arbitrary string (a label) that can be associated with one or more clients.</li>
+		<li>A <strong>view</strong> is a graphical representation of a <strong>tag</strong>.  It shows all clients associated with a particular tag.</li>
+		<li>An <strong>area</strong> is a region inside a <strong>view</strong>. It contains clients.
+	<ul>
+	<li>A <strong>managed area</strong> or <strong>column</strong> is a region where clients cannot overlap each other.</li>
+		<li>The <strong>floating area</strong> is an area whose clients (1) can overlap each other and (2) <em>float above</em> the managed areas.</li>
+	</ul></li>
+	</ul></div>
+</div>
+<div class="section">
+  <h2 class="title">
+    <a class="toc" id="shell" href="#a-606981988">3.2</a>&nbsp;&nbsp;Interactive shell
+  </h2>
+  <div class="content"><p>Run the following command to start Rumai&#8217;s interactive shell (IRB):</p>
+
+
+	<pre>rumai</pre>
+
+
+	<p>You should now see a command prompt like this:</p>
+
+
+	<pre>irb(Rumai):001:0&gt;</pre>
+
+
+	<p>The &#8220;irb(<strong>Rumai</strong>)&#8221; token in the prompt indicates that commands will be evaluated <em>inside</em> the <code class="code"><span style="color:#036; font-weight:bold">Rumai</span></code> module.  As a result, you can omit the &#8220;Rumai&#8221; prefix from your commands if you wish.</p>
+
+
+	<p>For example, to get the current client object, you can type <code class="code">curr_client</code> instead of having to type <code class="code"><span style="color:#036; font-weight:bold">Rumai</span>.curr_client</code> at the prompt.  However, note that both commands both achieve the same effect and are thereby equivalent.</p>
+
+
+	<p>The next thing to note is that <strong>tab completion</strong> is enabled by default. Consequently, you can type part of a command and press the TAB key to see a list of possible completions.</p>
+
+
+	<p>Finally, the interactive shell is a standard IRB session.  As a result your <tt>~/.irbrc</tt> file is read and processed by default.  Furthermore, you can pass the standard IRB command-line options to the <strong>rumai</strong> command.</p>
+
+
+	<p><div class="section">
+  <h3 class="title">
+    <a class="toc" id="Live-demonstration" href="#a-606983728">3.2.1</a>&nbsp;&nbsp;Live demonstration
+  </h3>
+  <div class="content"><p>Now that you have a command prompt, let us walk through a quick demonstration that highlights the main features of Rumai.  You can follow along by copying &#38; pasting the presented commands into the interactive shell.</p>
+
+
+	<p><div class="section">
+  <h4 class="title">
+    <a class="toc" id="Automated-client-arrangement" href="#a-606985418">3.2.1.1</a>&nbsp;&nbsp;Automated client arrangement
+  </h4>
+  <div class="content"><p>Launch a few terminals so that we have something to work with:
+<pre class="code">
+colors = <span style="background-color:#fff0f0"><span style="color:#710">%w[</span><span style="color:#D20"> red green blue black orange brown gray navy gold </span><span style="color:#710">]</span></span>
+colors.each {|c| system <span style="background-color:#fff0f0"><span style="color:#710">&quot;</span><span style="color:#D20">xterm -bg </span><span style="background: #eee"><span style="font-weight: bold; color: #888">#{</span>c<span style="font-weight: bold; color: #888">}</span></span><span style="color:#D20"> -title </span><span style="background: #eee"><span style="font-weight: bold; color: #888">#{</span>c<span style="font-weight: bold; color: #888">}</span></span><span style="color:#D20"> -e read &amp;</span><span style="color:#710">&quot;</span></span> }
+</pre></p>
+
+
+	<p>Arrange all clients in a grid:
+<pre class="code">
+curr_view.arrange_in_grid
+</pre></p>
+
+
+	<p>Arrange all clients in a diamond shape:
+<pre class="code">
+curr_view.arrange_in_diamond
+</pre></p>
+
+
+	<p>Arrange all clients like LarsWM does:
+<pre class="code">
+curr_view.arrange_as_larswm
+</pre></p>
+
+
+	<p>Close the terminals we launched earlier:
+<pre class="code">
+terms = curr_view.clients.select {|c| colors.include? c.label.read }
+terms.each {|c| c.ctl.write <span style="background-color:#fff0f0"><span style="color:#710">&quot;</span><span style="color:#D20">kill</span><span style="color:#710">&quot;</span></span> }
+</pre></p></div>
+</div>
+<div class="section">
+  <h4 class="title">
+    <a class="toc" id="Multiple-client-grouping" href="#a-606092078">3.2.1.2</a>&nbsp;&nbsp;Multiple client grouping
+  </h4>
+  <div class="content"><p>Launch a few terminals so that we have something to work with:
+<pre class="code">
+colors = <span style="background-color:#fff0f0"><span style="color:#710">%w[</span><span style="color:#D20"> red green blue black orange brown gray navy gold </span><span style="color:#710">]</span></span>
+colors.each {|c| system <span style="background-color:#fff0f0"><span style="color:#710">&quot;</span><span style="color:#D20">xterm -bg </span><span style="background: #eee"><span style="font-weight: bold; color: #888">#{</span>c<span style="font-weight: bold; color: #888">}</span></span><span style="color:#D20"> -title </span><span style="background: #eee"><span style="font-weight: bold; color: #888">#{</span>c<span style="font-weight: bold; color: #888">}</span></span><span style="color:#D20"> -e read &amp;</span><span style="color:#710">&quot;</span></span> }
+</pre></p>
+
+
+	<p>Add the red, green, and blue terminals into the &#8220;grouping&#8221;:
+<pre class="code">
+terms = curr_view.clients.select {|c| <span style="background-color:#fff0f0"><span style="color:#710">%w[</span><span style="color:#D20">red green blue</span><span style="color:#710">]</span></span>.include? c.label.read }
+terms.each {|c| c.group }
+</pre></p>
+
+
+	<p>You should now see a new button labelled as &#8220;@&#8221; on the left-hand side of wmii&#8217;s bar, indicating that there is now a new view labelled &#8220;@&#8221; in wmii. Let us inspect what clients this mysterious view contains:
+<pre class="code">
+v = <span style="color:#036; font-weight:bold">View</span>.new <span style="background-color:#fff0f0"><span style="color:#710">&quot;</span><span style="color:#D20">@</span><span style="color:#710">&quot;</span></span>
+puts v.clients.map {|c| c.label.read }
+</pre></p>
+
+
+	<p>Aha! The mysterious view contains the red, green, and blue clients we recently &#8220;grouped&#8221;. Thus, by adding a client to the &#8220;grouping&#8221;, we are simply tagging the client with the &#8221;@&#8221; token.</p>
+
+
+	<p>Now that we have put some clients into the &#8220;grouping&#8221;, let us move all clients in the grouping to the floating area in the current view:
+<pre class="code">
+grouping.each {|c| c.send <span style="background-color:#fff0f0"><span style="color:#710">&quot;</span><span style="color:#D20">toggle</span><span style="color:#710">&quot;</span></span> }
+</pre></p>
+
+
+	<p>Neat! Let us bring them back into the managed area:
+<pre class="code">
+grouping.each {|c| c.send <span style="background-color:#fff0f0"><span style="color:#710">&quot;</span><span style="color:#D20">toggle</span><span style="color:#710">&quot;</span></span> }
+</pre></p>
+
+
+	<p>Close the terminals we launched earlier:
+<pre class="code">
+terms = curr_view.clients.select {|c| colors.include? c.label.read }
+terms.each {|c| c.ctl.write <span style="background-color:#fff0f0"><span style="color:#710">&quot;</span><span style="color:#D20">kill</span><span style="color:#710">&quot;</span></span> }
+</pre></p>
+
+
+	<p>In summary, you can select multiple clients (by adding them to the &#8220;grouping&#8221;) 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></div>
+</div>
+<div class="section">
+  <h4 class="title">
+    <a class="toc" id="Easy-column-manipulation" href="#a-606113088">3.2.1.3</a>&nbsp;&nbsp;Easy column manipulation
+  </h4>
+  <div class="content"><p>Launch a few terminals so that we have something to work with:
+<pre class="code">
+colors = <span style="background-color:#fff0f0"><span style="color:#710">%w[</span><span style="color:#D20"> red green blue black orange brown gray navy gold </span><span style="color:#710">]</span></span>
+colors.each {|c| system <span style="background-color:#fff0f0"><span style="color:#710">&quot;</span><span style="color:#D20">xterm -bg </span><span style="background: #eee"><span style="font-weight: bold; color: #888">#{</span>c<span style="font-weight: bold; color: #888">}</span></span><span style="color:#D20"> -title </span><span style="background: #eee"><span style="font-weight: bold; color: #888">#{</span>c<span style="font-weight: bold; color: #888">}</span></span><span style="color:#D20"> -e read &amp;</span><span style="color:#710">&quot;</span></span> }
+</pre></p>
+
+
+	<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):
+<pre class="code">
+curr_view.each_column {|c| c.length = <span style="color:#00D; font-weight:bold">1</span> }
+</pre></p>
+
+
+	<p>Put (at most) three clients in every column:
+<pre class="code">
+curr_view.each_column {|c| c.length = <span style="color:#00D; font-weight:bold">3</span> }
+</pre></p>
+
+
+	<p>Move the red, green, and blue clients into the floating area:
+<pre class="code">
+terms = curr_view.clients.select {|c| <span style="background-color:#fff0f0"><span style="color:#710">%w[</span><span style="color:#D20">red green blue</span><span style="color:#710">]</span></span>.include? c.label.read }
+curr_view.areas[<span style="color:#00D; font-weight:bold">0</span>].push terms
+</pre></p>
+
+
+	<p>Slurp all floating clients into the last column:
+<pre class="code">
+list = curr_view.areas
+a, b = list.first, list.last
+b.concat a
+</pre></p>
+
+
+	<p>Set the last column&#8217;s layout to stacking mode:
+<pre class="code">
+b.layout = <span style="background-color:#fff0f0"><span style="color:#710">'</span><span style="color:#D20">stack</span><span style="color:#710">'</span></span>
+</pre></p>
+
+
+	<p>Move the red, green, and blue clients to the top of the second column:
+<pre class="code">
+curr_view.areas[<span style="color:#00D; font-weight:bold">2</span>].unshift terms
+</pre></p>
+
+
+	<p>Move the red, green, and blue clients to the bottom of the third column:
+<pre class="code">
+curr_view.areas[<span style="color:#00D; font-weight:bold">3</span>].push terms
+</pre></p>
+
+
+	<p>Close the terminals we launched earlier:
+<pre class="code">
+terms = curr_view.clients.select {|c| colors.include? c.label.read }
+terms.each {|c| c.ctl.write <span style="background-color:#fff0f0"><span style="color:#710">&quot;</span><span style="color:#D20">kill</span><span style="color:#710">&quot;</span></span> }
+</pre></p></div>
+</div>
+<div class="section">
+  <h4 class="title">
+    <a class="toc" id="Easy-client-manipulation" href="#a-606129268">3.2.1.4</a>&nbsp;&nbsp;Easy client manipulation
+  </h4>
+  <div class="content"><p>Launch a few terminals so that we have something to work with:
+<pre class="code">
+colors = <span style="background-color:#fff0f0"><span style="color:#710">%w[</span><span style="color:#D20"> red green blue black orange brown gray navy gold </span><span style="color:#710">]</span></span>
+colors.each {|c| system <span style="background-color:#fff0f0"><span style="color:#710">&quot;</span><span style="color:#D20">xterm -bg </span><span style="background: #eee"><span style="font-weight: bold; color: #888">#{</span>c<span style="font-weight: bold; color: #888">}</span></span><span style="color:#D20"> -title </span><span style="background: #eee"><span style="font-weight: bold; color: #888">#{</span>c<span style="font-weight: bold; color: #888">}</span></span><span style="color:#D20"> -e read &amp;</span><span style="color:#710">&quot;</span></span> }
+</pre></p>
+
+
+	<p>Obtain a reference to the red client:
+<pre class="code">
+red = curr_view.clients.find {|c| c.label.read == <span style="background-color:#fff0f0"><span style="color:#710">&quot;</span><span style="color:#D20">red</span><span style="color:#710">&quot;</span></span> }
+</pre></p>
+
+
+	<p>Show the red client&#8217;s current tags:
+<pre class="code">
+red.tags
+</pre></p>
+
+
+	<p>Add the &#8220;foo&#8221; and &#8220;bar&#8221; tags to the red client:
+<pre class="code">
+red.tag <span style="background-color:#fff0f0"><span style="color:#710">&quot;</span><span style="color:#D20">foo</span><span style="color:#710">&quot;</span></span>, <span style="background-color:#fff0f0"><span style="color:#710">&quot;</span><span style="color:#D20">bar</span><span style="color:#710">&quot;</span></span>
+</pre></p>
+
+
+	<p>Remove the &#8220;bar&#8221; tag from the red client:
+<pre class="code">
+red.untag <span style="background-color:#fff0f0"><span style="color:#710">&quot;</span><span style="color:#D20">bar</span><span style="color:#710">&quot;</span></span>
+</pre></p>
+
+
+	<p>Do complex operations on the red client&#8217;s tags:
+<pre class="code">
+red.with_tags { concat <span style="background-color:#fff0f0"><span style="color:#710">%w[</span><span style="color:#D20">a b c</span><span style="color:#710">]</span></span>; push <span style="background-color:#fff0f0"><span style="color:#710">'</span><span style="color:#D20">z</span><span style="color:#710">'</span></span>; delete <span style="background-color:#fff0f0"><span style="color:#710">'</span><span style="color:#D20">c</span><span style="color:#710">'</span></span> }
+</pre></p>
+
+
+	<p>Focus the next client after the red client:
+<pre class="code">
+red.next.focus ; curr_client == red.next <span style="color:#888">#=&gt; true</span>
+</pre></p>
+
+
+	<p>Notice that by focusing a client, we make it the current client.</p>
+
+
+	<p>Focus the red client on a different view:
+<pre class="code">
+orig = curr_view
+v = red.views.last
+red.focus v
+</pre></p>
+
+
+	<p>Return to the original view:
+<pre class="code">
+orig.focus
+</pre></p>
+
+
+	<p>Send the red client to the last column:
+<pre class="code">
+red.send curr_view.areas.last
+</pre></p>
+
+
+	<p>Close the terminals we launched earlier:
+<pre class="code">
+terms = curr_view.clients.select {|c| colors.include? c.label.read }
+terms.each {|c| c.ctl.write <span style="background-color:#fff0f0"><span style="color:#710">&quot;</span><span style="color:#D20">kill</span><span style="color:#710">&quot;</span></span> }
+</pre></p></div>
+</div>
+<div class="section">
+  <h4 class="title">
+    <a class="toc" id="Traversing-the-file-system" href="#a-606134168">3.2.1.5</a>&nbsp;&nbsp;Traversing the file system
+  </h4>
+  <div class="content"><p>Show the root node of wmii&#8217;s IXP file system:
+<pre class="code">
+fs
+</pre></p>
+
+
+	<p>Show the names of all files at the root level:
+<pre class="code">
+fs.entries
+</pre></p>
+
+
+	<p>Show the parent of the root node:
+<pre class="code">
+fs.parent
+</pre></p>
+
+
+	<p>Show the children of the root node:
+<pre class="code">
+fs.children
+</pre></p>
+
+
+	<p>Navigate into to the <tt>/lbar/</tt> directory:
+<pre class="code">
+n1 = fs.lbar
+n2 = fs[<span style="background-color:#fff0f0"><span style="color:#710">'</span><span style="color:#D20">lbar</span><span style="color:#710">'</span></span>]
+n1 == n2 <span style="color:#888">#=&gt; true</span>
+left_bar = n1
+</pre></p>
+
+
+	<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 class="code">[]</code> operator on a node.</p>
+
+
+	<p>Create a new temporary button:
+<pre class="code">
+b = left_bar.rumai_example <span style="color:#888"># path of new button</span>
+b.exist? <span style="color:#888">#=&gt; false</span>
+b.create
+b.exist? <span style="color:#888">#=&gt; true</span>
+</pre></p>
+
+
+	<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 &#8220;hello world&#8221;:
+<pre class="code">
+content = <span style="background-color:#fff0f0"><span style="color:#710">&quot;</span><span style="color:#D20">#000000 #ffffff #000000 hello world</span><span style="color:#710">&quot;</span></span>
+b.write content
+b.read == content <span style="color:#888">#=&gt; true</span>
+</pre></p>
+
+
+	<p>Remove the temporary button:
+<pre class="code">
+b.remove
+b.exist? <span style="color:#888">#=&gt; false</span>
+</pre></p></div>
+</div></p></div>
+</div>
+<div class="section">
+  <h3 class="title">
+    <a class="toc" id="Available-commands" href="#a-606141278">3.2.2</a>&nbsp;&nbsp;Available commands
+  </h3>
+  <div class="content">The following table lists all methods provided by the <code class="code"><span style="color:#036; font-weight:bold">Rumai</span></code> module and its subordinates.  See the <a href="api/index.html">API documentation</a> for more extensive documentation.
+
+
+	<table border="1">
+		<tr>
+			<th>Method declaration </th>
+			<th>Description </th>
+		</tr>
+		<tr>
+			<td> <code class="code"><span style="color:#036; font-weight:bold">Rumai</span><span style="color:#888">#client_ids()</span></code> </td>
+			<td> <p>
+Returns the IDs of the current set of clients.
+</p>
+ </td>
+		</tr>
+		<tr>
+			<td> <code class="code"><span style="color:#036; font-weight:bold">Rumai</span><span style="color:#888">#curr_area()</span></code> </td>
+			<td>  </td>
+		</tr>
+		<tr>
+			<td> <code class="code"><span style="color:#036; font-weight:bold">Rumai</span><span style="color:#888">#curr_client()</span></code> </td>
+			<td>  </td>
+		</tr>
+		<tr>
+			<td> <code class="code"><span style="color:#036; font-weight:bold">Rumai</span><span style="color:#888">#curr_tag()</span></code> </td>
+			<td> <p>
+Returns the name of the currently focused tag.
+</p>
+ </td>
+		</tr>
+		<tr>
+			<td> <code class="code"><span style="color:#036; font-weight:bold">Rumai</span><span style="color:#888">#curr_view()</span></code> </td>
+			<td>  </td>
+		</tr>
+		<tr>
+			<td> <code class="code"><span style="color:#036; font-weight:bold">Rumai</span><span style="color:#888">#focus_area(aId)</span></code> </td>
+			<td>  </td>
+		</tr>
+		<tr>
+			<td> <code class="code"><span style="color:#036; font-weight:bold">Rumai</span><span style="color:#888">#focus_client(aId)</span></code> </td>
+			<td>  </td>
+		</tr>
+		<tr>
+			<td> <code class="code"><span style="color:#036; font-weight:bold">Rumai</span><span style="color:#888">#focus_view(aId)</span></code> </td>
+			<td>  </td>
+		</tr>
+		<tr>
+			<td> <code class="code"><span style="color:#036; font-weight:bold">Rumai</span><span style="color:#888">#fs()</span></code> </td>
+			<td> <p>
+Returns the root of IXP file system hierarchy.
+</p>
+ </td>
+		</tr>
+		<tr>
+			<td> <code class="code"><span style="color:#036; font-weight:bold">Rumai</span><span style="color:#888">#grouping()</span></code> </td>
+			<td> <p>
+Returns a list of all grouped clients in the currently focused view. If
+there are no grouped clients, then the currently focused client is returned
+in the list.
+</p>
+ </td>
+		</tr>
+		<tr>
+			<td> <code class="code"><span style="color:#036; font-weight:bold">Rumai</span><span style="color:#888">#next_area()</span></code> </td>
+			<td>  </td>
+		</tr>
+		<tr>
+			<td> <code class="code"><span style="color:#036; font-weight:bold">Rumai</span><span style="color:#888">#next_client()</span></code> </td>
+			<td>  </td>
+		</tr>
+		<tr>
+			<td> <code class="code"><span style="color:#036; font-weight:bold">Rumai</span><span style="color:#888">#next_tag()</span></code> </td>
+			<td> <p>
+Returns the name of the next tag.
+</p>
+ </td>
+		</tr>
+		<tr>
+			<td> <code class="code"><span style="color:#036; font-weight:bold">Rumai</span><span style="color:#888">#next_view()</span></code> </td>
+			<td>  </td>
+		</tr>
+		<tr>
+			<td> <code class="code"><span style="color:#036; font-weight:bold">Rumai</span><span style="color:#888">#prev_area()</span></code> </td>
+			<td>  </td>
+		</tr>
+		<tr>
+			<td> <code class="code"><span style="color:#036; font-weight:bold">Rumai</span><span style="color:#888">#prev_client()</span></code> </td>
+			<td>  </td>
+		</tr>
+		<tr>
+			<td> <code class="code"><span style="color:#036; font-weight:bold">Rumai</span><span style="color:#888">#prev_tag()</span></code> </td>
+			<td> <p>
+Returns the name of the previous tag.
+</p>
+ </td>
+		</tr>
+		<tr>
+			<td> <code class="code"><span style="color:#036; font-weight:bold">Rumai</span><span style="color:#888">#prev_view()</span></code> </td>
+			<td>  </td>
+		</tr>
+		<tr>
+			<td> <code class="code"><span style="color:#036; font-weight:bold">Rumai</span><span style="color:#888">#tags()</span></code> </td>
+			<td> <p>
+Returns the current set of tags.
+</p>
+ </td>
+		</tr>
+		<tr>
+			<td> <code class="code"><span style="color:#036; font-weight:bold">Rumai</span><span style="color:#888">#views()</span></code> </td>
+			<td> <p>
+Returns the current set of views.
+</p>
+ </td>
+		</tr>
+		<tr>
+			<td> <code class="code"><span style="color:#036; font-weight:bold">Rumai</span>::<span style="color:#036; font-weight:bold">Area</span><span style="color:#888">#&lt;&lt;(*aClients)</span></code> </td>
+			<td> <p>
+Alias for push
+</p>
+ </td>
+		</tr>
+		<tr>
+			<td> <code class="code"><span style="color:#036; font-weight:bold">Rumai</span>::<span style="color:#036; font-weight:bold">Area</span><span style="color:#888">#chain()</span></code> </td>
+			<td>  </td>
+		</tr>
+		<tr>
+			<td> <code class="code"><span style="color:#036; font-weight:bold">Rumai</span>::<span style="color:#036; font-weight:bold">Area</span><span style="color:#888">#client_ids()</span></code> </td>
+			<td> <p>
+Returns the IDs of the clients in this area.
+</p>
+ </td>
+		</tr>
+		<tr>
+			<td> <code class="code"><span style="color:#036; font-weight:bold">Rumai</span>::<span style="color:#036; font-weight:bold">Area</span><span style="color:#888">#column?()</span></code> </td>
+			<td> <p>
+Checks if this area is a column in the managed area.
+</p>
+ </td>
+		</tr>
+		<tr>
+			<td> <code class="code"><span style="color:#036; font-weight:bold">Rumai</span>::<span style="color:#036; font-weight:bold">Area</span><span style="color:#888">#concat(aArea)</span></code> </td>
+			<td> <p>
+Concatenates the given area to the bottom of this area.
+</p>
+ </td>
+		</tr>
+		<tr>
+			<td> <code class="code"><span style="color:#036; font-weight:bold">Rumai</span>::<span style="color:#036; font-weight:bold">Area</span><span style="color:#888">#ctl_id()</span></code> </td>
+			<td> <p>
+Makes the ID usable in wmii&#8216;s /ctl commands.
+</p>
+ </td>
+		</tr>
+		<tr>
+			<td> <code class="code"><span style="color:#036; font-weight:bold">Rumai</span>::<span style="color:#036; font-weight:bold">Area</span><span style="color:#888">#each(&amp;aBlock)</span></code> </td>
+			<td> <p>
+Iterates through each client in this container.
+</p>
+ </td>
+		</tr>
+		<tr>
+			<td> <code class="code"><span style="color:#036; font-weight:bold">Rumai</span>::<span style="color:#036; font-weight:bold">Area</span><span style="color:#888">#exist?()</span></code> </td>
+			<td> <p>
+Checks if this object exists in the chain.
+</p>
+ </td>
+		</tr>
+		<tr>
+			<td> <code class="code"><span style="color:#036; font-weight:bold">Rumai</span>::<span style="color:#036; font-weight:bold">Area</span><span style="color:#888">#float?()</span></code> </td>
+			<td> <p>
+Checks if this area is the floating area.
+</p>
+ </td>
+		</tr>
+		<tr>
+			<td> <code class="code"><span style="color:#036; font-weight:bold">Rumai</span>::<span style="color:#036; font-weight:bold">Area</span><span style="color:#888">#focus()</span></code> </td>
+			<td> <p>
+Puts focus on this area.
+</p>
+ </td>
+		</tr>
+		<tr>
+			<td> <code class="code"><span style="color:#036; font-weight:bold">Rumai</span>::<span style="color:#036; font-weight:bold">Area</span><span style="color:#888">#fringe()</span></code> </td>
+			<td> <p>
+Returns the next area, which may or may not exist.
+</p>
+ </td>
+		</tr>
+		<tr>
+			<td> <code class="code"><span style="color:#036; font-weight:bold">Rumai</span>::<span style="color:#036; font-weight:bold">Area</span><span style="color:#888">#import_client(c)</span></code> </td>
+			<td> <p>
+Moves the given client into this area.
+</p>
+ </td>
+		</tr>
+		<tr>
+			<td> <code class="code"><span style="color:#036; font-weight:bold">Rumai</span>::<span style="color:#036; font-weight:bold">Area</span><span style="color:#888">#insert(*aClients)</span></code> </td>
+			<td> <p>
+Inserts the given clients after the currently focused client in this area.
+</p>
+ </td>
+		</tr>
+		<tr>
+			<td> <code class="code"><span style="color:#036; font-weight:bold">Rumai</span>::<span style="color:#036; font-weight:bold">Area</span><span style="color:#888">#layout=(aMode)</span></code> </td>
+			<td> <p>
+Sets the layout of clients in this column.
+</p>
+ </td>
+		</tr>
+		<tr>
+			<td> <code class="code"><span style="color:#036; font-weight:bold">Rumai</span>::<span style="color:#036; font-weight:bold">Area</span><span style="color:#888">#length()</span></code> </td>
+			<td> <p>
+Returns the number of clients in this area.
+</p>
+ </td>
+		</tr>
+		<tr>
+			<td> <code class="code"><span style="color:#036; font-weight:bold">Rumai</span>::<span style="color:#036; font-weight:bold">Area</span><span style="color:#888">#length=(aMaxClients)</span></code> </td>
+			<td> <p>
+Ensures that this area has at most the given number of clients. Areas to
+the right of this one serve as a buffer into which excess clients are
+evicted and from which deficit clients are imported.
+</p>
+ </td>
+		</tr>
+		<tr>
+			<td> <code class="code"><span style="color:#036; font-weight:bold">Rumai</span>::<span style="color:#036; font-weight:bold">Area</span><span style="color:#888">#push(*aClients)</span></code> </td>
+			<td> <p>
+Inserts the given clients at the bottom of this area.
+</p>
+ </td>
+		</tr>
+		<tr>
+			<td> <code class="code"><span style="color:#036; font-weight:bold">Rumai</span>::<span style="color:#036; font-weight:bold">Area</span><span style="color:#888">#unshift(*aClients)</span></code> </td>
+			<td> <p>
+Inserts the given clients at the top of this area.
+</p>
+ </td>
+		</tr>
+		<tr>
+			<td> <code class="code"><span style="color:#036; font-weight:bold">Rumai</span>::<span style="color:#036; font-weight:bold">Area</span>::curr()</code> </td>
+			<td> <p>
+Returns the currently focused area.
+</p>
+ </td>
+		</tr>
+		<tr>
+			<td> <code class="code"><span style="color:#036; font-weight:bold">Rumai</span>::<span style="color:#036; font-weight:bold">Area</span>::new(aAreaId, aView = <span style="color:#036; font-weight:bold">View</span>.curr)</code> </td>
+			<td> <table border="1">
+<tr><td valign="top">aView:</td><td>the view which contains this area.
+
+</td></tr>
+</table>
+ </td>
+		</tr>
+		<tr>
+			<td> <code class="code"><span style="color:#036; font-weight:bold">Rumai</span>::<span style="color:#036; font-weight:bold">Chain</span><span style="color:#888">#chain()</span></code> </td>
+			<td> <p>
+Returns an array of objects related to this one.
+</p>
+ </td>
+		</tr>
+		<tr>
+			<td> <code class="code"><span style="color:#036; font-weight:bold">Rumai</span>::<span style="color:#036; font-weight:bold">Chain</span><span style="color:#888">#next()</span></code> </td>
+			<td> <p>
+Returns the object after this one in the chain.
+</p>
+ </td>
+		</tr>
+		<tr>
+			<td> <code class="code"><span style="color:#036; font-weight:bold">Rumai</span>::<span style="color:#036; font-weight:bold">Chain</span><span style="color:#888">#prev()</span></code> </td>
+			<td> <p>
+Returns the object before this one in the chain.
+</p>
+ </td>
+		</tr>
+		<tr>
+			<td> <code class="code"><span style="color:#036; font-weight:bold">Rumai</span>::<span style="color:#036; font-weight:bold">Chain</span><span style="color:#888">#sibling(aOffset)</span></code> </td>
+			<td>  </td>
+		</tr>
+		<tr>
+			<td> <code class="code"><span style="color:#036; font-weight:bold">Rumai</span>::<span style="color:#036; font-weight:bold">Client</span><span style="color:#888">#area(aView = View.curr)</span></code> </td>
+			<td> <p>
+Returns the area that contains this client within the given view.
+</p>
+ </td>
+		</tr>
+		<tr>
+			<td> <code class="code"><span style="color:#036; font-weight:bold">Rumai</span>::<span style="color:#036; font-weight:bold">Client</span><span style="color:#888">#area_to_id(aAreaOrId)</span></code> </td>
+			<td>  </td>
+		</tr>
+		<tr>
+			<td> <code class="code"><span style="color:#036; font-weight:bold">Rumai</span>::<span style="color:#036; font-weight:bold">Client</span><span style="color:#888">#chain()</span></code> </td>
+			<td> <p>
+Returns a list of clients in the current view.
+</p>
+ </td>
+		</tr>
+		<tr>
+			<td> <code class="code"><span style="color:#036; font-weight:bold">Rumai</span>::<span style="color:#036; font-weight:bold">Client</span><span style="color:#888">#focus(aView = nil)</span></code> </td>
+			<td> <p>
+Focuses this client within the given view.
+</p>
+ </td>
+		</tr>
+		<tr>
+			<td> <code class="code"><span style="color:#036; font-weight:bold">Rumai</span>::<span style="color:#036; font-weight:bold">Client</span><span style="color:#888">#group()</span></code> </td>
+			<td> <p>
+Adds this client to the current grouping.
+</p>
+ </td>
+		</tr>
+		<tr>
+			<td> <code class="code"><span style="color:#036; font-weight:bold">Rumai</span>::<span style="color:#036; font-weight:bold">Client</span><span style="color:#888">#group?()</span></code> </td>
+			<td> <p>
+Checks if this client is included in the current grouping.
+</p>
+ </td>
+		</tr>
+		<tr>
+			<td> <code class="code"><span style="color:#036; font-weight:bold">Rumai</span>::<span style="color:#036; font-weight:bold">Client</span><span style="color:#888">#send(aAreaOrId, aView = View.curr)</span></code> </td>
+			<td> <p>
+Sends this client to the given destination within the given view.
+</p>
+ </td>
+		</tr>
+		<tr>
+			<td> <code class="code"><span style="color:#036; font-weight:bold">Rumai</span>::<span style="color:#036; font-weight:bold">Client</span><span style="color:#888">#swap(aAreaOrId, aView = View.curr)</span></code> </td>
+			<td> <p>
+Swaps this client with the given destination within the given view.
+</p>
+ </td>
+		</tr>
+		<tr>
+			<td> <code class="code"><span style="color:#036; font-weight:bold">Rumai</span>::<span style="color:#036; font-weight:bold">Client</span><span style="color:#888">#tag(*aTags)</span></code> </td>
+			<td> <p>
+Adds the given tags to this client.
+</p>
+ </td>
+		</tr>
+		<tr>
+			<td> <code class="code"><span style="color:#036; font-weight:bold">Rumai</span>::<span style="color:#036; font-weight:bold">Client</span><span style="color:#888">#tags()</span></code> </td>
+			<td> <p>
+Returns the tags associated with this client.
+</p>
+ </td>
+		</tr>
+		<tr>
+			<td> <code class="code"><span style="color:#036; font-weight:bold">Rumai</span>::<span style="color:#036; font-weight:bold">Client</span><span style="color:#888">#tags=(*aTags)</span></code> </td>
+			<td> <p>
+Modifies the tags associated with this client.
+</p>
+ </td>
+		</tr>
+		<tr>
+			<td> <code class="code"><span style="color:#036; font-weight:bold">Rumai</span>::<span style="color:#036; font-weight:bold">Client</span><span style="color:#888">#toggle_group()</span></code> </td>
+			<td> <p>
+Toggles the presence of this client in the current grouping.
+</p>
+ </td>
+		</tr>
+		<tr>
+			<td> <code class="code"><span style="color:#036; font-weight:bold">Rumai</span>::<span style="color:#036; font-weight:bold">Client</span><span style="color:#888">#ungroup()</span></code> </td>
+			<td> <p>
+Removes this client to the current grouping.
+</p>
+ </td>
+		</tr>
+		<tr>
+			<td> <code class="code"><span style="color:#036; font-weight:bold">Rumai</span>::<span style="color:#036; font-weight:bold">Client</span><span style="color:#888">#untag(*aTags)</span></code> </td>
+			<td> <p>
+Removes the given tags from this client.
+</p>
+ </td>
+		</tr>
+		<tr>
+			<td> <code class="code"><span style="color:#036; font-weight:bold">Rumai</span>::<span style="color:#036; font-weight:bold">Client</span><span style="color:#888">#views()</span></code> </td>
+			<td> <p>
+Returns the views that contain this client.
+</p>
+ </td>
+		</tr>
+		<tr>
+			<td> <code class="code"><span style="color:#036; font-weight:bold">Rumai</span>::<span style="color:#036; font-weight:bold">Client</span><span style="color:#888">#with_tags(&amp;aBlock)</span></code> </td>
+			<td> <p>
+Evaluates the given block within the context of this client&#8216;s list of
+tags.
+</p>
+ </td>
+		</tr>
+		<tr>
+			<td> <code class="code"><span style="color:#036; font-weight:bold">Rumai</span>::<span style="color:#036; font-weight:bold">Client</span>::curr()</code> </td>
+			<td> <p>
+Returns the currently focused client.
+</p>
+ </td>
+		</tr>
+		<tr>
+			<td> <code class="code"><span style="color:#036; font-weight:bold">Rumai</span>::<span style="color:#036; font-weight:bold">Client</span>::new(aClientId)</code> </td>
+			<td>  </td>
+		</tr>
+		<tr>
+			<td> <code class="code"><span style="color:#036; font-weight:bold">Rumai</span>::<span style="color:#036; font-weight:bold">ClientContainer</span><span style="color:#888">#client_ids()</span></code> </td>
+			<td> <p>
+Returns the IDs of the clients in this container.
+</p>
+ </td>
+		</tr>
+		<tr>
+			<td> <code class="code"><span style="color:#036; font-weight:bold">Rumai</span>::<span style="color:#036; font-weight:bold">ClientContainer</span><span style="color:#888">#clients()</span></code> </td>
+			<td> <p>
+Returns the clients contained in this container.
+</p>
+ </td>
+		</tr>
+		<tr>
+			<td> <code class="code"><span style="color:#036; font-weight:bold">Rumai</span>::<span style="color:#036; font-weight:bold">ClientContainer</span><span style="color:#888">#grouping()</span></code> </td>
+			<td> <p>
+Returns all grouped clients in this container.
+</p>
+ </td>
+		</tr>
+		<tr>
+			<td> <code class="code"><span style="color:#036; font-weight:bold">Rumai</span>::<span style="color:#036; font-weight:bold">Node</span><span style="color:#888">#[](aSubPath)</span></code> </td>
+			<td> <p>
+Returns the given sub-path as a Node object.
+</p>
+ </td>
+		</tr>
+		<tr>
+			<td> <code class="code"><span style="color:#036; font-weight:bold">Rumai</span>::<span style="color:#036; font-weight:bold">Node</span><span style="color:#888">#children()</span></code> </td>
+			<td> <p>
+Returns all child nodes of this node.
+</p>
+ </td>
+		</tr>
+		<tr>
+			<td> <code class="code"><span style="color:#036; font-weight:bold">Rumai</span>::<span style="color:#036; font-weight:bold">Node</span><span style="color:#888">#clear()</span></code> </td>
+			<td> <p>
+Deletes all child nodes.
+</p>
+ </td>
+		</tr>
+		<tr>
+			<td> <code class="code"><span style="color:#036; font-weight:bold">Rumai</span>::<span style="color:#036; font-weight:bold">Node</span><span style="color:#888">#create(*aArgs)</span></code> </td>
+			<td> <p>
+Creates a file corresponding to this node on the IXP server. See
+Rumai::IXP::Client#create for details.
+</p>
+ </td>
+		</tr>
+		<tr>
+			<td> <code class="code"><span style="color:#036; font-weight:bold">Rumai</span>::<span style="color:#036; font-weight:bold">Node</span><span style="color:#888">#directory?()</span></code> </td>
+			<td> <p>
+Tests if this node is a directory.
+</p>
+ </td>
+		</tr>
+		<tr>
+			<td> <code class="code"><span style="color:#036; font-weight:bold">Rumai</span>::<span style="color:#036; font-weight:bold">Node</span><span style="color:#888">#each(&amp;aBlock)</span></code> </td>
+			<td> <p>
+Iterates through each child of this directory.
+</p>
+ </td>
+		</tr>
+		<tr>
+			<td> <code class="code"><span style="color:#036; font-weight:bold">Rumai</span>::<span style="color:#036; font-weight:bold">Node</span><span style="color:#888">#each_line(&amp;aBlock) {|line| ... }</span></code> </td>
+			<td> <p>
+Invokes the given block for every line in the content of this node.
+</p>
+ </td>
+		</tr>
+		<tr>
+			<td> <code class="code"><span style="color:#036; font-weight:bold">Rumai</span>::<span style="color:#036; font-weight:bold">Node</span><span style="color:#888">#entries()</span></code> </td>
+			<td> <p>
+Returns the names of all files in this directory.
+</p>
+ </td>
+		</tr>
+		<tr>
+			<td> <code class="code"><span style="color:#036; font-weight:bold">Rumai</span>::<span style="color:#036; font-weight:bold">Node</span><span style="color:#888">#exist?()</span></code> </td>
+			<td> <p>
+Tests if this node exists on the IXP server.
+</p>
+ </td>
+		</tr>
+		<tr>
+			<td> <code class="code"><span style="color:#036; font-weight:bold">Rumai</span>::<span style="color:#036; font-weight:bold">Node</span><span style="color:#888">#method_missing(aMeth, *aArgs)</span></code> </td>
+			<td> <p>
+Provides access to child nodes through method calls.
+</p>
+ </td>
+		</tr>
+		<tr>
+			<td> <code class="code"><span style="color:#036; font-weight:bold">Rumai</span>::<span style="color:#036; font-weight:bold">Node</span><span style="color:#888">#open(aMode = 'r', &amp;aBlock)</span></code> </td>
+			<td> <p>
+Opens this node for I/O access. See Rumai::IXP::Client#open for details.
+</p>
+ </td>
+		</tr>
+		<tr>
+			<td> <code class="code"><span style="color:#036; font-weight:bold">Rumai</span>::<span style="color:#036; font-weight:bold">Node</span><span style="color:#888">#parent()</span></code> </td>
+			<td> <p>
+Returns the parent node of this node.
+</p>
+ </td>
+		</tr>
+		<tr>
+			<td> <code class="code"><span style="color:#036; font-weight:bold">Rumai</span>::<span style="color:#036; font-weight:bold">Node</span><span style="color:#888">#read()</span></code> </td>
+			<td> <p>
+Returns the entire content of this node. See Rumai::IXP::Client#read for
+details.
+</p>
+ </td>
+		</tr>
+		<tr>
+			<td> <code class="code"><span style="color:#036; font-weight:bold">Rumai</span>::<span style="color:#036; font-weight:bold">Node</span><span style="color:#888">#remove()</span></code> </td>
+			<td> <p>
+Deletes the file corresponding to this node on the IXP server.
+</p>
+ </td>
+		</tr>
+		<tr>
+			<td> <code class="code"><span style="color:#036; font-weight:bold">Rumai</span>::<span style="color:#036; font-weight:bold">Node</span><span style="color:#888">#stat()</span></code> </td>
+			<td> <p>
+Returns file statistics about this node. See Rumai::IXP::Client#stat for
+details.
+</p>
+ </td>
+		</tr>
+		<tr>
+			<td> <code class="code"><span style="color:#036; font-weight:bold">Rumai</span>::<span style="color:#036; font-weight:bold">Node</span><span style="color:#888">#write(aContent)</span></code> </td>
+			<td> <p>
+Writes the given content to this node.
+</p>
+ </td>
+		</tr>
+		<tr>
+			<td> <code class="code"><span style="color:#036; font-weight:bold">Rumai</span>::<span style="color:#036; font-weight:bold">Node</span>::new(aPath)</code> </td>
+			<td>  </td>
+		</tr>
+		<tr>
+			<td> <code class="code"><span style="color:#036; font-weight:bold">Rumai</span>::<span style="color:#036; font-weight:bold">View</span><span style="color:#888">#area_ids()</span></code> </td>
+			<td> <p>
+Returns the IDs of all areas in this view.
+</p>
+ </td>
+		</tr>
+		<tr>
+			<td> <code class="code"><span style="color:#036; font-weight:bold">Rumai</span>::<span style="color:#036; font-weight:bold">View</span><span style="color:#888">#area_of_client(aClientOrId)</span></code> </td>
+			<td> <p>
+Returns the area which contains the given client in this view.
+</p>
+ </td>
+		</tr>
+		<tr>
+			<td> <code class="code"><span style="color:#036; font-weight:bold">Rumai</span>::<span style="color:#036; font-weight:bold">View</span><span style="color:#888">#areas()</span></code> </td>
+			<td> <p>
+Returns all areas in this view.
+</p>
+ </td>
+		</tr>
+		<tr>
+			<td> <code class="code"><span style="color:#036; font-weight:bold">Rumai</span>::<span style="color:#036; font-weight:bold">View</span><span style="color:#888">#arrange_as_larswm()</span></code> </td>
+			<td> <p>
+Arranges the clients in this view, while maintaining their relative order,
+in the tiling fashion of LarsWM. Only the first client in the primary
+column is kept; all others are evicted to the <b>top</b> of the secondary
+column. Any subsequent columns are squeezed into the <b>bottom</b> of the
+secondary column.
+</p>
+ </td>
+		</tr>
+		<tr>
+			<td> <code class="code"><span style="color:#036; font-weight:bold">Rumai</span>::<span style="color:#036; font-weight:bold">View</span><span style="color:#888">#arrange_in_diamond()</span></code> </td>
+			<td> <p>
+Arranges the clients in this view, while maintaining their relative order,
+in a (at best) equilateral triangle. However, the resulting arrangement
+appears like a diamond because wmii does not waste screen space.
+</p>
+ </td>
+		</tr>
+		<tr>
+			<td> <code class="code"><span style="color:#036; font-weight:bold">Rumai</span>::<span style="color:#036; font-weight:bold">View</span><span style="color:#888">#arrange_in_grid(aMaxClientsPerColumn = nil)</span></code> </td>
+			<td> <p>
+Arranges the clients in this view, while maintaining their relative order,
+in a (at best) square grid.
+</p>
+ </td>
+		</tr>
+		<tr>
+			<td> <code class="code"><span style="color:#036; font-weight:bold">Rumai</span>::<span style="color:#036; font-weight:bold">View</span><span style="color:#888">#chain()</span></code> </td>
+			<td>  </td>
+		</tr>
+		<tr>
+			<td> <code class="code"><span style="color:#036; font-weight:bold">Rumai</span>::<span style="color:#036; font-weight:bold">View</span><span style="color:#888">#client_ids(aAreaId = '\S+')</span></code> </td>
+			<td> <p>
+Returns the IDs of the clients contained in the given area within this
+view.
+</p>
+ </td>
+		</tr>
+		<tr>
+			<td> <code class="code"><span style="color:#036; font-weight:bold">Rumai</span>::<span style="color:#036; font-weight:bold">View</span><span style="color:#888">#columns()</span></code> </td>
+			<td> <p>
+Returns all columns (managed areas) in this view.
+</p>
+ </td>
+		</tr>
+		<tr>
+			<td> <code class="code"><span style="color:#036; font-weight:bold">Rumai</span>::<span style="color:#036; font-weight:bold">View</span><span style="color:#888">#each(&amp;aBlock)</span></code> </td>
+			<td> <p>
+Iterates through each area in this view.
+</p>
+ </td>
+		</tr>
+		<tr>
+			<td> <code class="code"><span style="color:#036; font-weight:bold">Rumai</span>::<span style="color:#036; font-weight:bold">View</span><span style="color:#888">#each_column(aStartingColumnId = 1) {|a| ... }</span></code> </td>
+			<td> <p>
+Resiliently iterates through possibly destructive changes to each column.
+That is, if the given block creates new columns, then those will also be
+processed in the iteration.
+</p>
+ </td>
+		</tr>
+		<tr>
+			<td> <code class="code"><span style="color:#036; font-weight:bold">Rumai</span>::<span style="color:#036; font-weight:bold">View</span><span style="color:#888">#floating_area()</span></code> </td>
+			<td> <p>
+Returns the floating area of this view.
+</p>
+ </td>
+		</tr>
+		<tr>
+			<td> <code class="code"><span style="color:#036; font-weight:bold">Rumai</span>::<span style="color:#036; font-weight:bold">View</span><span style="color:#888">#focus()</span></code> </td>
+			<td> <p>
+Focuses this view.
+</p>
+ </td>
+		</tr>
+		<tr>
+			<td> <code class="code"><span style="color:#036; font-weight:bold">Rumai</span>::<span style="color:#036; font-weight:bold">View</span><span style="color:#888">#manifest()</span></code> </td>
+			<td> <p>
+Returns the manifest of all areas and clients in this view.
+</p>
+ </td>
+		</tr>
+		<tr>
+			<td> <code class="code"><span style="color:#036; font-weight:bold">Rumai</span>::<span style="color:#036; font-weight:bold">View</span><span style="color:#888">#num_managed_clients()</span></code> </td>
+			<td> <p>
+Returns the number of clients in the non-floating areas of this view.
+</p>
+ </td>
+		</tr>
+		<tr>
+			<td> <code class="code"><span style="color:#036; font-weight:bold">Rumai</span>::<span style="color:#036; font-weight:bold">View</span><span style="color:#888">#squeeze(aAreas)</span></code> </td>
+			<td> <p>
+Smashes the given list of areas into the first one. The relative ordering
+of clients is preserved.
+</p>
+ </td>
+		</tr>
+		<tr>
+			<td> <code class="code"><span style="color:#036; font-weight:bold">Rumai</span>::<span style="color:#036; font-weight:bold">View</span>::curr()</code> </td>
+			<td> <p>
+Returns the currently focused view.
+</p>
+ </td>
+		</tr>
+		<tr>
+			<td> <code class="code"><span style="color:#036; font-weight:bold">Rumai</span>::<span style="color:#036; font-weight:bold">View</span>::new(aViewId)</code> </td>
+			<td>  </td>
+		</tr>
+	</table></div>
+</div></p></div>
+</div>
+<div class="section">
+  <h2 class="title">
+    <a class="toc" id="wmiirc" href="#a-607083858">3.3</a>&nbsp;&nbsp;Scripting your wmiirc
+  </h2>
+  <div class="content"><p>One important application of Rumai is the support of Ruby-based <tt>wmiirc</tt> configuration files. For a solid example of such application, take a look at my personal <tt>wmiirc</tt> which uses Rumai extensively:</p>
+
+
+	<pre>darcs get http://snk.tuxfamily.org/src/wmiirc</pre>
+
+
+	<p>Alternatively, you can <a href="http://snk.tuxfamily.org/src/wmiirc">browse the contents of the above repository</a> in your web browser.</p></div>
+</div></div>
+</div></div>
+
+
+    <br style="display: none"/>
+    <hr style="display: none"/>
+    <br style="display: none"/>
+
+    <div id="footer">
+      Generated on Sat Jan 26 19:52:45 -0800 2008 by <a href="http://gerbil.rubyforge.org">Gerbil</a> 1.1.0.
+
+    </div>
+  </body>
+</html>