man: fix command names and issues ref

This commit is contained in:
Wim Taymans 2020-01-28 16:09:56 +01:00
parent 6cc180f252
commit 34e776a930
5 changed files with 14 additions and 13 deletions

View file

@ -2,7 +2,7 @@ manpage_conf = configuration_data()
manpage_conf.set('PACKAGE_NAME', meson.project_name()) manpage_conf.set('PACKAGE_NAME', meson.project_name())
manpage_conf.set('PACKAGE_VERSION', meson.project_version()) manpage_conf.set('PACKAGE_VERSION', meson.project_version())
manpage_conf.set('PACKAGE_URL', 'http://pipewire.org') manpage_conf.set('PACKAGE_URL', 'http://pipewire.org')
manpage_conf.set('PACKAGE_BUGREPORT', 'https://github.com/PipeWire/pipewire/issues') manpage_conf.set('PACKAGE_BUGREPORT', 'https://gitlab.freedesktop.org/pipewire/pipewire/issues')
manpage_conf.set('PIPEWIRE_CONFIG_DIR', pipewire_configdir) manpage_conf.set('PIPEWIRE_CONFIG_DIR', pipewire_configdir)
manpage_conf.set('top_srcdir', meson.source_root()) manpage_conf.set('top_srcdir', meson.source_root())
manpage_conf.set('top_builddir', meson.build_root()) manpage_conf.set('top_builddir', meson.build_root())
@ -10,8 +10,8 @@ manpage_conf.set('top_builddir', meson.build_root())
manpages = [ manpages = [
[ 'pipewire', '1' ], [ 'pipewire', '1' ],
[ 'pipewire.conf', '5' ], [ 'pipewire.conf', '5' ],
[ 'pipewire-cli', '1' ], [ 'pw-cli', '1' ],
[ 'pipewire-monitor', '1' ] [ 'pw-mon', '1' ]
] ]
foreach m : manpages foreach m : manpages

View file

@ -34,7 +34,7 @@ This file is part of PipeWire.
<option> <option>
<p><opt>-n | --name</opt></p> <p><opt>-n | --name</opt></p>
<optdesc><p>Set the daemon name (Default pipewire-1).</p></optdesc> <optdesc><p>Set the daemon name (Default pipewire-0).</p></optdesc>
</option> </option>
</options> </options>
@ -45,7 +45,8 @@ This file is part of PipeWire.
<section name="See also"> <section name="See also">
<p> <p>
<manref name="pipewire-monitor" section="1"/>, <manref name="pw-mon" section="1"/>,
<manref name="pw-cli" section="1"/>,
</p> </p>
</section> </section>

View file

@ -48,7 +48,7 @@ This file is part of PipeWire.
<section name="See also"> <section name="See also">
<p> <p>
<manref name="pipewire" section="1"/>, <manref name="pipewire" section="1"/>,
<manref name="pipewire-monitor" section="1"/>, <manref name="pw-mon" section="1"/>,
</p> </p>
</section> </section>

View file

@ -6,18 +6,18 @@
This file is part of PipeWire. This file is part of PipeWire.
--> -->
<manpage name="pipewire-cli" section="1" desc="The PipeWire Command Line Interface"> <manpage name="pw-cli" section="1" desc="The PipeWire Command Line Interface">
<synopsis> <synopsis>
<cmd>pipewire-cli</cmd> <cmd>pw-cli</cmd>
</synopsis> </synopsis>
<description> <description>
<p>Interact with a PipeWire instance.</p> <p>Interact with a PipeWire instance.</p>
<p><manref name="pipewire-cli" section="1"/> starts an interactive session <p><manref name="pw-cli" section="1"/> starts an interactive session
with a pipewire instance. By default, a connection is made with the local with a pipewire instance. By default, a connection is made with the local
PipeWire instance, that of the pipewire-cli command itself.</p> PipeWire instance, that of the pw-cli command itself.</p>
<p>Connections to other, remote instances can be made. The current instance <p>Connections to other, remote instances can be made. The current instance
name is displayed at the prompt. Some commands operate on the current name is displayed at the prompt. Some commands operate on the current
@ -145,7 +145,7 @@ This file is part of PipeWire.
<section name="See also"> <section name="See also">
<p> <p>
<manref name="pipewire" section="1"/>, <manref name="pipewire" section="1"/>,
<manref name="pipewire-monitor" section="1"/>, <manref name="pw-mon" section="1"/>,
</p> </p>
</section> </section>

View file

@ -6,10 +6,10 @@
This file is part of PipeWire. This file is part of PipeWire.
--> -->
<manpage name="pipewire-monitor" section="1" desc="The PipeWire monitor"> <manpage name="pw-mon" section="1" desc="The PipeWire monitor">
<synopsis> <synopsis>
<cmd>pipewire-monitor [<arg>remote-name</arg>]</cmd> <cmd>pw-mon [<arg>remote-name</arg>]</cmd>
</synopsis> </synopsis>
<description> <description>