.\" Man page generated from reStructuredText.
.
.TH PW-PROFILER 1 "" "" "General Commands Manual"
.SH NAME
pw-profiler \- The PipeWire profiler
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.SH SYNOPSIS
.nf
\fBpw\-profiler\fP [\fIoptions\fP]
.fi
.sp
.SH DESCRIPTION
.sp
Start profiling a PipeWire instance.
.sp
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.
.sp
When this program is stopped, a set of \fBgnuplot\fP 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.
.sp
This function uses the same data used by \fIpw\-top\fP\&.
.SH OPTIONS
.INDENT 0.0
.TP
.B \-r | \-\-remote=NAME
The name the remote instance to monitor. If left unspecified,
a connection is made to the default PipeWire instance.
.TP
.B \-h | \-\-help
Show help.
.UNINDENT
.INDENT 0.0
.TP
.B \-\-version
Show version information.
.UNINDENT
.INDENT 0.0
.TP
.B \-o | \-\-output=FILE
Profiler output name (default "profiler.log").
.UNINDENT
.SH AUTHORS
.sp
The PipeWire Developers <\fI\%https://gitlab.freedesktop.org/pipewire/pipewire/issues\fP>; PipeWire is available from \fI\%https://pipewire.org\fP
.SH SEE ALSO
.sp
\fBpipewire(1)\fP,
\fBpw\-top(1)\fP,
.\" Generated by docutils manpage writer.
.