From 3c9a05dbe6e3f7db6b144a554d4c9f85b5f15016 Mon Sep 17 00:00:00 2001
From: Bart Trojanowski <bart@jukie.net>
Date: Sat, 13 Oct 2007 13:42:24 -0400
Subject: [PATCH] documentation for new client modes

---
 TODO             |  9 ---------
 doc/client-modes | 45 +++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 45 insertions(+), 9 deletions(-)
 create mode 100644 doc/client-modes

diff --git a/TODO b/TODO
index e1f174a..7075f59 100644
--- a/TODO
+++ b/TODO
@@ -11,7 +11,6 @@ for 0.2 release
 
 for 0.3 release
     - core
-        - support for "raw mode" like Mod4-space in wmii+ruby
         - resize windows/columns with Mod1-[+-] or Mod1-Ctrl-[hjkl]
         - action and program history (bring up the last X choices in
           Mod1-a and Mod1-p)
@@ -72,12 +71,4 @@ future
             - sending input to all windows in that group
             - would be useful for a cluster, etc.
 
-        - 'suspend'
-            - add key-bindings to suspend/resume application with
-              SIGSTOP/SIGCONT
-            - probably should add wmii support to decorate windows
-              differently when in this state
-
-
-
 vim: set ts=8 et sw=8 tw=72
diff --git a/doc/client-modes b/doc/client-modes
new file mode 100644
index 0000000..767ad74
--- /dev/null
+++ b/doc/client-modes
@@ -0,0 +1,45 @@
+About
+======
+wmii tracks several things about each X client window.  wmiirc-lua goes
+a bit further and can set different modes on each client.  The modes are
+tracked on a per client (aka window) basis and do not influence other
+clients.  Currently the following modes are supported:
+
+  - raw mode - bypass wmii key-bindings for selected programs
+  - suspend mode - send SIGSTOP when unfocused, SIGCONT when focused
+
+Modes can be toggled on and off by using Mod1-f shortcut.
+
+The mode of the current window is displayed on the wmii status bar.
+When all modes are disabled the widget will show -- indicating that all
+available modes are disabled.  The dashes will be replaced with the
+first character of the mode when that mode is enabled for the current
+client.  For example: r- would indicate that raw mode was enabled, but
+suspend mode was disabled.
+
+
+raw mode
+=========
+Raw mode is tracked for each client, and can be either on or off.  When
+a focused client has raw mode enabled all input except for Mod4-space is
+passed to the application and not wmii.  Otherwise, all wmiirc-lua
+key-bindings are handled as expected.
+
+Raw mode can be entered using Mod4-space or Mod1-f (and selecting raw),
+but can only be disabled by Mod4-space.  Note that you can also switch
+focus with the mouse to regain key-bindings.
+
+suspend mode
+=============
+Suspend mode is tracked for each process (ie the PID), and can be either
+enabled or disabled.  When a client with suspend mode enabled loses
+focus, it is sent the STOP signal -- essentially suspending the process.
+Any time that a client whose process was previously suspended gains
+focus, it is sent the CONT signal.
+
+Suspend mode can be toggled bu using Mod1-f (and selecting suspend).
+
+
+
+vim: set ts=8 et sw=8 tw=72
+
-- 
2.11.4.GIT