/usr/share/awesome/lib/revelation/README.md is in awesome-extra 2012061101.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 | # revelation.lua
Provides Mac OSX like 'Expose' view of all clients.
## Use
### Installation
(From user's awesome configuration directory, usually ~/.config/awesome)
1. Clone repository:
git clone https://github.com/bioe007/awesome-revelation.git
2. put near the top of your rc.lua `require("revelation")`
3. Make a global keybinding (ModKey + e) for revelation in your rc.lua:
globalkeys = awful.util.table.join(
awful.key({ modkey, }, "Left", awful.tag.viewprev ),
awful.key({ modkey, }, "Right", awful.tag.viewnext ),
awful.key({ modkey, }, "Escape", awful.tag.history.restore),
awful.key({ modkey}, "e", revelation), -- Insert this line
awful.key({ modkey, }, "j",
function ()
awful.client.focus.byidx( 1)
if client.focus then client.focus:raise() end
end),
**NOTE:** Always double check this key binding syntax against the version of
Awesome that you are using.
4. Reload rc.lua and try the keybinding __Modkey + e__
It should bring all clients to the current tag and set the layout to fair. You
can focus clients with __cursor__ or __hjkl__ keys then press __Enter__ or
press the mouse right button to select or __Escape__ to abort.
This is a modification of the original awesome library that implemented
expose like behavior.
### Configuration
Revelation's configuration is done through direct access to the module's
`config` table.
There are two basic settings, shown with default values:
-- The name of the tag created for the 'exposed' view
revelation.config.tag_name = 'Revelation'
-- A table of matcher functions (used in client filtering)
revelation.match.exact = awful.rules.match
revelation.match.any = awful.rules.match_any
The rule matching functions must conform to `awful.rules.match` prototypes.
For client matching rules, we follow the same syntax as awful.rules with one
perk; if `rule.any == true`, then we call the `config.match.any` function.
### Examples
All clients:
awful.key({modkey}, "e", revelation)
To match all urxvt terminals:
awful.key({modkey}, "e", function()
revelation({class="URxvt"})
end)
To match clients with class 'foo' or 'bar':
awful.key({modkey}, "e", function()
revelation({
class={"foo", "bar"},
any=true
})
end)
## Credits
### Maintenance
* Perry Hargrave <resixian@gmail.com>
### Contributions, many thanks!
* Nikola Petrov <nikolavp@gmail.com>
### Original authors
* Espen Wiborg <espenhw@grumblesmurf.org>
* Julien Danjou <julien@danjou.info>
## License
Revelation is released under the GNU General Public License, version 3.
(c) 2009-12 Perry Hargrave
(c) 2008 Espen Wiborg, Julien Danjou
|