mirror of
https://gitlab.freedesktop.org/pipewire/pipewire
synced 2024-07-05 17:08:53 +00:00
e41187d643
xmltoman looks dead and uses XML as well as pulls in a long list of Perl dependencies. This replaces it with rst2man that has almost no dependencies beyond Python, which is already required for the Meson build system. Naturally rst2man uses reStructuredText and the pages were rewritten via regex and manual editing to be as close to original XML format as possible. A few fixes and updates were done too. Most notably a note was added to indicate that production deployments should not be starting the session manager via pipewire.conf file. There's three slight formatting issues/differences: 1. rst2man produces simpler footer. 2. "-f | --foo=value" confuses the parser and it fails to correctly add argument specific syntax highlighting to assignment value. 3. XML version had inconsistent use of <arg> and <opt> which has been partially addressed. But different manual pages still have their differences to what and how is highlighted.
70 lines
1.4 KiB
ReStructuredText
70 lines
1.4 KiB
ReStructuredText
.. This file is part of PipeWire.
|
|
|
|
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)``,
|