https://github.com/gvalkov/awesome-ezconfig

Easier key and button setup for awesome wm
https://github.com/gvalkov/awesome-ezconfig

List: awesome-ezconfig

Last synced: 4 months ago
JSON representation

Easier key and button setup for awesome wm

• Host: GitHub
• URL: https://github.com/gvalkov/awesome-ezconfig
• Owner: gvalkov
• License: gpl-2.0
• Created: 2014-07-01T18:58:13.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2014-07-01T19:23:35.000Z (over 10 years ago)
• Last Synced: 2024-05-20T20:43:32.780Z (9 months ago)
• Language: Lua
• Size: 156 KB
• Stars: 3
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

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

README

        
awesome-ezconfig

================

Easier key and button setup for the [Awesome][0] tiling window

manager. Inspired by [Xmonad's EZConfig][1] and Emacs's kbd function.

Usage

=====

```lua

ezconfig = require('ezconfig')

ezconfig.modkey = 'Mod4'

ezconfig.altkey = 'Mod1'

globalkeys = ezconfig.keytable.join({

   ['M-'] = awful.tag.viewprev,

   ['M-S-j'] = {awful.client.swap.byidx, 1},

   ['M-C-k'] = {awful.screen.focus_relative, -1},

   ['M-m'] = function () menus.main:show() end,

})

-- The above is functionally equivalent to:

key = ezconfig.key

globalkeys = awful.util.table.join(

   key('M-', awful.tag.viewprev),

   key('M-S-j', {awful.client.swap.byidx, 1}),

)

-- Which is in turn equivalent to:

globalkeys = awful.util.table.join(

   awful.key({modkey}, 'Left', awful.tag.viewprev),

   awful.key({modkey, 'Shift'}, 'j', function () awful.client.swap.byidx(1) end),

)

-- It is also possible to configure mouse buttons:

clientbuttons = ezconfig.btntable.join({

   ['1'] = function (c) client.focus = c; c:raise() end,

   ['M-1'] = awful.mouse.client.move,

   ['M-3'] = awful.mouse.client.resize,

})

```

License

=======

This lua module is licensed under the same terms as Awesome itself -

the [GNU GPLv2][2].

[0]: http://awesome.naquadah.org/

[1]: http://xmonad.org/xmonad-docs/xmonad-contrib/XMonad-Util-EZConfig.html

[2]: https://raw.githubusercontent.com/gvalkov/awesome-ezconfig/master/LICENSE