update man pages.

This commit is contained in:
Wim Taymans 2020-05-02 20:19:20 +02:00
parent b9bb318cb7
commit 3037dd6b48
6 changed files with 95 additions and 12 deletions

View file

@ -11,6 +11,7 @@ manpages = [
[ 'pipewire', '1' ],
[ 'pipewire.conf', '5' ],
[ 'pw-cli', '1' ],
[ 'pw-profiler', '1' ],
[ 'pw-mon', '1' ]
]

View file

@ -13,8 +13,8 @@ This file is part of PipeWire.
</synopsis>
<description>
<p>PipeWire is a service that allows access to multimedia devices
and allows media sharing between applications. </p>
<p>PipeWire is a service that facilitates sharing of multimedia content
between devices and applications. </p>
<p>The pipewire daemon reads a config file that is further documented in
<manref name="pipewire.conf" section="5"/></p>
@ -29,7 +29,7 @@ This file is part of PipeWire.
</option>
<option>
<p><opt>-v | --version</opt></p>
<p><opt> --version</opt></p>
<optdesc><p>Show version information.</p></optdesc>
</option>
@ -43,12 +43,14 @@ This file is part of PipeWire.
</options>
<section name="Authors">
<p>The PipeWire Developers &lt;@PACKAGE_BUGREPORT@&gt;; PipeWire is available from <url href="@PACKAGE_URL@"/></p>
<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="pw-mon" section="1"/>,
<manref name="pw-cat" section="1"/>,
<manref name="pw-cli" section="1"/>,
</p>
</section>

View file

@ -13,8 +13,8 @@ This file is part of PipeWire.
</synopsis>
<description>
<p>PipeWire is a service that allows access to multimedia devices
and allows media sharing between applications. </p>
<p>PipeWire is a service that facilitates sharing of multimedia content
between devices and applications. </p>
<p>On startup, the daemon reads a configuration file to configure
itself. It executes a series of commands listed in the config
@ -56,6 +56,14 @@ This file is part of PipeWire.
</option>
</section>
<section name="Object Create">
<option>
<p><opt>create-object</opt> [<arg>options</arg>] <arg>factory</arg> [<arg>arguments...</arg>]</p>
<optdesc><p>Create an object from the specified factory with arguments.
</p></optdesc>
</option>
</section>
<section name="Exec">
<option>
<p><opt>exec</opt> <arg>program</arg></p>

View file

@ -9,15 +9,18 @@ This file is part of PipeWire.
<manpage name="pw-cli" section="1" desc="The PipeWire Command Line Interface">
<synopsis>
<cmd>pw-cli</cmd>
<cmd>pw-cli [<arg>command</arg>]</cmd>
</synopsis>
<description>
<p>Interact with a PipeWire instance.</p>
<p><manref name="pw-cli" section="1"/> starts an interactive session
with a pipewire instance. By default, a connection is made with the local
PipeWire instance, that of the pw-cli command itself.</p>
<p>When a command is given, <manref name="pw-cli" section="1"/>
will execute the command and exit</p>
<p>When no command is given, <manref name="pw-cli" section="1"/>
starts an interactive session with the default pipewire instance
pipewire-0.</p>
<p>Connections to other, remote instances can be made. The current instance
name is displayed at the prompt. Some commands operate on the current

View file

@ -9,7 +9,7 @@ This file is part of PipeWire.
<manpage name="pw-mon" section="1" desc="The PipeWire monitor">
<synopsis>
<cmd>pw-mon [<arg>remote-name</arg>]</cmd>
<cmd>pw-mon [<arg>options</arg>]</cmd>
</synopsis>
<description>
@ -19,7 +19,7 @@ This file is part of PipeWire.
<options>
<option>
<p><opt>remote-name</opt></p>
<p><opt>-r | --remote</opt></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>

69
man/pw-profiler.1.xml.in Normal file
View file

@ -0,0 +1,69 @@
<?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></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></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>