improve install-wmiirc-lua option parsing and verbosity
[wmiirc-lua.git] / doc / client-modes
blob767ad744ef04bf5197348c45488038546764c07a
1 About
2 ======
3 wmii tracks several things about each X client window.  wmiirc-lua goes
4 a bit further and can set different modes on each client.  The modes are
5 tracked on a per client (aka window) basis and do not influence other
6 clients.  Currently the following modes are supported:
8   - raw mode - bypass wmii key-bindings for selected programs
9   - suspend mode - send SIGSTOP when unfocused, SIGCONT when focused
11 Modes can be toggled on and off by using Mod1-f shortcut.
13 The mode of the current window is displayed on the wmii status bar.
14 When all modes are disabled the widget will show -- indicating that all
15 available modes are disabled.  The dashes will be replaced with the
16 first character of the mode when that mode is enabled for the current
17 client.  For example: r- would indicate that raw mode was enabled, but
18 suspend mode was disabled.
21 raw mode
22 =========
23 Raw mode is tracked for each client, and can be either on or off.  When
24 a focused client has raw mode enabled all input except for Mod4-space is
25 passed to the application and not wmii.  Otherwise, all wmiirc-lua
26 key-bindings are handled as expected.
28 Raw mode can be entered using Mod4-space or Mod1-f (and selecting raw),
29 but can only be disabled by Mod4-space.  Note that you can also switch
30 focus with the mouse to regain key-bindings.
32 suspend mode
33 =============
34 Suspend mode is tracked for each process (ie the PID), and can be either
35 enabled or disabled.  When a client with suspend mode enabled loses
36 focus, it is sent the STOP signal -- essentially suspending the process.
37 Any time that a client whose process was previously suspended gains
38 focus, it is sent the CONT signal.
40 Suspend mode can be toggled bu using Mod1-f (and selecting suspend).
44 vim: set ts=8 et sw=8 tw=72