summaryrefslogtreecommitdiffstats
path: root/man/pw-profiler.1.rst.in
blob: 6fb57c8eb29856b6c56366592b43099f4290acf1 (plain)
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
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.

This function uses the same data used by *pw-top*.

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)``,
``pw-top(1)``,