Installing WirePlumber — WirePlumber 0.5.17 documentation

# Installing WirePlumber

Note

This page describes how to build WirePlumber from source. If your distribution ships WirePlumber, it is most likely already installed; see Getting started instead.

## Dependencies

In order to compile WirePlumber you will need:

- GLib >= 2.68

- PipeWire >= 1.0

- Lua 5.3 or 5.4

Lua is optional in the sense that if it is not found in the system, a bundled version will be built and linked statically with WirePlumber. This is controlled by the system-lua meson option.

For building gobject-introspection data, you will also need doxygen and g-ir-scanner. The latter is usually shipped together with the gobject-introspection development files.

For building documentation, you will also need Sphinx, sphinx-rtd-theme and breathe. It is recommended to install those using python's pip package manager.

## Compilation

WirePlumber uses the meson build system

To configure the project, you need to first run `meson setup`. The basic syntax is shown below:

    meson setup [--prefix=/path] [...options...] [build directory] [source directory]

Assuming you want to build in a directory called 'build' inside the source tree, you can run:

    $ meson setup --prefix=/usr build
    $ meson compile -C build

## Additional options

-Dintrospection=[enabled|disabled|auto]

  Force enable or force disable building gobject-introspection data.

  The default value is auto, which means that g-i will be built if doxygen and g-ir-scanner are found and skipped otherwise.

-Ddocs=[enabled|disabled|auto]

  Force enable or force disable building documentation.

  The default value is auto, which means that documentation will be built if doxygen, sphinx and breathe are found and skipped otherwise.

-Dmodules=[true|false]

  Build the wireplumber modules.

  The default value is true.

-Ddaemon=[true|false]

  Build the session manager daemon.

  The default value is true.

  Requires modules option to be true.

-Dtools=[true|false]

  Enable or disable building tools.

  The default value is true.

  Requires modules option to be true.

-Dsystem-lua=[enabled|disabled|auto]

  Force using lua from the system instead of the bundled one.

  The default value is auto, which means that system lua will be used if it is found, otherwise the bundled static version will be built silently.

  Use disabled to force using the bundled lua.

-Dsystemd=[enabled|disabled|auto]

  Enables installing systemd units. The default is auto

  enabled and auto currently mean the same thing.

-Dsystemd-system-service=[true|false]

  Enables installing systemd system service file. The default is false

-Dsystemd-user-service=[true|false]

  Enables installing systemd user service file. The default is true

-Dsystemd-system-unit-dir=[path]

  Directory for system systemd units.

-Dsystemd-user-unit-dir=[path]

  Directory for user systemd units.

## Installation

To install, simply run the install target with ninja:

    $ ninja -C build install

To revert the installation, there is also an uninstall target:

    $ ninja -C build uninstall