'\" t
.\"     Title: rumai
.\"    Author: [see the "AUTHORS" section]
.\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
.\"      Date: 08/11/2010
.\"    Manual: \ \&
.\"    Source: \ \& 3.3.1
.\"  Language: English
.\"
.TH "RUMAI" "1" "08/11/2010" "\ \& 3\&.3\&.1" "\ \&"
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
rumai \- Ruby interface to the wmii window manager
.SH "SYNOPSIS"
.sp
\fBrumai\fR [\fIOPTIONS\fR] [\fIIRB_OPTIONS\fR]
.SS "Command"
.sp
Starts an interactive Ruby shell (IRB) session by passing the given \fIIRB_OPTIONS\fR to irb(1) and placing you at a command prompt like this:
.sp
.nf
irb(Rumai):001:0>
.fi
.sp
The \fBirb(Rumai)\fR token in the command prompt indicates that your commands will be evaluated \fIinside\fR the Rumai module\&. As a result, you can omit the "Rumai" prefix from your commands\&.
.sp
For example, to get the currently selected client, you can type curr_client instead of Rumai\&.curr_client at the prompt\&. Both commands achieve the same effect\&.
.sp
The next thing to notice is that \fBTAB completion\fR is enabled\&. So you can type part of a command and press the TAB key to see a list of possible completions\&.
.SS "Options"
.PP
\fB\-h\fR, \fB\-\-help\fR
.RS 4
Display this manual and exit\&.
.RE
.PP
\fB\-v\fR, \fB\-\-version\fR
.RS 4
Print version number and exit\&.
.RE
.SH "DESCRIPTION"
.sp
Rumai is a pure [Ruby] interface to the [wmii] window manager\&. Its name is a portmanteau of "\fBRu\fRby" and "w\fBmi\fRi", which I pronounce as "vim eye"\&.
.SS "Features"
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Provides an interactive shell for live experimentation\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Arranges clients, columns, views, and tags dynamically\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Talks directly to wmii\(cqs
IXP filesystem interface\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Includes a pure Ruby client for the
9P2000 protocol\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Powers
\m[blue]\fBmy personal\fR\m[]\&\s-2\u[1]\d\s+2
wmiirc and
\m[blue]\fBmany others\fR\m[]\&\s-2\u[2]\d\s+2
like it\&.
.RE
.SS "Resources"
.PP
Project website
.RS 4

\m[blue]\fBhttp://snk\&.tuxfamily\&.org/lib/rumai/\fR\m[]
.RE
.PP
Announcements feed
.RS 4

\m[blue]\fBhttp://snk\&.tuxfamily\&.org/lib/rumai/ann\&.xml\fR\m[]
.RE
.PP
API documentation
.RS 4

\m[blue]\fBhttp://snk\&.tuxfamily\&.org/lib/rumai/api/\fR\m[]
.RE
.PP
Source code (browse online, download, or checkout)
.RS 4

\m[blue]\fBhttp://github\&.com/sunaku/rumai\fR\m[]
.RE
.PP
Issue tracker (report bugs, request features, get help)
.RS 4

\m[blue]\fBhttp://github\&.com/sunaku/rumai/issues\fR\m[]
.RE
.SH "INSTALL"
.SS "Prerequisites"
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}

[Ruby]
1\&.8\&.6 or newer\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}

[RubyGems]
1\&.3\&.6 or newer\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}

[wmii]
3\&.9 or newer\&.
.RE
.SS "Installing"
.sp
.if n \{\
.RS 4
.\}
.nf
gem install rumai
.fi
.if n \{\
.RE
.\}
.SS "Upgrading"
.sp
.if n \{\
.RS 4
.\}
.nf
gem update rumai
.fi
.if n \{\
.RE
.\}
.SS "Removing"
.sp
.if n \{\
.RS 4
.\}
.nf
gem uninstall rumai
.fi
.if n \{\
.RE
.\}
.SH "USAGE"
.sp
Now that you know how to start the interactive shell (see \fBDESCRIPTION\fR above) let us walk through a series of examples that highlight the main features of Rumai\&. You can follow along by copying & pasting the presented commands into the interactive shell\&.
.SS "Automated client arrangement"
.sp
Launch a few terminals so that we have something to work with:
.sp
.if n \{\
.RS 4
.\}
.nf
colors = %w[ red green blue black orange brown gray navy gold ]
colors\&.each {|c| system "xterm \-bg #{c} \-title #{c} \-e sh \-c read &" }
.fi
.if n \{\
.RE
.\}
.sp
Arrange all clients in a grid:
.sp
.if n \{\
.RS 4
.\}
.nf
curr_view\&.arrange_in_grid
.fi
.if n \{\
.RE
.\}
.sp
Arrange all clients in a diamond shape:
.sp
.if n \{\
.RS 4
.\}
.nf
curr_view\&.arrange_in_diamond
.fi
.if n \{\
.RE
.\}
.sp
Arrange all clients like LarsWM does:
.sp
.if n \{\
.RS 4
.\}
.nf
curr_view\&.arrange_as_larswm
.fi
.if n \{\
.RE
.\}
.sp
Close the terminals we launched earlier:
.sp
.if n \{\
.RS 4
.\}
.nf
terms = curr_view\&.clients\&.select {|c| colors\&.include? c\&.label\&.read }
terms\&.each {|c| c\&.kill }
.fi
.if n \{\
.RE
.\}
.SS "Multiple client grouping"
.sp
Launch a few terminals so that we have something to work with:
.sp
.if n \{\
.RS 4
.\}
.nf
colors = %w[ red green blue black orange brown gray navy gold ]
colors\&.each {|c| system "xterm \-bg #{c} \-title #{c} \-e sh \-c read &" }
.fi
.if n \{\
.RE
.\}
.sp
Add the red, green, and blue terminals into the "grouping":
.sp
.if n \{\
.RS 4
.\}
.nf
terms = curr_view\&.clients\&.select do |c|
  %w[red green blue]\&.include? c\&.label\&.read
end
terms\&.each {|c| c\&.group }
.fi
.if n \{\
.RE
.\}
.sp
You should now see a new button labelled as "@" on the left\-hand side of wmii\(cqs bar, indicating that there is now a new view labelled "@" in wmii\&. Let us inspect what clients this mysterious view contains:
.sp
.if n \{\
.RS 4
.\}
.nf
v = View\&.new "@"
puts v\&.clients\&.map {|c| c\&.label\&.read }
.fi
.if n \{\
.RE
.\}
.sp
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\&.
.sp
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:
.sp
.if n \{\
.RS 4
.\}
.nf
grouping\&.each {|c| c\&.send "toggle" }
.fi
.if n \{\
.RE
.\}
.sp
Neat! Let us bring them back into the managed area:
.sp
.if n \{\
.RS 4
.\}
.nf
grouping\&.each {|c| c\&.send "toggle" }
.fi
.if n \{\
.RE
.\}
.sp
Close the terminals we launched earlier:
.sp
.if n \{\
.RS 4
.\}
.nf
terms = curr_view\&.clients\&.select {|c| colors\&.include? c\&.label\&.read }
terms\&.each {|c| c\&.kill }
.fi
.if n \{\
.RE
.\}
.sp
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\&.
.sp
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\&.
.SS "Easy column manipulation"
.sp
Launch a few terminals so that we have something to work with:
.sp
.if n \{\
.RS 4
.\}
.nf
colors = %w[ red green blue black orange brown gray navy gold ]
colors\&.each {|c| system "xterm \-bg #{c} \-title #{c} \-e sh \-c read &" }
.fi
.if n \{\
.RE
.\}
.sp
You can insert a group of clients to the top, bottom, or after the currently focused client of \fIany\fR column using Array\-like methods\&.
.sp
Give each client its own column (one client per column):
.sp
.if n \{\
.RS 4
.\}
.nf
curr_view\&.each_column {|c| c\&.length = 1 }
.fi
.if n \{\
.RE
.\}
.sp
Put (at most) three clients in every column:
.sp
.if n \{\
.RS 4
.\}
.nf
curr_view\&.each_column {|c| c\&.length = 3 }
.fi
.if n \{\
.RE
.\}
.sp
Move the red, green, and blue clients into the floating area:
.sp
.if n \{\
.RS 4
.\}
.nf
rgb = %w[red green blue]
terms = curr_view\&.clients\&.select {|c| rgb\&.include? c\&.label\&.read }
curr_view\&.areas[0]\&.push terms
.fi
.if n \{\
.RE
.\}
.sp
Slurp all floating clients into the last column:
.sp
.if n \{\
.RS 4
.\}
.nf
list = curr_view\&.areas
a, b = list\&.first, list\&.last
b\&.concat a
.fi
.if n \{\
.RE
.\}
.sp
Set the last column\(cqs layout to stacking mode:
.sp
.if n \{\
.RS 4
.\}
.nf
b\&.layout = \'stack\'
.fi
.if n \{\
.RE
.\}
.sp
Move the red, green, and blue clients to the top of the second column:
.sp
.if n \{\
.RS 4
.\}
.nf
curr_view\&.areas[2]\&.unshift terms
.fi
.if n \{\
.RE
.\}
.sp
Move the red, green, and blue clients to the bottom of the third column:
.sp
.if n \{\
.RS 4
.\}
.nf
curr_view\&.areas[3]\&.push terms
.fi
.if n \{\
.RE
.\}
.sp
Close the terminals we launched earlier:
.sp
.if n \{\
.RS 4
.\}
.nf
terms = curr_view\&.clients\&.select {|c| colors\&.include? c\&.label\&.read }
terms\&.each {|c| c\&.kill }
.fi
.if n \{\
.RE
.\}
.SS "Easy client manipulation"
.sp
Launch a few terminals so that we have something to work with:
.sp
.if n \{\
.RS 4
.\}
.nf
colors = %w[ red green blue black orange brown gray navy gold ]
colors\&.each {|c| system "xterm \-bg #{c} \-title #{c} \-e sh \-c read &" }
.fi
.if n \{\
.RE
.\}
.sp
Obtain a reference to the red client:
.sp
.if n \{\
.RS 4
.\}
.nf
red = curr_view\&.clients\&.find {|c| c\&.label\&.read == "red" }
.fi
.if n \{\
.RE
.\}
.sp
Show the red client\(cqs current tags:
.sp
.if n \{\
.RS 4
.\}
.nf
red\&.tags
.fi
.if n \{\
.RE
.\}
.sp
Add the "foo" and "bar" tags to the red client:
.sp
.if n \{\
.RS 4
.\}
.nf
red\&.tag "foo", "bar"
.fi
.if n \{\
.RE
.\}
.sp
Remove the "bar" tag from the red client:
.sp
.if n \{\
.RS 4
.\}
.nf
red\&.untag "bar"
.fi
.if n \{\
.RE
.\}
.sp
Do complex operations on the red client\(cqs tags:
.sp
.if n \{\
.RS 4
.\}
.nf
red\&.with_tags { concat %w[a b c]; push \'z\'; delete \'c\' }
.fi
.if n \{\
.RE
.\}
.sp
Focus the next client after the red client:
.sp
.if n \{\
.RS 4
.\}
.nf
red\&.next\&.focus
curr_client == red\&.next #=> true
.fi
.if n \{\
.RE
.\}
.sp
Notice that by focusing a client, we make it the current client\&.
.sp
Focus the red client on a different view:
.sp
.if n \{\
.RS 4
.\}
.nf
orig = curr_view
v = red\&.views\&.last
red\&.focus v
.fi
.if n \{\
.RE
.\}
.sp
Return to the original view:
.sp
.if n \{\
.RS 4
.\}
.nf
orig\&.focus
.fi
.if n \{\
.RE
.\}
.sp
Send the red client to the last column:
.sp
.if n \{\
.RS 4
.\}
.nf
red\&.send curr_view\&.areas\&.last
.fi
.if n \{\
.RE
.\}
.sp
Close the terminals we launched earlier:
.sp
.if n \{\
.RS 4
.\}
.nf
terms = curr_view\&.clients\&.select {|c| colors\&.include? c\&.label\&.read }
terms\&.each {|c| c\&.kill }
.fi
.if n \{\
.RE
.\}
.SS "Traversing the file system"
.sp
Show the root node of wmii\(cqs IXP file system:
.sp
.if n \{\
.RS 4
.\}
.nf
fs
.fi
.if n \{\
.RE
.\}
.sp
Show the names of all files at the root level:
.sp
.if n \{\
.RS 4
.\}
.nf
fs\&.entries
.fi
.if n \{\
.RE
.\}
.sp
Show the parent of the root node:
.sp
.if n \{\
.RS 4
.\}
.nf
fs\&.parent
.fi
.if n \{\
.RE
.\}
.sp
Show the children of the root node:
.sp
.if n \{\
.RS 4
.\}
.nf
fs\&.children
.fi
.if n \{\
.RE
.\}
.sp
Navigate into to the /lbar/ directory:
.sp
.if n \{\
.RS 4
.\}
.nf
n1 = fs\&.lbar
n2 = fs[\'lbar\']
n1 == n2 #=> true
left_bar = n1
.fi
.if n \{\
.RE
.\}
.sp
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\&.
.sp
Create a new temporary button:
.sp
.if n \{\
.RS 4
.\}
.nf
b = left_bar\&.rumai_example # path of new button
b\&.exist? #=> false
b\&.create
b\&.exist? #=> true
.fi
.if n \{\
.RE
.\}
.sp
You should now see an empty button on the left\-hand side of the wmii bar\&.
.sp
Color the button black\-on\-white and label it as "hello world":
.sp
.if n \{\
.RS 4
.\}
.nf
content = "#000000 #ffffff #000000 hello world"
b\&.write content
b\&.read == content #=> true
.fi
.if n \{\
.RE
.\}
.sp
Remove the temporary button:
.sp
.if n \{\
.RS 4
.\}
.nf
b\&.remove
b\&.exist? #=> false
.fi
.if n \{\
.RE
.\}
.SH "HACKING"
.SS "Prerequisites"
.sp
Install Ruby libraries necessary for development:
.sp
.if n \{\
.RS 4
.\}
.nf
gem install rumai \-\-development
.fi
.if n \{\
.RE
.\}
.SS "Infrastructure"
.sp
[Inochi] serves as the project infrastructure for Rumai\&. It handles tasks such as building this help manual and API documentation, and packaging, announcing, and publishing new releases\&. See its help manual and list of tasks to get started:
.sp
.if n \{\
.RS 4
.\}
.nf
inochi \-\-help     # display help manual
inochi \-\-tasks    # list available tasks
.fi
.if n \{\
.RE
.\}
.SS "$LOAD_PATH setup"
.sp
Ensure that the lib/ directory is listed in Ruby\(cqs $LOAD_PATH before you use any libraries therein or run any executables in the bin/ directory\&.
.sp
This can be achieved by passing an option to Ruby:
.sp
.if n \{\
.RS 4
.\}
.nf
ruby \-Ilib bin/rumai
irb \-Ilib \-r rumai
.fi
.if n \{\
.RE
.\}
.sp
Or by setting the $RUBYLIB environment variable:
.sp
.if n \{\
.RS 4
.\}
.nf
export RUBYLIB=lib   # bash, ksh, zsh
setenv RUBYLIB lib   # csh
set \-x RUBYLIB lib   # fish

ruby bin/rumai
irb \-r rumai
.fi
.if n \{\
.RE
.\}
.sp
Or by running Ruby through the \m[blue]\fBruby\-wrapper\fR\m[]\&\s-2\u[3]\d\s+2 tool\&.
.SS "RubyGems setup"
.sp
If you use Ruby 1\&.8 or older, then ensure that RubyGems is activated before you use any libraries in the lib/ directory or run any executables in the bin/ directory\&.
.sp
This can be achieved by passing an option to Ruby:
.sp
.if n \{\
.RS 4
.\}
.nf
ruby \-rubygems bin/rumai
irb \-rubygems \-r rumai
.fi
.if n \{\
.RE
.\}
.sp
Or by setting the $RUBYOPT environment variable:
.sp
.if n \{\
.RS 4
.\}
.nf
export RUBYOPT=\-rubygems   # bash, ksh, zsh
setenv RUBYOPT \-rubygems   # csh
set \-x RUBYOPT \-rubygems   # fish
.fi
.if n \{\
.RE
.\}
.SS "Running tests"
.sp
Simply execute the included test runner, which sets up Ruby\(cqs $LOAD_PATH for testing, loads the test/helper\&.rb file, and then evaluates all test/**/*_test\&.rb files:
.sp
.if n \{\
.RS 4
.\}
.nf
ruby test/runner
.fi
.if n \{\
.RE
.\}
.sp
Its exit status will indicate whether all tests have passed\&. It may also print additional pass/fail information depending on the testing library used in the test/helper\&.rb file\&.
.SS "Contributing"
.sp
\m[blue]\fBFork this project on GitHub\fR\m[] and send a pull request\&.
.SH "HISTORY"
.SS "Version 3\&.3\&.1 (2010\-08\-11)"
.sp
This release fixes a bug regarding the $WMII_ADDRESS environment variable\&.
.PP
\fBBug fixes\fR
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Fix incorrect syntax when amending error message about the
$WMII_ADDRESS
environment variable not being set\&.
.RE
.PP
\fBHousekeeping\fR
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Dump 9P2000 packets if
$VERBOSE, not if
$DEBUG, in unit tests\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Upgrade to Inochi 5\&.0\&.2; the help manual is now written in AsciiDoc\&.
.RE
.SS "Version 3\&.3\&.0 (2010\-07\-16)"
.sp
This release adds support for growing and nudging clients, adds an abstraction for status bar applets, and beautifies the source code\&.
.PP
\fBNew features\fR
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Add
Rumai::Barlet
class for easier status bar applets\&. It exposes the new, independent
colors
and
label
attributes introduced into the bar file format by wmii\-hg2743\&. It is also backwards\-compatible with older wmii versions where the aforementioned attributes were conjoined\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Add
Rumai::Client#grow
and
Rumai::Client#nudge
methods
\m[blue]\fBrequested by Nathan Neff\fR\m[]\&\s-2\u[4]\d\s+2\&. See "The /tag/ Hierarchy" in the wmii manpage for usage information\&.
.RE
.PP
\fBBug fixes\fR
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Add workaround for the
\m[blue]\fBwmii\-hg2734 color tuple bug\fR\m[]\&\s-2\u[5]\d\s+2
in the test suite\&.
.RE
.PP
\fBHousekeeping\fR
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Found real names for some anonymous contributors\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Clean up the source code formatting and organization\&.
.RE
.SS "Version 3\&.2\&.4 (2010\-06\-06)"
.sp
This release fixes an IXP transport layer bug under Ruby 1\&.8\&.7\&.
.PP
\fBBug fixes\fR
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}

IO#ungetc
does not accept a one\-character string in Ruby 1\&.8\&.7\&. Thanks to Sebastian Chmielewski for reporting
\m[blue]\fBthis issue\fR\m[]\&\s-2\u[6]\d\s+2\&.
.RE
.SS "Version 3\&.2\&.3 (2010\-04\-28)"
.sp
This release adds a UNIX manual page and requires wmii 3\&.9 or newer\&.
.PP
\fBBug fixes\fR
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}

Rumai::Area#unshift
needs wmii 3\&.9 or newer\&. The help manual has been corrected accordingly\&. Thanks to Mattia Gheda for reporting
\m[blue]\fBthis issue\fR\m[]\&\s-2\u[7]\d\s+2\&.
.RE
.PP
\fBHousekeeping\fR
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Upgrade to Inochi 3\&.0\&.0\&. Run
rumai \-\-help
to see the UNIX manual page!
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Move IRB session creation code from rumai(1) into
rumai/irb
sub\-library\&.
.RE
.SS "Version 3\&.2\&.2 (2010\-04\-01)"
.sp
This release fixes some warnings that appeared during installation and performs some minor housekeeping\&.
.PP
\fBBug fixes\fR
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Warnings of the following form appeared during gem installation:
.sp
.if n \{\
.RS 4
.\}
.nf
Unrecognized directive \'\&.\&.\&.\' in lib/rumai/inochi\&.yaml
.fi
.if n \{\
.RE
.\}
.sp
Thanks to Mattia Gheda for reporting this\&.
.RE
.PP
\fBHousekeeping\fR
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Upgrade to Inochi 2\&.0\&.0\-rc2 for managing this project\&.
.RE
.SS "Version 3\&.2\&.1 (2010\-03\-22)"
.sp
This release improves multi\-threading support in Rumai\(cqs pure\-Ruby implementation of the IXP file\-system interface\&.
.PP
\fBThank you\fR
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Kenneth De Winter reported the issue of status bar applets not refreshing according to their prescribed schedule (this is particularly noticable in the clock applet) and verified my fix for the problem\&.
.RE
.PP
\fBBug fixes\fR
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Perform a blocking I/O read to recieve a 9P2000 message in
Rumai::IXP::Agent#recv
only if recieve buffer is empty\&. This gives other threads a chance to check the recieve buffer for their response\&. instead of being blocked by us as we greedily hold on to the 9P2000 message stream until our expected response arrives\&.
.RE
.PP
\fBHousekeeping\fR
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Upgrade to Inochi 2\&.0\&.0\-rc1 and Dfect 2\&.0\&.0\&.
.RE
.SS "Version 3\&.2\&.0 (2009\-11\-17)"
.sp
This release adds a new automated view arrangement, simplifies the IXP transport layer, and cleans up the code and API documentation\&.
.PP
\fBNew features\fR
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Add
Rumai::View#arrange_in_stacks
automated view arrangement\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Convert
:stack
and
:max
arguments into wmii 3\&.9 syntax in
Rumai::Area#layout=\&.
.RE
.PP
\fBBug fixes\fR
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Rewrote IXP transport layer (Rumai::IXP::Agent) to
\fInot\fR
use a background thread, according to
the XCB cookie approach\&.
.RE
.PP
\fBHousekeeping\fR
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Clean up some code and API docs\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Reduce amount of string concatenation in
Struct#to_9p\&.
.RE
.SS "Version 3\&.1\&.1 (2009\-11\-16)"
.sp
This release fixes bugs in automated view arrangements and updates the user manual\&.
.PP
\fBBug fixes\fR
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
The relative order of clients was not being preserved during view arrangements\&. Thanks to Nathan Neff for reporting this\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Focus on the current view was lost after automated view arrangement was applied if the current view was not the first view on which the initially focused (before the automated arrangement was applied) client appeared\&.
.RE
.SS "Version 3\&.1\&.0 (2009\-10\-02)"
.sp
This release adds new methods, fixes some bugs, and revises the manual\&.
.PP
\fBNew features\fR
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Add
Client#float
methods to manipulate floating status\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Add
Client#manage
methods to manipulate managed status\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
The
Client#tags=
method now accepts
\fI~\fR
and
\fI!\fR
tag prefixes\&.
.RE
.PP
\fBBug fixes\fR
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
There is no
View#move_focus
method, only
View#select\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Assertion failure in test suite because all files in
/rbar
(inside wmii\(cqs IXP filesystem) contain an automatic color header when read\&.
.RE
.PP
\fBHousekeeping\fR
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Use simpler Copyright reminder at the top of every file\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Open source is for fun, so speak of "related works", not "competitors"\&.
.RE
.SS "Version 3\&.0\&.0 (2009\-05\-11)"
.sp
This release revises method names, adds new methods, and fixes a bug\&.
.PP
\fBIncompatible changes\fR
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Rename
#toggle_
methods to use
!
suffix in their names\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Rename
#float
methods to
#floating\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Rename
View#floater
method to
View#floating_area\&.
.RE
.PP
\fBNew features\fR
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Add
Client#stick
methods to manipulate sticky status\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Add
Client#fullscreen
methods to manipulate fullscreen status\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Add
Client#slay
method which is a forceful version of
#kill\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Add
View#select
method to move focus relatively inside a view\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Add
Area::floating
method for symmetry with
Area::curr\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Add
View#managed_area
aliases for
View#column
methods\&.
.RE
.PP
\fBBug fixes\fR
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Fix error when unzooming clients from temporary view\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Fix code that launches temporary terminals in the Tutorial\&.
.sp
Use the
/bin/sh
version of the read(1) command for portability\&.
.RE
.PP
\fBHousekeeping\fR
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Use
Client#send
instead of
#swap
in automated arrangements because it causes less traffic on /event/\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Add old release notes from blog to user manual\&.
.RE
.SS "Version 2\&.1\&.0 (2009\-05\-09)"
.sp
This release improves client arrangement, fixes several bugs, and cleans up the code\&.
.PP
\fBThank you\fR
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Simon Hafner reported several bugs\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Michael Andrus verified bug fixes\&.
.RE
.PP
\fBNew features\fR
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Focus is now restored on the initially focused client after applying automated client arrangements\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
The
push(),
insert(), and
unshift()
instance methods of the
Rumai::Area
class now preserve the order of inserted clients\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
The
Rumai::View#arrange_in_grid()
method now accepts 1 as a parameter\&. This invocation causes every column to contain at most 1 client\&.
.RE
.PP
\fBBug fixes\fR
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Fix error caused by focusing the top/bottom client in the destination area before sending new clients into that area\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Fix error when importing clients into an empty area\&.
.RE
.PP
\fBHousekeeping\fR
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Use snake_case instead of camelCase for variable names\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Add copyright notice at the top of every file\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Plenty of code formatting and beautification\&.
.RE
.SS "Version 2\&.0\&.2 (2009\-02\-26)"
.sp
This release fixes a connection bug\&.
.PP
\fBBug fixes\fR
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
wmii omits the fractional portion of
$DISPLAY
in its socket file path\&. Rumai was trying to connect with the entire
$DISPLAY
value (including the fractional portion) and thus could not find wmii\(cqs socket file\&.
.sp
Thanks to Simon Hafner for reporting this bug\&.
.RE
.SS "Version 2\&.0\&.1 (2009\-01\-25)"
.sp
This release simplifies project administrivia using [Inochi], improves the unit tests, and revises the user manual\&.
.PP
\fBBug fixes\fR
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
The
rumai/ixp/message
library\(cqs unit test failed if
/rbar/status
did not already exist in wmii\&.
.RE
.PP
\fBHousekeeping\fR
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Store IXP socket address in
Rumai::IXP_SOCK_ADDR\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Added missing test cases for (TR)create and (TR)remove messages in the unit test for the
rumai/ixp/message
library\&.
.RE
.SS "Version 2\&.0\&.0 (2008\-02\-04)"
.sp
This release adds support for wmii 3\&.6, improves the performance of the IXP library, and fixes some bugs\&.
.PP
\fBThank you\fR
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Christoph Blank tested Rumai 1\&.0\&.0 under wmii 3\&.6 and reported bugs\&.
.RE
.PP
\fBIncompatible changes\fR
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
wmii version 3\&.6 or newer is now required\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
The
Rumai::IXP::Agent::FidStream#read_partial
method has been replaced by
Rumai::IXP::Agent::FidStream#read(true)
for efficiency\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
The
Rumai::IXP::Agent::FidStream#write
method no longer writes to the beginning of the stream\&. Instead, it writes to the current position in the stream\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
The
Rumai::View#floating_area
method has been renamed to
Rumai::View#floater
for brevity\&.
.RE
.PP
\fBNew features\fR
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Added several more methods (such as
rewind,
pos=,
eof?, and so on) from Ruby\(cqs IO class to the
Rumai::IXP::Agent::FidStream
class\&.
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Added the
Rumai::Client#kill
method to simplify client termination\&.
.RE
.PP
\fBBug fixes\fR
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Fixed a race condition in
Rumai::Agent#talk
which would cause Rumai to hang when multiple threads used it\&.
.RE
.SS "Version 1\&.0\&.0 (2008\-01\-26)"
.sp
This is the first release of Rumai, the evolution of \m[blue]\fBwmii\-irb\fR\m[]\&\s-2\u[8]\d\s+2, which lets you manipulate the [wmii] window manager through [Ruby]\&. Enjoy!
.SH "AUTHORS"
.sp
Suraj N\&. Kurapati
.SS "Credits"
.sp
Christoph Blank, Kenneth De Winter, Mattia Gheda, Michael Andrus, Nathan Neff, Sebastian Chmielewski, Simon Hafner
.SS "License"
.sp
(the ISC license)
.sp
Copyright 2006 Suraj N\&. Kurapati <\m[blue]\fBsunaku@gmail\&.com\fR\m[]\&\s-2\u[9]\d\s+2>
.sp
Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies\&.
.sp
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS\&. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE\&.
.SH "SEE ALSO"
.sp
irb(1), wmiir(1), wmii(1)
.SS "References"
.TS
tab(:);
lt lt
lt lt
lt lt
lt lt
lt lt
lt lt
lt lt.
T{
.sp
[Inochi]
T}:T{
.sp
\m[blue]\fBhttp://snk\&.tuxfamily\&.org/lib/inochi/\fR\m[]
T}
T{
.sp
[libixp]
T}:T{
.sp
\m[blue]\fBhttp://libs\&.suckless\&.org/libixp\fR\m[]
T}
T{
.sp
[p9p]
T}:T{
.sp
\m[blue]\fBhttp://cm\&.bell\-labs\&.com/magic/man2html/5/intro\fR\m[]
T}
T{
.sp
[RubyGems]
T}:T{
.sp
\m[blue]\fBhttp://rubygems\&.org\fR\m[]
T}
T{
.sp
[Ruby]
T}:T{
.sp
\m[blue]\fBhttp://ruby\-lang\&.org\fR\m[]
T}
T{
.sp
[wmii]
T}:T{
.sp
\m[blue]\fBhttp://wmii\&.suckless\&.org\fR\m[]
T}
T{
.sp
[XCB\-cookies]
T}:T{
.sp
\m[blue]\fBhttp://www\&.x\&.org/releases/X11R7\&.5/doc/libxcb/tutorial/#requestsreplies\fR\m[]
T}
.TE
.sp 1
.SH "NOTES"
.IP " 1." 4
my personal
.RS 4
\%http://github.com/sunaku/wmiirc
.RE
.IP " 2." 4
many others
.RS 4
\%http://github.com/sunaku/wmiirc/network
.RE
.IP " 3." 4
ruby-wrapper
.RS 4
\%http://github.com/chneukirchen/rup/blob/master/ruby-wrapper
.RE
.IP " 4." 4
requested by Nathan Neff
.RS 4
\%http://github.com/sunaku/rumai/issues/6
.RE
.IP " 5." 4
wmii-hg2734 color tuple bug
.RS 4
\%http://code.google.com/p/wmii/issues/detail?id=206
.RE
.IP " 6." 4
this issue
.RS 4
\%http://github.com/sunaku/rumai/issues/3
.RE
.IP " 7." 4
this issue
.RS 4
\%http://github.com/sunaku/wmiirc/issues/8
.RE
.IP " 8." 4
wmii-irb
.RS 4
\%http://article.gmane.org/gmane.comp.window-managers.wmii/1704
.RE
.IP " 9." 4
sunaku@gmail.com
.RS 4
\%mailto:sunaku@gmail.com
.RE