pipewire/man/pw-profiler.1.xml.in

<?xml version="1.0"?><!--*-nxml-*-->
<!DOCTYPE manpage SYSTEM "xmltoman.dtd">
<?xml-stylesheet type="text/xsl" href="xmltoman.xsl" ?>

<!--
This file is part of PipeWire.
-->

<manpage name="pw-profiler" section="1" desc="The PipeWire profiler">

  <synopsis>
    <cmd>pw-profiler [<arg>options</arg>]</cmd>
  </synopsis>

  <description>
    <p>Start profiling a PipeWire instance.</p>

    <p>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.
	    </p>
    <p>
     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.

    </p>
  </description>

  <options>

    <option>
       <p><opt>-r | --remote</opt><arg>=NAME</arg></p>
       <optdesc><p>The name the remote instance to monitor. If left unspecified,
       a connection is made to the default PipeWire instance.</p></optdesc>
     </option>

     <option>
      <p><opt>-h | --help</opt></p>

      <optdesc><p>Show help.</p></optdesc>
    </option>

    <option>
      <p><opt>--version</opt></p>

      <optdesc><p>Show version information.</p></optdesc>
    </option>

     <option>
      <p><opt>-o | --output</opt><arg>=FILE</arg></p>

      <optdesc><p>Profiler output name (default "profiler.log").</p></optdesc>
    </option>

  </options>

  <section name="Authors">
    <p>The PipeWire Developers &lt;@PACKAGE_BUGREPORT@&gt;; PipeWire is available from <url href="@PACKAGE_URL@"/></p>
  </section>

  <section name="See also">
    <p>
      <manref name="pipewire" section="1"/>,
    </p>
  </section>

</manpage>