Commit graph

35 commits

Author SHA1 Message Date
Pauli Virtanen
843e733479 doc: add documentation for pipewire-pulse modules
Add (minimal) reference documentation for each pipewire-pulse module.

Add some preprocessing to substitute @pulse_module_options@ in docs from
PW_KEY_MODULE_USAGE so the module options don't need to be repeated.

Produce Doxygen docs + generate manpages pipewire-pulse-modules.7,
pipewire-pulse-module-*.7
2023-11-20 08:41:13 +00:00
Pauli Virtanen
21854f24a5 doc: generate man-pages also for pipewire modules
Use pandoc + some processing to convert Doxygen html output to man
pages.

Requires pandoc & python for building.

Generates manpages: libpipewire-modules.7, libpipewire-module-*.7
2023-11-19 16:39:15 +00:00
Pauli Virtanen
62f69581bf man: add pw-loopback.1 2023-11-19 16:39:15 +00:00
Pauli Virtanen
2ee4065c11 man: add pw-dump.1 2023-11-19 16:39:15 +00:00
Wim Taymans
e90e948166 man: add pw-config man page 2023-04-20 10:24:29 +02:00
Wim Taymans
ecc9bc2524 man: add pw-link manpage
Fixes #2263
2022-04-02 09:16:13 +02:00
Michael D
8026b65caa Update meson.build
(cherry picked from commit 8da11c3853cb7a19cd267ad94de591f88461d31a)
2022-03-05 00:37:25 +00:00
Barnabás Pőcze
cc73053512 treewide: meson.build: use feature.allowed()
Since meson 0.59.0, a feature object has an `allowed()`
method which returns true when the feature is set to
'enabled' or 'auto'.

Utilize that instead of the previously used

  not feature.disabled()
2022-02-04 00:15:59 +01:00
Pauli Virtanen
88e744a06f doc: include manpages in html docs
Include manpages as raw text in html docs.  Simple and readable
enough...
2022-01-20 20:51:03 +00:00
Barnabás Pőcze
b656a09ae5 man: meson.build: remove unnecessary variables
The `top_srcdir` and `top_builddir` variables are not used
in any of the man page templates. Remove them.
2021-12-28 18:34:54 +01:00
Peter Hutterer
eb688a9f57 man: add a man page for pipewire-pulse 2021-11-11 08:19:51 +00:00
Peter Hutterer
abd5f9fbe8 Remove remaining tabs from meson.build files
No changes, just tab-to-space replacement and a little bit of manual
twiddling.
2021-09-30 00:08:27 +00:00
Niklāvs Koļesņikovs
40cbcf2887 Meson: Update two pipewire.org URLs to HTTPS 2021-09-03 11:41:45 +00:00
Niklāvs Koļesņikovs
e41187d643 man: move from xmltoman to rst2man
xmltoman looks dead and uses XML as well as pulls in a long list of
Perl dependencies. This replaces it with rst2man that has almost no
dependencies beyond Python, which is already required for the Meson
build system.

Naturally rst2man uses reStructuredText and the pages were rewritten
via regex and manual editing to be as close to original XML format
as possible. A few fixes and updates were done too. Most notably a
note was added to indicate that production deployments should not be
starting the session manager via pipewire.conf file.

There's three slight formatting issues/differences:
1. rst2man produces simpler footer.
2. "-f | --foo=value" confuses the parser and it fails to correctly
   add argument specific syntax highlighting to assignment value.
3. XML version had inconsistent use of <arg> and <opt> which has
   been partially addressed. But different manual pages still have
   their differences to what and how is highlighted.
2021-09-03 11:41:45 +00:00
Nils Tonnätt
dd12910769 Revert "[Meson] Fix all deprecation warnings"
This reverts commit f7e1175ef0.
2021-08-08 19:18:40 +00:00
Nils Tonnätt
f7e1175ef0 [Meson] Fix all deprecation warnings 2021-08-06 07:56:16 +00:00
Peter Hutterer
9af86b7b76 man: specify the xdg and confdata dirs in the pipewire.conf man page 2021-05-20 07:34:17 +00:00
Peter Hutterer
4b7a2df0b7 man: replace the custom man array with a filename-based section extraction
Use the file names as-is in meson.build (which makes it possible to grep for
them easily) and use the various string methods to extract the section from
the file name and compile the intermediate xml file.
2021-04-15 06:57:00 +00:00
Peter Hutterer
223f20709d meson: replace join_paths(a, b) with a / b
More readable and from the meson reference manual:
(since 0.49.0) Using the/ operator on strings is equivalent to calling join_paths.
2021-04-15 06:57:00 +00:00
Thibault Saunier
485bae5eb0 meson: Use feature options everywhere it makes sense 2021-03-10 20:18:34 +00:00
Wim Taymans
91b0d3bb39 Remove pipewire-libpulse
We use the original pulseaudio client library and the replacement
server pipewire-pulse.
2020-12-17 15:44:49 +01:00
Simon McVittie
b91a718018 man: Add man pages for pw-jack, pw-pulse
Signed-off-by: Simon McVittie <smcv@debian.org>
2020-06-08 13:28:44 +00:00
Wim Taymans
91ef2fc68c man: add metadata man page 2020-05-06 17:12:01 +02:00
Wim Taymans
ab03e3230e man: add pw-dot man page
Fix some arguments to parameters
2020-05-03 21:08:01 +02:00
Wim Taymans
3dc0602650 man: add mididump man page 2020-05-03 20:50:38 +02:00
Wim Taymans
f46cbd2ac2 man: add pw-cat beginnings 2020-05-03 07:25:28 +02:00
Wim Taymans
3037dd6b48 update man pages. 2020-05-02 20:19:20 +02:00
Wim Taymans
34e776a930 man: fix command names and issues ref 2020-01-28 16:09:56 +01:00
Wim Taymans
391643271e man: fix man page install path
Fixes #85
2018-09-19 16:26:24 +02:00
Wim Taymans
1352c7555e man: install manpages in the right directory 2018-08-30 14:52:45 +02:00
Wim Taymans
c06d775ddc man: add man page for config file 2018-08-17 10:19:20 +02:00
Wim Taymans
807af5b983 man: update man pages
Add man page for pipewire-cli
2017-09-19 10:19:53 +02:00
Wim Taymans
21cd5a2918 Add example to play sine wave
Various build fixes and cleanups
Move port_add to private and make node ports based on implementation.
Improve pull based scheduling on remote nodes
2017-09-07 10:22:32 +02:00
Wim Taymans
6df165315c man: fixes 2017-06-16 17:56:18 +02:00
Wim Taymans
573e032cc1 man: update man build 2017-06-16 17:31:40 +02:00