Skip to main content
Version: 2.2 (dev)

AwesomeWM compatibility

SomeWM 2.1 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 retains the Lua configuration model, but may change arguments, defaults and 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 2.0 to 2.1 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. How SomeWM draws explains why clients and widgets share one layout tree.