Debian Codegraph @

docs/rst/daemon/installing.rst

raw
1 .. _daemon_installing:
2
3 Installing WirePlumber
4 ======================
5
6 Dependencies
7 ------------
8
9 In order to compile WirePlumber you will need:
10
11 * GLib >= 2.68
12 * PipeWire >= 1.0
13 * Lua 5.3 or 5.4
14
15 Lua is optional in the sense that if it is not found in the system, a bundled
16 version will be built and linked statically with WirePlumber. This is controlled
17 by the **system-lua** meson option.
18
19 For building gobject-introspection data, you will also need
20 `doxygen <https://www.doxygen.nl/>`_ and **g-ir-scanner**.
21 The latter is usually shipped together with the gobject-introspection
22 development files.
23
24 For building documentation, you will also need
25 `Sphinx <https://pypi.org/project/Sphinx/>`_,
26 `sphinx-rtd-theme <https://github.com/readthedocs/sphinx_rtd_theme>`_ and
27 `breathe <https://pypi.org/project/breathe/>`_.
28 It is recommended to install those using python's **pip** package manager.
29
30 Compilation
31 -----------
32
33 WirePlumber uses the `meson build system <https://mesonbuild.com/>`_
34
35 To configure the project, you need to first run `meson`.
36 The basic syntax is shown below:
37
38 .. code:: console
39
40 meson [--prefix=/path] [...options...] [build directory] [source directory]
41
42 Assuming you want to build in a directory called 'build' inside the source
43 tree, you can run:
44
45 .. code:: console
46
47 $ meson setup --prefix=/usr build
48 $ meson compile -C build
49
50 Additional options
51 ------------------
52
53 .. option:: -Dintrospection=[enabled|disabled|auto]
54
55 Force enable or force disable building gobject-introspection data.
56
57 The default value is **auto**, which means that g-i will be built
58 if **doxygen** and **g-ir-scanner** are found and skipped otherwise.
59
60 .. option:: -Ddocs=[enabled|disabled|auto]
61
62 Force enable or force disable building documentation.
63
64 The default value is **auto**, which means that documentation will be built
65 if **doxygen**, **sphinx** and **breathe** are found and skipped otherwise.
66
67 .. option:: -Dmodules=[true|false]
68
69 Build the wireplumber modules.
70
71 The default value is **true**.
72
73 .. option:: -Ddaemon=[true|false]
74
75 Build the session manager daemon.
76
77 The default value is **true**.
78
79 Requires **modules** option to be **true**.
80
81 .. option:: -Dtools=[true|false]
82
83 Enable or disable building tools.
84
85 The default value is **true**.
86
87 Requires **modules** option to be **true**.
88
89 .. option:: -Dsystem-lua=[enabled|disabled|auto]
90
91 Force using lua from the system instead of the bundled one.
92
93 The default value is **auto**, which means that system lua will be used
94 if it is found, otherwise the bundled static version will be built silently.
95
96 Use **disabled** to force using the bundled lua.
97
98 .. option:: -Dsystemd=[enabled|disabled|auto]
99
100 Enables installing systemd units. The default is **auto**
101
102 **enabled** and **auto** currently mean the same thing.
103
104 .. option:: -Dsystemd-system-service=[true|false]
105
106 Enables installing systemd system service file. The default is **false**
107
108 .. option:: -Dsystemd-user-service=[true|false]
109
110 Enables installing systemd user service file. The default is **true**
111
112 .. option:: -Dsystemd-system-unit-dir=[path]
113
114 Directory for system systemd units.
115
116 .. option:: -Dsystemd-user-unit-dir=[path]
117
118 Directory for user systemd units.
119
120 Installation
121 ------------
122
123 To install, simply run the **install** target with ninja:
124
125 .. code:: console
126
127 $ ninja -C build install
128
129 To revert the installation, there is also an **uninstall** target:
130
131 .. code:: console
132
133 $ ninja -C build uninstall