mirrors/pipewire
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/pipewire/pipewire.git synced 2025-11-15 07:00:05 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

doc: make all manpages with Doxygen

Browse source 
Use (fixed-up) Doxygen manpage output for all program & module manpages.

This also allows formatting the manual pages properly in the HTML docs.

The Markdown pages work properly only with Doxygen >= 1.9.7, older
versions put them to wrong place in the HTML docs.
This commit is contained in:
Pauli Virtanen 2023-11-21 21:31:16 +02:00
parent de954655bc
commit 0fbcc87314
49 changed files with 1717 additions and 2012 deletions
Download patch file Download diff file Expand all files Collapse all files

56
man/libpipewire-modules.7.rst.in
View file

@ -1,56 +0,0 @@
libpipewire-modules
###################
----------------
PipeWire modules
----------------
:Manual section: 7
:Manual group: PipeWire
DESCRIPTION
===========
A PipeWire module is effectively a PipeWire client running inside
``pipewire(1)`` which can host multiple modules. Usually modules are
loaded when they are listed in the configuration files. For example
the default configuration file loads several modules:
::
context.modules = [
...
# The native communication protocol.
{ name = libpipewire-module-protocol-native }
# The profile module. Allows application to access profiler
# and performance data. It provides an interface that is used
# by pw-top and pw-profiler.
{ name = libpipewire-module-profiler }
# Allows applications to create metadata objects. It creates
# a factory for Metadata objects.
{ name = libpipewire-module-metadata }
# Creates a factory for making devices that run in the
# context of the PipeWire server.
{ name = libpipewire-module-spa-device-factory }
...
]
KNOWN MODULES
=============
- @LIBPIPEWIRE_MODULES@
AUTHORS
=======
The PipeWire Developers <@PACKAGE_BUGREPORT@>; PipeWire is available from @PACKAGE_URL@
SEE ALSO
========
``pipewire(1)``,
``pipewire.conf(5)``,