Skip to main content
Version: 2.0

awful

The awful library is the core of AwesomeWM's window management functionality. It handles keybindings, mouse bindings, client rules, layouts, tags, and more.

Upstream documentation: The awful library spans multiple sections in the AwesomeWM docs:

Key Modules​

ModulePurpose
awful.keyDefine keyboard shortcuts
awful.buttonDefine mouse bindings
awful.layoutTiling layouts
awful.tagTag (workspace) management
awful.clientClient (window) operations
awful.screenScreen management
awful.spawnLaunch applications
awful.promptInput prompts
awful.menuContext menus
awful.screenshotScreenshot capture and interactive snipping

Client rules live in ruled.client, not awful. SomeWM 2.0 deleted the awful.rules compatibility shim. See Client Rules.

SomeWM Extensions​

ModuleDescription
awful.inputRuntime input device configuration (pointer, keyboard)

Behavioral Notes​

SomeWM 2.0 removed legacy module aliases and functional helpers, including awful.rules and several awful.tag and awful.client wrappers. See removed API replacements. Wayland vs X11 explains platform differences that also affect some operations.