commit 505f5fcc75f8a643c0d44789c807e9fa3b6ad15b
parent ee155bf11a286a31b35198b8fddfe6c0de2543ff
Author: Suraj N. Kurapati <sunaku@gmail.com>
Date: Mon, 11 Sep 2006 05:50:05 -0700
[project @ 56373f3e6b95690f8e2b4d82c18f996a43e09c4b]
[project @ 63]
add rdoc comments
Diffstat:
4 files changed, 23 insertions(+), 4 deletions(-)
diff --git a/rc.rb b/rc.rb
@@ -1,3 +1,4 @@
+## Utility methods used by wmiirc.
=begin
Copyright 2006 Suraj N. Kurapati
@@ -16,8 +17,6 @@
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
=end
-## Utility methods
-
require 'find'
# Returns a list of program names available in the given paths.
diff --git a/wm.rb b/wm.rb
@@ -1,3 +1,4 @@
+# Abstractions for graphical stuff in wmii.
=begin
Copyright 2006 Suraj N. Kurapati
diff --git a/wmiirc b/wmiirc
@@ -1,5 +1,5 @@
#!/usr/bin/ruby -w
-# Ruby-based configuration file for wmii-3.
+# Ruby-based configuration file for wmii.
=begin
Copyright 2006 Suraj N. Kurapati
@@ -70,16 +70,34 @@ EOS
## KEY CONFIGURATION
+# Symbolic name of modifier key.
MODKEY = 'Mod1'
+
+# Symbolic name for up direction key.
UP = 't'
+
+# Symbolic name for down direction key.
DOWN = 'n'
+
+# Symbolic name for left direction key.
LEFT = 'h'
+
+# Symbolic name for right direction key.
RIGHT = 's'
+
+# Keycode for the primary mouse button.
PRIMARY = 1
+
+# Keycode for the middle mouse button.
MIDDLE = 2
+
+# Keycode for the secondary mouse button.
SECONDARY = 3
+
+# Initial key sequence used by all shortcuts.
ACTION = "#{MODKEY}-Control-"
+
FOCUS = ACTION
SEND = "#{ACTION}m,"
SWAP = "#{ACTION}w,"
@@ -89,6 +107,7 @@ MENU = ACTION
PROGRAM = ACTION
+# Shortcut key sequences and their associated logic.
SHORTCUTS = {
# focus previous view
"#{FOCUS}comma" => lambda do
diff --git a/wmiish b/wmiish
@@ -1,5 +1,5 @@
#!/usr/bin/ruby
-# This is an interactive Ruby shell for wmiirc.
+# This is an interactive Ruby shell for wmii.
# - Access & manipulate wmii via the *W* constant.
# - Press the TAB key for command completion.
=begin
