AwesomeWM compatibility

SomeWM 2.0 develops independently of AwesomeWM. Shared Lua names do not guarantee identical behaviour; the reference for this version defines the supported API.

The 1.4 and 2.x lines

The 1.4 line follows AwesomeWM master. Its purpose is to preserve the upstream configuration API on Wayland. Features developed for 2.x are not routinely backported; parity with AwesomeWM is the reason for an exception.

The 2.x line keeps the Lua configuration model while developing its libraries and compositor independently. Existing configurations are preserved where possible, but a shared name is not a promise of identical arguments, defaults or signal timing.

The version defines the contract

The compatibility reference records platform differences and unsupported behaviour for this version. Individual API references describe supported properties, methods and signals. Linked AwesomeWM documentation provides background for inherited APIs.

Upgrade from 1.4 to 2.0 describes configuration changes between SomeWM releases. Migrating from AwesomeWM covers the move from X11 tools and assumptions to Wayland.

Wayland vs X11 explains protocol differences. Architecture explains the compositor and its Lua libraries.