mirrors/pipewire
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/pipewire/pipewire.git synced 2025-11-03 09:01:54 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions
pipewire/man/pw-metadata.1.rst.in

83 lines
1.7 KiB
ReStructuredText
Raw Normal View History

man: move from xmltoman to rst2man 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.
2021-09-03 10:16:48 +03:00
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.
pw-metadata: add -l option to list available metadata
2023-04-14 15:06:55 +02:00
-l | --list
List available metadata objects
man: move from xmltoman to rst2man 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.
2021-09-03 10:16:48 +03:00
-m | --monitor
Keeps running and log the changes to the metadata.
-d | --delete
man: pw-metadata: fix display of --delete and remove unnecessary paragraph With the extra newline the -d/--delete option is not styled as bold in the resulting man page.
2023-04-10 09:25:12 +02:00
Delete all metadata for *id* or for the specified *key* of object *id*.
Without any option, all metadata is removed.
man: move from xmltoman to rst2man 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.
2021-09-03 10:16:48 +03:00
man: pw-metadata: document --name option
2023-04-10 09:38:41 +02:00
-n | --name
Metadata name (Default: "default").
man: pw-metadata: add examples
2023-04-10 09:38:57 +02:00
EXAMPLES
========
**pw-metadata**
Show metadata in default name.
**pw-metadata** -n settings 0
Display settings.
**pw-metadata** -n settings 0 clock.quantum 1024
Change clock.quantum to 1024.
man: move from xmltoman to rst2man 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.
2021-09-03 10:16:48 +03:00
AUTHORS
=======
The PipeWire Developers <@PACKAGE_BUGREPORT@>; PipeWire is available from @PACKAGE_URL@
SEE ALSO
========
``pipewire(1)``,
``pw-mon(1)``,
``pw-cli(1)``,
Reference in a new issue Copy permalink