SomeWM

SomeWM is a Wayland compositor that brings AwesomeWM's Lua API to Wayland, built on wlroots. The goal is 100% compatibility with AwesomeWM's Lua configuration.

About These Docs

SomeWM targets AwesomeWM git (not the v4.3 stable release). The official AwesomeWM API documentation applies directly to SomeWM and remains the primary reference for the Lua API.

These docs focus on:

• Getting started with SomeWM specifically
• SomeWM-only features not in AwesomeWM (like awful.input and the SNI systray)
• Wayland differences and migration notes for AwesomeWM users

Quick Links

New to SomeWM?

• Installation Guide
• Launch
• Basics

Coming from AwesomeWM?

• Migration Guide
• Wayland vs X11
• Compatibility

SomeWM-Only Features

SomeWM extends AwesomeWM with Wayland-native features:

• awful.input - Runtime input device configuration (tap-to-click, natural scrolling, pointer speed)
• somewm-client - IPC CLI tool for external control (~45 commands)
• SNI Systray - Modern D-Bus tray protocol (StatusNotifierItem)

Current Status

SomeWM is in active development. Most AwesomeWM functionality works, including:

• Window management and tiling layouts
• Wibox widgets and titlebars
• Keybindings and mouse bindings
• Tags and screens
• Notifications (naughty)
• Theming

See Current Limitations for features not yet implemented.