Skip to main content

Lua Libraries

SomeWM implements AwesomeWM's Lua API. The official AwesomeWM API documentation is the primary reference for all standard libraries.

This section documents SomeWM-specific extensions and notes any behavioral differences from AwesomeWM.

Core Libraries

LibraryPurposeDocs
awfulWindow management, keybindings, layouts, client rulesAwesomeWM docs ¹
beautifulTheming and appearanceAwesomeWM docs
wiboxWidgets, containers, and the wibarAwesomeWM docs
naughtyNotificationsAwesomeWM docs
gearsUtilities (timers, shapes, colors, filesystem)AwesomeWM docs ¹

¹ awful and gears span multiple categories in the AwesomeWM docs (input_handling, libraries, core_components, etc.)

SomeWM Extensions

These APIs are unique to SomeWM and not available in AwesomeWM:

APIPurpose
awful.inputRuntime input device configuration
somewm-clientIPC command-line tool

Other References

ReferenceDescription
Key NamesModifier keys and key name reference
SignalsEvent signals by object type
Default KeybindingsBuilt-in keyboard shortcuts