diff options
Diffstat (limited to '')
-rw-r--r-- | man/pw-profiler.1.rst.in | 57 |
1 files changed, 57 insertions, 0 deletions
diff --git a/man/pw-profiler.1.rst.in b/man/pw-profiler.1.rst.in new file mode 100644 index 0000000..6fb57c8 --- /dev/null +++ b/man/pw-profiler.1.rst.in @@ -0,0 +1,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)``, |