diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-07 18:28:17 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-07 18:28:17 +0000 |
commit | 7a46c07230b8d8108c0e8e80df4522d0ac116538 (patch) | |
tree | d483300dab478b994fe199a5d19d18d74153718a /man/pw-metadata.1.rst.in | |
parent | Initial commit. (diff) | |
download | pipewire-7a46c07230b8d8108c0e8e80df4522d0ac116538.tar.xz pipewire-7a46c07230b8d8108c0e8e80df4522d0ac116538.zip |
Adding upstream version 0.3.65.upstream/0.3.65upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to '')
-rw-r--r-- | man/pw-metadata.1.rst.in | 67 |
1 files changed, 67 insertions, 0 deletions
diff --git a/man/pw-metadata.1.rst.in b/man/pw-metadata.1.rst.in new file mode 100644 index 0000000..f83618b --- /dev/null +++ b/man/pw-metadata.1.rst.in @@ -0,0 +1,67 @@ +pw-metadata +########### + +--------------------- +The PipeWire metadata +--------------------- + +:Manual section: 1 +:Manual group: General Commands Manual + +SYNOPSIS +======== + +| **pw-metadata** [*options*] [*id* [*key* [*value* [*type* ] ] ] ] + +DESCRIPTION +=========== + +Monitor, set and delete metadata on PipeWire objects. + +Metadata are key/type/value triplets attached to objects identified +by *id*. The metadata is shared between all applications +binding to the same metadata object. When an object is destroyed, all its +metadata is automatically removed. + +When no *value* is given, **pw-metadata** will query and +log the metadata matching the optional arguments *id* +and *key*. Without any arguments, all metadata is displayed. + +When *value* is given, **pw-metadata** will set the +metadata for *id* and *key* to *value* and +an optional *type*. + +OPTIONS +======= + +-r | --remote=NAME + The name the remote instance to use. If left unspecified, + a connection is made to the default PipeWire instance. + +-h | --help + Show help. + +--version + Show version information. + +-m | --monitor + Keeps running and log the changes to the metadata. + +-d | --delete + + Delete all metadata for *id* or for the + specified *key* of object *id* + + Without any option, all metadata is removed + +AUTHORS +======= + +The PipeWire Developers <@PACKAGE_BUGREPORT@>; PipeWire is available from @PACKAGE_URL@ + +SEE ALSO +======== + +``pipewire(1)``, +``pw-mon(1)``, +``pw-cli(1)``, |