system/pipewire
system/pipewire
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/pipewire/pipewire synced 2024-10-02 22:25:17 +00:00
Code Issues Packages Projects Releases Wiki Activity

man: add man page for config file

Browse source
This commit is contained in:
Wim Taymans 2018-08-17 10:18:41 +02:00
parent e2c2b54742
commit c06d775ddc
3 changed files with 76 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
man/meson.build
View file

@ -3,10 +3,12 @@ manpage_conf.set('PACKAGE_NAME', meson.project_name())
manpage_conf.set('PACKAGE_VERSION', meson.project_version())
manpage_conf.set('PACKAGE_URL', 'http://pipewire.org')
manpage_conf.set('PACKAGE_BUGREPORT', 'https://github.com/PipeWire/pipewire/issues')
manpage_conf.set('PIPEWIRE_CONFIG_DIR', pipewire_configdir)
manpage_conf.set('top_srcdir', meson.source_root())
manpage_conf.set('top_builddir', meson.build_root())
manpages = ['pipewire.1',
'pipewire.conf.5',
'pipewire-cli.1',
'pipewire-monitor.1' ]

68
man/pipewire.conf.5.xml.in Normal file
View file

@ -0,0 +1,68 @@
<?xml version="1.0"?><!--*-nxml-*-->
<!DOCTYPE manpage SYSTEM "xmltoman.dtd">
<?xml-stylesheet type="text/xsl" href="xmltoman.xsl" ?>
<!--
This file is part of PipeWire.
PipeWire is free software; you can redistribute it and/or modify it
under the terms of the GNU Lesser General Public License as
published by the Free Software Foundation; either version 2.1 of the
License, or (at your option) any later version.
PipeWire is distributed in the hope that it will be useful, but WITHOUT
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General
Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with PipeWire; if not, see <http://www.gnu.org/licenses/>.
-->
<manpage name="pipewire.conf" section="5" desc="The PipeWire server configuration file">
<synopsis>
<p><file>@PIPEWIRE_CONFIG_DIR@/pipewire.conf</file></p>
</synopsis>
<description>
<p>PipeWire is a service that allows access to multimedia devices
and allows media sharing between applications. </p>
<p>On startup, the daemon reads a configuration file to configure
itself. It executes a series of commands listed in the config
file.</p>
<p>The config file in the default location is used but the
environment variable PIPEWIRE_CONFIG_FILE can be used to specify
an alternative config file.</p>
</description>
<section name="General Commands">
<option>
<p><opt>help</opt></p>
<optdesc><p>Show a quick help on the commands available.</p></optdesc>
</option>
</section>
<section name="Module Management">
<option>
<p><opt>load-module</opt> <arg>name</arg> [<arg>arguments...</arg>]</p>
<optdesc><p>Load a module specified by its name and arguments. For most
modules it is OK to be loaded more than once.</p></optdesc>
</option>
</section>
<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"/>,
<manref name="pipewire-monitor" section="1"/>,
</p>
</section>
</manpage>

10
meson.build
View file

@ -29,7 +29,9 @@ pipewire_libdir = join_paths(prefix, get_option('libdir'))
pipewire_localedir = join_paths(prefix, get_option('localedir'))
pipewire_sysconfdir = join_paths(prefix, get_option('sysconfdir'))
modules_install_dir = join_paths(get_option('libdir'), 'pipewire-@0@'.format(apiversion))
pipewire_configdir = join_paths(pipewire_sysconfdir, 'pipewire')
modules_install_dir = join_paths(pipewire_libdir, 'pipewire-@0@'.format(apiversion))
spa_plugindir = join_paths(pipewire_libdir, 'spa')
gnome = import('gnome')
@ -55,10 +57,10 @@ cdata.set('PACKAGE_STRING', '"PipeWire @0@"'.format(pipewire_version))
cdata.set('PACKAGE_TARNAME', '"pipewire"')
cdata.set('PACKAGE_URL', '"http://pipewire.org"')
cdata.set('PACKAGE_VERSION', '"@0@"'.format(pipewire_version))
cdata.set('MODULEDIR', '"@0@/pipewire-@1@"'.format(pipewire_libdir,apiversion))
cdata.set('PIPEWIRE_CONFIG_DIR', '"@0@/pipewire"'.format(pipewire_sysconfdir))
cdata.set('MODULEDIR', '"@0@"'.format(modules_install_dir))
cdata.set('PIPEWIRE_CONFIG_DIR', '"@0@"'.format(pipewire_configdir))
cdata.set('VERSION', '"@0@"'.format(pipewire_version))
cdata.set('PLUGINDIR', '"@0@/spa"'.format(pipewire_libdir))
cdata.set('PLUGINDIR', '"@0@"'.format(spa_plugindir))
# FIXME: --with-memory-alignment],[8,N,malloc,pagesize (default is 32)]) option
cdata.set('MEMORY_ALIGNMENT_MALLOC', 1)