AwesomeWM library for simplifying key and button binding definitions

awesomewm lua

You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

Go to file

James Reed 4c02e1c057 rockspec: Update source URLs		2 years ago
rockspec	rockspec: Update source URLs	2 years ago
.gitignore	Add .gitignore	4 years ago
Dockerfile.toolbox	toolbox: Use lua-toolbox	3 years ago
LICENSE	Change license to MIT	4 years ago
Makefile	Makefile: Add target to serve gh-pages with python	4 years ago
README.md	README: Update install instructions	2 years ago
config.ld	Initial commit	5 years ago
init.lua	Export `modifiers` table	2 years ago

README.md

awesome-ez

awesome-ez is a library for Awesome window manager that aims to simplify the creation of key and button bindings. It is based on code from the old Awesome wiki.

Installation

Install the latest stable release with luarocks:

luarocks install awesome-ez

Usage

Require the library:

local ez = require("awesome-ez")

Use ez.keytable to define key bindings:

local globalkeys = ez.keytable {
    ["M-Return"] = {awful.spawn, "xterm"},
    ...
}

Use ez.btntable to define button bindings:

local clientbtns = ez.btntable {
    ["1"] = function (c) client.focus = c end,
    ["M-1"] = awful.mouse.client.move,
    ["M-3"] = awful.mouse.client.resize,
}

Binding definition strings consist of modifier characters and a key or button separated by hyphens, e.g. M-S-x is the combination of Mod4, Shift, and the x key.

See the API documentation for descriptions of all functions.

Modifiers

The following modifiers can be identified by their default shorthand characters in key and button definitions:

Character	Modifier
M	Mod4
A	Mod1
S	Shift
C	Control

The modifiers table can be customized:

ez.modifiers["M"] = "Mod1"

License

This project is licensed under the MIT License (see LICENSE).