rumai 3.2.0 → 3.2.1

data/USAGE

@@ -0,0 +1,297 @@
+%#                                                                          #%
+%#             You can read this document in its full glory by              #%
+%#          opening ./doc/index.html in your favorite Web browser.          #%
+%#                                                                          #%
+
+%#----------------------------------------------------------------------------
+%| section "Interactive shell", "shell"
+%#----------------------------------------------------------------------------
+
+  %|command! "rumai"
+
+    This command starts an IRB (Interactive Ruby Shell) session, which places
+    you a command prompt like this:
+
+        irb(Rumai):001:0>
+
+    The <tt>irb(Rumai)</tt> token in the command 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.  Both
+    commands achieve the same effect.
+
+    The next thing to note is that **TAB completion** is enabled by default.
+    So you can type part of a command and press the TAB key to see a list of
+    possible completions.
+
+%#----------------------------------------------------------------------------
+%| section "Live demonstration", "Tutorial"
+%#----------------------------------------------------------------------------
+
+  Now that you know <%= xref "shell", "how to start the interactive shell" %>,
+  let us walk through a (hopefully) 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 = lambda do
+    Launch a few terminals so that we have something to work with:
+
+    %|code :ruby
+      colors = %w[ red green blue black orange brown gray navy gold ]
+      colors.each {|c| system "xterm -bg #{c} -title #{c} -e sh -c read &" }
+
+  %|close_terms = lambda do
+    Close the terminals we launched earlier:
+
+    %|code :ruby
+      terms = curr_view.clients.select {|c| colors.include? c.label.read }
+      terms.each {|c| c.kill }
+
+  %#--------------------------------------------------------------------------
+  %| section "Automated client arrangement"
+  %#--------------------------------------------------------------------------
+
+    % open_terms.call
+
+    Arrange all clients in a grid:
+
+    %|code :ruby
+      curr_view.arrange_in_grid
+
+    Arrange all clients in a diamond shape:
+
+    %|code :ruby
+      curr_view.arrange_in_diamond
+
+    Arrange all clients like LarsWM does:
+
+    %|code :ruby
+      curr_view.arrange_as_larswm
+
+    % close_terms.call
+
+  %#--------------------------------------------------------------------------
+  %| section "Multiple client grouping"
+  %#--------------------------------------------------------------------------
+
+    % open_terms.call
+
+    Add the red, green, and blue terminals into the "grouping":
+
+    %|code :ruby
+      terms = curr_view.clients.select do |c|
+        %%w[red green blue].include? c.label.read
+      end
+      terms.each {|c| c.group }
+
+    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:
+
+    %|code :ruby
+      v = View.new "@"
+      puts v.clients.map {|c| c.label.read }
+
+    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 :ruby
+      grouping.each {|c| c.send "toggle" }
+
+    Neat! Let us bring them back into the managed area:
+
+    %|code :ruby
+      grouping.each {|c| c.send "toggle" }
+
+    % close_terms.call
+
+    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.
+
+  %#--------------------------------------------------------------------------
+  %| section "Easy column manipulation"
+  %#--------------------------------------------------------------------------
+
+    % open_terms.call
+
+    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 :ruby
+      curr_view.each_column {|c| c.length = 1 }
+
+    Put (at most) three clients in every column:
+
+    %|code :ruby
+      curr_view.each_column {|c| c.length = 3 }
+
+    Move the red, green, and blue clients into the floating area:
+
+    %|code :ruby
+      rgb = %w[red green blue]
+      terms = curr_view.clients.select {|c| rgb.include? c.label.read }
+      curr_view.areas[0].push terms
+
+    Slurp all floating clients into the last column:
+
+    %|code :ruby
+      list = curr_view.areas
+      a, b = list.first, list.last
+      b.concat a
+
+    Set the last column's layout to stacking mode:
+
+    %|code :ruby
+      b.layout = 'stack'
+
+    Move the red, green, and blue clients to the top of the second column:
+
+    %|code :ruby
+      curr_view.areas[2].unshift terms
+
+    Move the red, green, and blue clients to the bottom of the third column:
+
+    %|code :ruby
+      curr_view.areas[3].push terms
+
+    % close_terms.call
+
+  %#--------------------------------------------------------------------------
+  %| section "Easy client manipulation"
+  %#--------------------------------------------------------------------------
+
+    % open_terms.call
+
+    Obtain a reference to the red client:
+
+    %|code :ruby
+      red = curr_view.clients.find {|c| c.label.read == "red" }
+
+    Show the red client's current tags:
+
+    %|code :ruby
+      red.tags
+
+    Add the "foo" and "bar" tags to the red client:
+
+    %|code :ruby
+      red.tag "foo", "bar"
+
+    Remove the "bar" tag from the red client:
+
+    %|code :ruby
+      red.untag "bar"
+
+    Do complex operations on the red client's tags:
+
+    %|code :ruby
+      red.with_tags { concat %w[a b c]; push 'z'; delete 'c' }
+
+    Focus the next client after the red client:
+
+    %|code :ruby
+      red.next.focus
+      curr_client == red.next #=> true
+
+    Notice that by focusing a client, we make it the current client.
+
+    Focus the red client on a different view:
+
+    %|code :ruby
+      orig = curr_view
+      v = red.views.last
+      red.focus v
+
+    Return to the original view:
+
+    %|code :ruby
+      orig.focus
+
+    Send the red client to the last column:
+
+    %|code :ruby
+      red.send curr_view.areas.last
+
+    % close_terms.call
+
+  %#--------------------------------------------------------------------------
+  %| section "Traversing the file system"
+  %#--------------------------------------------------------------------------
+
+    Show the root node of wmii's IXP file system:
+
+    %|code :ruby
+      fs
+
+    Show the names of all files at the root level:
+
+    %|code :ruby
+      fs.entries
+
+    Show the parent of the root node:
+
+    %|code :ruby
+      fs.parent
+
+    Show the children of the root node:
+
+    %|code :ruby
+      fs.children
+
+    Navigate into to the <tt>/lbar/</tt> directory:
+
+    %|code :ruby
+      n1 = fs.lbar
+      n2 = fs['lbar']
+      n1 == n2 #=> true
+      left_bar = n1
+
+    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 :ruby
+      b = left_bar.rumai_example # path of new button
+      b.exist? #=> false
+      b.create
+      b.exist? #=> true
+
+    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 :ruby
+      content = "#000000 #ffffff #000000 hello world"
+      b.write content
+      b.read == content #=> true
+
+    Remove the temporary button:
+
+    %|code :ruby
+      b.remove
+      b.exist? #=> false
+
+  %#--------------------------------------------------------------------------
+  %| section "More commands"
+  %#--------------------------------------------------------------------------
+
+    See the `Rumai` module in the [API documentation](api/index.html) for a
+    complete list of commands (method calls really) and their documentation.
+

data/bin/rumai

@@ -2,34 +2,17 @@
 #
 # This program is an interactive shell for Rumai.
 #
-# Usage:
+# Command-line options and arguments given to this program are passed
+# directly to the underlying IRB (the interactive Ruby shell) session.
 #
-#   rumai [Options]
-#   rumai [Options] -- Arguments
-#
-#   Arguments:  Command-line options and arguments that should
-#               be passed to `irb`, the interactive Ruby shell.
-#
-# Options:
-#
-
-#--
-# Copyright protects this work.
-# See LICENSE file for details.
-#++
-
-require 'rubygems'
-gem 'inochi', '~> 1'
-require 'inochi'
-
-Inochi.main :Rumai
 
 require 'irb'
-require 'irb/completion'
+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
   #
@@ -46,4 +29,8 @@ module IRB
   end
 end
 
+# start IRB session
+$LOAD_PATH << File.expand_path('../../lib', __FILE__)
+require 'rumai'
+
 IRB.start_session Rumai

data/doc/api/IO.html

@@ -0,0 +1,119 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+  <head>
+    <meta name="Content-Type" content="text/html; charset=utf-8" />
+<title>Class: IO</title>
+<link rel="stylesheet" href="css/style.css" type="text/css" media="screen" charset="utf-8" />
+<link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />
+
+<script type="text/javascript" charset="utf-8">
+  relpath = '';
+  if (relpath != '') relpath += '/';
+</script>
+<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
+
+  </head>
+  <body>
+    <script type="text/javascript" charset="utf-8">
+      if (window.top.frames.main) document.body.className = 'frames';
+    </script>
+    
+    <div id="header">
+      <div id="menu">
+  
+    <a href="_index.html">Index (I)</a> &raquo; 
+    
+    
+    <span class="title">IO</span>
+  
+  
+  <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
+</div>
+
+      <div id="search">
+  <a id="class_list_link" href="#">Class List</a>
+  <a id="method_list_link" href="#">Method List</a>
+  <a id ="file_list_link" href="#">File List</a>
+</div>
+
+      <div class="clear"></div>
+    </div>
+    
+    <iframe id="search_frame"></iframe>
+    
+    <div id="content"><h1>Class: IO 
+  
+  
+</h1>
+
+<dl class="box">
+  
+    <dt class="r1">Inherits:</dt>
+    <dd class="r1">
+      <span class="inheritName"><a href="Object.html" title="Object (class)">Object</a></span>
+      
+        <ul class="fullTree">
+          <li><a href="Object.html" title="Object (class)">Object</a></li>
+          
+            <li class="next">IO</li>
+          
+        </ul>
+        <a href="#" class="inheritanceTree">show all</a>
+      
+      </dd>
+    
+  
+  
+    
+  
+    
+      <dt class="r2">Includes:</dt>
+      <dd class="r2"><a href="Rumai/IXP/Stream.html" title="Rumai::IXP::Stream (module)">Rumai::IXP::Stream</a></dd>
+      
+    
+  
+  
+  
+    <dt class="r1 last">Defined in:</dt>
+    <dd class="r1 last">lib/rumai/ixp/message.rb</dd>
+  
+</dl>
+<div class="clear"></div>
+
+
+  <h2>Constant Summary</h2>
+  
+
+
+  
+  
+  
+  
+  <h3 class="inherited">Constants included from <a href="Rumai/IXP/Stream.html" title="Rumai::IXP::Stream (module)">Rumai::IXP::Stream</a></h3>
+  <p class="inherited"><a href="Rumai/IXP/Stream.html#PACKING_FLAGS-constant" title="Rumai::IXP::Stream::PACKING_FLAGS (constant)">PACKING_FLAGS</a></p>
+
+
+
+  
+  
+  
+  
+  
+  <h2>Method Summary</h2>
+  
+  <h3 class="inherited">Methods included from <a href="Rumai/IXP/Stream.html" title="Rumai::IXP::Stream (module)">Rumai::IXP::Stream</a></h3>
+  <p class="inherited"><a href="Rumai/IXP/Stream.html#read_9p-instance_method" title="Rumai::IXP::Stream#read_9p (method)">#read_9p</a></p>
+
+
+</div>
+    
+    <div id="footer">
+  Generated on Mon Mar 22 22:23:58 2010 by 
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool">yard</a>
+  0.5.4 (ruby-1.9.1).
+</div>
+
+  </body>
+</html>