Reference
Reference pages state what exists and what it does: properties, methods, signals, defaults and limits. For how to do something, use the how-to guides.
Libraries
| Library | Covers | Upstream |
|---|---|---|
| awful | Window management, keybindings, layouts, the bar and popups | AwesomeWM docs |
| beautiful | Theme variables and appearance | AwesomeWM docs |
| gears | Timers, shapes, colors, files and other utilities | AwesomeWM docs |
| naughty | Notifications | AwesomeWM docs |
| wibox | Widgets, containers, layouts and the window that shows them | AwesomeWM docs |
The compatibility page lists what SomeWM removes, adds and changes against AwesomeWM.
Objects
| Object | Covers |
|---|---|
| screen | Geometry, scale, workarea and lifecycle |
| output | The physical connector behind a screen |
| layer_surface | External panels and launchers using layer shell |
Everything else
| Page | Covers |
|---|---|
| All keysyms | Every key name SomeWM accepts |
| Anatomy of rc.lua | A map of the default config, section by section |
| AwesomeWM compatibility | Removed, added and changed behavior |
| Default keybindings | Every shortcut in the default config |
| Key names | Modifiers and the common key names |
| Lock, idle and DPMS | Session locking and display power |
| Lockscreen module | The bundled lock screen module |
| Shadows | Shadow properties on clients and wiboxes |
| Signals | Every signal by object, with its arguments |
| somewm-client | Every IPC command |
| Tag persistence | Saved tag state and its signals |
| Wayland protocols | Protocols and versions SomeWM advertises |