https://github.com/bioe007/awesome-revelation

Show all clients per screen in Awesome window manager
https://github.com/bioe007/awesome-revelation

List: awesome-revelation

Last synced: 3 months ago
JSON representation

Show all clients per screen in Awesome window manager

• Host: GitHub
• URL: https://github.com/bioe007/awesome-revelation
• Owner: bioe007
• License: lgpl-3.0
• Created: 2011-08-23T20:12:55.000Z (over 13 years ago)
• Default Branch: master
• Last Pushed: 2015-04-05T11:07:08.000Z (about 10 years ago)
• Last Synced: 2024-10-29T15:43:48.607Z (7 months ago)
• Language: Lua
• Homepage:
• Size: 177 KB
• Stars: 53
• Watchers: 4
• Forks: 44
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-awesomewm-modules-widgets-and-libraries - awesome-revelation
• awesome-awesomewm-modules-widgets-and-libraries - awesome-revelation

README

        
# 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 

### Contributions, many thanks!

    * Nikola Petrov 

### Original authors

    * Espen Wiborg 

    * Julien Danjou 

## License

    Revelation is released under the GNU General Public License, version 3.

    (c) 2009-12 Perry Hargrave

    (c) 2008 Espen Wiborg, Julien Danjou