summaryrefslogtreecommitdiff
path: root/man
diff options
context:
space:
mode:
authorWim Taymans <wtaymans@redhat.com>2020-02-18 10:36:28 +0100
committerWim Taymans <wtaymans@redhat.com>2020-02-18 10:36:28 +0100
commit9bd21d6c18033dfc3ff051b26165001477070b1f (patch)
tree5dad970c07108e8a446859f6372a41c2a5970a2c /man
parent319df9fce937c65d934ca32fe823531a94ea0c24 (diff)
man: improve man pages a little
Diffstat (limited to 'man')
-rw-r--r--man/pipewire.1.xml.in3
-rw-r--r--man/pipewire.conf.5.xml.in23
2 files changed, 25 insertions, 1 deletions
diff --git a/man/pipewire.1.xml.in b/man/pipewire.1.xml.in
index d582c8a7..53b4f7f6 100644
--- a/man/pipewire.1.xml.in
+++ b/man/pipewire.1.xml.in
@@ -15,6 +15,9 @@ This file is part of PipeWire.
<description>
<p>PipeWire is a service that allows access to multimedia devices
and allows media sharing between applications. </p>
+
+ <p>The pipewire daemon reads a config file that is further documented in
+ <manref name="pipewire.conf" section="5"/></p>
</description>
<options>
diff --git a/man/pipewire.conf.5.xml.in b/man/pipewire.conf.5.xml.in
index d6d45259..cbf3934f 100644
--- a/man/pipewire.conf.5.xml.in
+++ b/man/pipewire.conf.5.xml.in
@@ -33,14 +33,35 @@ This file is part of PipeWire.
</option>
</section>
+ <section name="Properies">
+ <option>
+ <p><opt>set-prop</opt> <arg>key</arg> <arg>value</arg></p>
+ <optdesc><p>Sets a property with the given key to value.</p></optdesc>
+ </option>
+ </section>
+
+ <section name="Plugin mapping">
+ <option>
+ <p><opt>add-spa-lib</opt> <arg>pattern</arg> <arg>library</arg></p>
+ <optdesc><p>Maps the plugin features that match <opt>pattern</opt>
+ to <opt>library</opt>.</p> When the systen needs a plugin feature</optdesc>
+ </option>
+ </section>
+
<section name="Module Management">
<option>
- <p><opt>load-module</opt> <arg>name</arg> [<arg>arguments...</arg>]</p>
+ <p><opt>load-module</opt> [<arg>options</arg>] <arg>name</arg> [<arg>arguments...</arg>]</p>
<optdesc><p>Load a module specified by its name and arguments. For most
modules it is OK to be loaded more than once.</p></optdesc>
</option>
</section>
+ <section name="Exec">
+ <option>
+ <p><opt>exec</opt> <arg>program</arg></p>
+ <optdesc><p>Execute program. This is usually the session manager.</p></optdesc>
+ </option>
+ </section>
<section name="Authors">
<p>The PipeWire Developers &lt;@PACKAGE_BUGREPORT@&gt;; PipeWire is available from <url href="@PACKAGE_URL@"/></p>
</section>