# wlmaker Manual {#mainpage}

## wlmaker

wlmaker is a [Wayland Compositor](https://en.wikipedia.org/wiki/Wayland_(protocol)#Wayland_compositors),
designed to reproduce the behaviour of
[Window Maker](https://www.windowmaker.org/), which reproduces the elegant look
and feel of the [NeXTSTEP](https://en.wikipedia.org/wiki/NeXTSTEP) user
interface.

**Key features:**

* Compositor for windows in stacking mode.
* Easy to use, lightweight, low on gimmicks and fast.
* Highly configurable and human-readable [config files](#config_file).
* Dock and clip, with support for dockable apps.

## Documentation

* @ref commandline
* @ref config
* @ref root_menu
* @ref protocols

## Download

A few Linux and FreeBSD distributions provide a recent and compiled
binary of wlmaker, so you can install it directly from there:

<a href="https://repology.org/project/wlmaker/versions">
  <img src="https://repology.org/badge/vertical-allrepos/wlmaker.svg?columns=4" alt="Packaging status" width="80%" align="center">
</a>

Alternatively, you can obtain the source code from it's
[git repository](https://github.com/phkaeser/wlmaker). Please follow the
[instructions](https://github.com/phkaeser/wlmakerdoc/BUILD.md) to build from
source.

## Bugs and missing features

Report bugs at https://github.com/phkaeser/wlmaker/issues.
