Skip to main content
Version: 2.2 (dev)

SomeWM Documentation

SomeWM is a programmable Wayland compositor built on AwesomeWM's Lua configuration model. Its widget system lets you build the desktop itself: bars, launchers, popups, titlebars and notifications. Make a clock open a calendar, build a control panel for your system, or write your own window layout. Start with the supplied configuration and add what you need.

Start here​

Starting pointRead next
I want to try SomeWMRun it in a window without logging out, or install and launch it.
I have a running session and want to build somethingBuild a clock widget. Create a Lua module, see it on screen, add interaction, then put it in your bar.
I have a SomeWM 2.0 configurationUpgrade to 2.1, including how to port custom widgets.
I have an AwesomeWM configurationMigrate from AwesomeWM and check the widget changes.

The four sections​

SectionGo there when
Tutorialsyou want to build something and learn on the way: a clock, a bar, a theme
How-to guidesyou have one task: rounded corners, a second monitor, a lock screen
Referenceyou need what a class, object or command can do, property by property
Conceptsyou want to know how SomeWM works and why

Versions​

These pages track 2.2, in development. The version switcher has 2.1, the current release, 2.0, and 1.4, which mirrors AwesomeWM master and is maintained indefinitely. The AwesomeWM apidoc covers inherited APIs not yet documented here.