mirror of
https://gitlab.freedesktop.org/pipewire/pipewire
synced 2024-09-19 07:51:29 +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.
57 lines
1.1 KiB
ReStructuredText
57 lines
1.1 KiB
ReStructuredText
.. This file is part of PipeWire.
|
|
|
|
pw-profiler
|
|
###########
|
|
|
|
---------------------
|
|
The PipeWire profiler
|
|
---------------------
|
|
|
|
:Manual section: 1
|
|
:Manual group: General Commands Manual
|
|
|
|
SYNOPSIS
|
|
========
|
|
|
|
| **pw-profiler** [*options*]
|
|
|
|
DESCRIPTION
|
|
===========
|
|
|
|
Start profiling a PipeWire instance.
|
|
|
|
If the server has the profiler module loaded, this program will
|
|
connect to it and log the profiler data. Profiler data contains
|
|
times and durations when processing nodes and devices started and
|
|
completed.
|
|
|
|
When this program is stopped, a set of **gnuplot** files and a script to generate
|
|
SVG files from the .plot files is generated, along with a .html file to
|
|
visualize the profiling results in a browser.
|
|
|
|
OPTIONS
|
|
=======
|
|
|
|
-r | --remote=NAME
|
|
The name the remote instance to monitor. If left unspecified,
|
|
a connection is made to the default PipeWire instance.
|
|
|
|
-h | --help
|
|
Show help.
|
|
|
|
--version
|
|
Show version information.
|
|
|
|
-o | --output=FILE
|
|
Profiler output name (default "profiler.log").
|
|
|
|
AUTHORS
|
|
=======
|
|
|
|
The PipeWire Developers <@PACKAGE_BUGREPORT@>; PipeWire is available from @PACKAGE_URL@
|
|
|
|
SEE ALSO
|
|
========
|
|
|
|
``pipewire(1)``,
|