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
| Library | Purpose | Docs |
|---|---|---|
| awful | Window management, keybindings and layouts | AwesomeWM docs ¹ |
| beautiful | Theming and appearance | AwesomeWM docs |
| wibox | Widgets, containers, and the wibar | AwesomeWM docs |
| naughty | Notifications | AwesomeWM docs |
| gears | Utilities (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:
| API | Purpose |
|---|---|
| awful.input | Runtime input device configuration |
| somewm-client | IPC command-line tool |
| Tag Persistence | Saved state and monitor reconnection |
| Lockscreen Module | Bundled Lua lockscreen UI |
| Carousel | Scrollable tiling layouts |
| output | Monitor configuration and lifecycle |
| Lock, idle, and DPMS | Session locking and display power |
| Shadows | Client and wibox shadows |
| layer_surface | External panels and launchers |
Other References
| Reference | Description |
|---|---|
| Screen | Geometry, scaling and lifecycle |
| Wayland Protocols | Advertised protocol versions |
| Config Anatomy | Map of the default config |
| Key Names | Modifier keys and key name reference |
| Signals | Event signals by object type |
| Default Keybindings | Shortcuts in the default config |