man/pw-metadata.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
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79

<?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="pw-metadata" section="1" desc="The PipeWire metadata">

  <synopsis>
  <cmd>pw-metadata [<arg>options</arg>] [<arg>id</arg> [<arg>key</arg> [<arg>value</arg> [<arg>type</arg> ] ] ] ]</cmd>
  </synopsis>

  <description>
    <p>Monitor, set and delete metadata on PipeWire objects.</p>

    <p>Metadata are key/type/value tripplets attached to objects identified
    by <arg>id</arg>. The metadata is shared between all applications
    binding to the same metadata object. When an object is destroyed, all its
    metadata is automatically removed.</p>

    <p>When no <arg>value</arg> is given, <cmd>pw-metadata</cmd> will query and
    log the metadata matching the optional arguments <arg>id</arg>
    and <arg>key</arg>. Without any arguments, all metadata is displayed.</p>

    <p>When <arg>value</arg> is given, <cmd>pw-metadata</cmd> will set the
    metadata for <arg>id</arg> and <arg>key</arg> to <arg>value</arg> and
    an optional <arg>type</arg>.</p>
  </description>

  <options>

    <option>
       <p><opt>-r | --remote</opt><arg>=NAME</arg></p>
       <optdesc><p>The name the remote instance to use. If left unspecified,
       a connection is made to the default PipeWire instance.</p></optdesc>
     </option>

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

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

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

    <option>
      <p><opt>-m | --monitor</opt></p>
      <optdesc><p>Keeps running and log the changes to the metadata.</p></optdesc>
    </option>

    <option>
      <p><opt>-d | --delete</opt></p>
      <optdesc>
         <p>Delete all metadata for <arg>id</arg> or for the
		 specified <arg>key</arg> of object <arg>id</arg></p>
         <p>Without any option, all metadata is removed</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="pipewire" section="1"/>,
      <manref name="pw-mon" section="1"/>,
      <manref name="pw-cli" section="1"/>,
    </p>
  </section>

</manpage>