Skip to main content
Version: 2.1

Lua Libraries

SomeWM 2.1 uses AwesomeWM-style Lua APIs with its own extensions and removals. Use this version's reference alongside the compatibility list.

Core Libraries​

LibraryPurposeDocs
awfulWindow management, keybindings and layoutsAwesomeWM 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
Tag PersistenceSaved state and monitor reconnection
Lockscreen ModuleBundled Lua lockscreen UI
CarouselScrollable tiling layouts
outputMonitor configuration and lifecycle
Lock, idle, and DPMSSession locking and display power
ShadowsClient and wibox shadows
layer_surfaceExternal panels and launchers

Other References​

ReferenceDescription
ScreenGeometry, scaling and lifecycle
Wayland ProtocolsAdvertised protocol versions
Config AnatomyMap of the default config
Key NamesModifier keys and key name reference
SignalsEvent signals by object type
Default KeybindingsShortcuts in the default config