man/pipewire.1.xml.in


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56

<?xml version="1.0"?><!--*-nxml-*-->
<!DOCTYPE manpage SYSTEM "xmltoman.dtd">
<?xml-stylesheet type="text/xsl" href="xmltoman.xsl" ?>

<!--
This file is part of PipeWire.
-->

<manpage name="pipewire" section="1" desc="The PipeWire media server">

  <synopsis>
    <cmd>pipewire [<arg>options</arg>]</cmd>
  </synopsis>

  <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>

    <option>
      <p><opt>-h | --help</opt></p>

      <optdesc><p>Show help.</p></optdesc>
    </option>

    <option>
      <p><opt>-v | --version</opt></p>

      <optdesc><p>Show version information.</p></optdesc>
    </option>

    <option>
      <p><opt>-n | --name</opt></p>

      <optdesc><p>Set the daemon name (Default pipewire-0).</p></optdesc>
    </option>

  </options>

  <section name="Authors">
    <p>The PipeWire Developers &lt;@PACKAGE_BUGREPORT@&gt;; PipeWire is available from <url href="@PACKAGE_URL@"/></p>
  </section>

  <section name="See also">
    <p>
      <manref name="pw-mon" section="1"/>,
      <manref name="pw-cli" section="1"/>,
    </p>
  </section>

</manpage>