awesome-ez/README.md

47 lines
979 B
Markdown
Raw Normal View History

2019-05-23 16:49:35 +02:00
# awesome-ez
awesome-ez is a library for [Awesome](https://github.com/awesomeWM/awesome)
window manager that aims to simplify the creation of key and button bindings.
It is based on code from the old Awesome wiki.
## Usage
Require the library:
```lua
local ez = require("awesome-ez")
```
Use `ez.keytable` to define key bindings:
```lua
local globalkeys = ez.keytable {
["M-<Return>"] = {awful.spawn, "xterm"},
...
}
```
Use `ez.btntable` to define button bindings:
```lua
local clientbtns = ez.btntable {
["1"] = function (c) client.focus = c end,
["M-1"] = awful.mouse.client.move,
["M-3"] = awful.mouse.client.resize,
}
```
### Modifiers
The following modifiers can be identified by their shorthand characters
in key and button definitions:
Modifier | Character
-------- | ---------
Mod4 | M
Mod1 | A
Shift | S
Control | C
## License
awesome-ez is licensed under the GNU General Public License v3.0 or later
(see [LICENSE](LICENSE)).