1
Fork 0

doc: add pw-v4l2.1 and spa-*.1

Add manpages for the remaining utilities without one.
This commit is contained in:
Pauli Virtanen 2023-12-09 15:48:47 +02:00
parent 7f2dd3531c
commit 31b7ff58ad
9 changed files with 259 additions and 1 deletions

View File

@ -21,4 +21,10 @@ Manual pages:
- \subpage page_man_pw-profiler_1
- \subpage page_man_pw-reserve_1
- \subpage page_man_pw-top_1
- \subpage page_man_pw-v4l2_1
- \subpage page_man_spa-acp-tool_1
- \subpage page_man_spa-inspect_1
- \subpage page_man_spa-json-dump_1
- \subpage page_man_spa-monitor_1
- \subpage page_man_spa-resample_1
- \subpage page_man_libpipewire-modules_7

View File

@ -4,7 +4,7 @@ Use PipeWire instead of JACK
# SYNOPSIS
**pw-jack** \[*options*\] *COMMAND* \[*FILE*\]
**pw-jack** \[*options*\] *COMMAND* \[*ARGUMENTS...*\]
# DESCRIPTION

View File

@ -0,0 +1,40 @@
\page page_man_pw-v4l2_1 pw-v4l2
Use PipeWire instead of V4L2
# SYNOPSIS
**pw-v4l2** \[*options*\] *COMMAND* \[*ARGUMENTS...*\]
# DESCRIPTION
**pw-v4l2** runs a command using a compatibility layer that maps PipeWire
video devices to be visible to applications using V4L2.
This is implemented by preloading a shared library via LD_PRELOAD,
which translates library calls that try to access V4L2 devices.
# OPTIONS
\par -h
Show help.
\par -r NAME
The name of the remote instance to connect to. If left unspecified, a
connection is made to the default PipeWire instance.
\par -v
Verbose operation.
# EXAMPLES
**pw-v4l2** v4l2-ctl --list-devices
# AUTHORS
The PipeWire Developers <$(PACKAGE_BUGREPORT)>;
PipeWire is available from <$(PACKAGE_URL)>
# SEE ALSO
\ref page_man_pipewire_1 "pipewire(1)",

View File

@ -0,0 +1,80 @@
\page page_man_spa-acp-tool_1 spa-acp-tool
The PipeWire ALSA profile debugging utility
# SYNOPSIS
**spa-acp-tool** \[*COMMAND*\]
# DESCRIPTION
Debug tool for exercising the ALSA card profile probing code, without
running PipeWire.
May be used to debug problems where PipeWire has incorrectly
functioning ALSA card profiles.
# COMMANDS
\par help | h
Show available commands
\par quit | q
Quit
\par card <id> | c <id>
Probe card
\par info | i
List card info
\par list | l
List all objects
\par list-verbose | lv
List all data
\par list-profiles [id] | lpr [id]
List profiles
\par set-profile <id> | spr <id>
Activate a profile
\par list-ports [id] | lp [id]
List ports
\par set-port <id> | sp <id>
Activate a port
\par list-devices [id] | ld [id]
List available devices
\par get-volume <id> | gv <id>
Get volume from device
\par set-volume <id> <vol> | v <id> <vol>
Set volume on device
\par inc-volume <id> | v+ <id>
Increase volume on device
\par dec-volume <id> | v- <id>
Decrease volume on device
\par get-mute <id> | gm <id>
Get mute state from device
\par set-mute <id> <val> | sm <id> <val>
Set mute on device
\par toggle-mute <id> | m <id>
Toggle mute on device
# AUTHORS
The PipeWire Developers <$(PACKAGE_BUGREPORT)>;
PipeWire is available from <$(PACKAGE_URL)>
# SEE ALSO
\ref page_man_pipewire_1 "pipewire(1)"

View File

@ -0,0 +1,28 @@
\page page_man_spa-inspect_1 spa-inspect
The PipeWire SPA plugin information utility
# SYNOPSIS
**spa-inspect** *FILE*
# DESCRIPTION
Displays information about a SPA plugin.
Lists the SPA factories contained, and tries to instantiate them.
# EXAMPLES
**spa-inspect** $(SPA_PLUGINDIR)/bluez5/libspa-codec-bluez5-sbc.so
Display information about a plugin.
# AUTHORS
The PipeWire Developers <$(PACKAGE_BUGREPORT)>;
PipeWire is available from <$(PACKAGE_URL)>
# SEE ALSO
\ref page_man_pipewire_1 "pipewire(1)"

View File

@ -0,0 +1,24 @@
\page page_man_spa-json-dump_1 spa-json-dump
SPA JSON to JSON converter
# SYNOPSIS
**spa-json** *FILE*
# DESCRIPTION
Reads a SPA JSON file, and outputs it as standard JSON.
# EXAMPLES
**spa-json-dump** $(PIPEWIRE_CONFDATADIR)/pipewire.conf
# AUTHORS
The PipeWire Developers <$(PACKAGE_BUGREPORT)>;
PipeWire is available from <$(PACKAGE_URL)>
# SEE ALSO
\ref page_man_pipewire_1 "pipewire(1)"

View File

@ -0,0 +1,26 @@
\page page_man_spa-monitor_1 spa-monitor
The PipeWire SPA device debugging utility
# SYNOPSIS
**spa-monitor** *FILE*
# DESCRIPTION
Load a SPA plugin and instantiate a device from it.
This is only useful for debugging device plugins.
# EXAMPLES
**spa-monitor** $(SPA_PLUGINDIR)/jack/libspa-jack.so
# AUTHORS
The PipeWire Developers <$(PACKAGE_BUGREPORT)>;
PipeWire is available from <$(PACKAGE_URL)>
# SEE ALSO
\ref page_man_pipewire_1 "pipewire(1)"

View File

@ -0,0 +1,47 @@
\page page_man_spa-resample_1 spa-resample
The PipeWire resampler debugging utility
# SYNOPSIS
**spa-resample** \[*OPTIONS*\] *INFILE* *OUTFILE*
# DESCRIPTION
Use the PipeWire resampler to resample input file to output file,
following the given options.
This is useful only for testing the resampler.
# OPTIONS
\par -r RATE | \--rate=RATE
Output sample rate.
\par -f FORMAT | \--format=FORMAT
Output sample format (s8 | s16 | s32 | f32 | f64).
\par -q QUALITY | \--quality=QUALITY
Resampler output quality (0-14).
\par -c FLAGS | \--cpuflags=FLAGS
See \ref spa_cpu "spa/support/cpu.h".
\par -h
Show help.
\par -v
Verbose operation.
# EXAMPLES
**spa-resample** -r 48000 -f s32 in.wav out.wav
# AUTHORS
The PipeWire Developers <$(PACKAGE_BUGREPORT)>;
PipeWire is available from <$(PACKAGE_URL)>
# SEE ALSO
\ref page_man_pipewire_1 "pipewire(1)"

View File

@ -14,6 +14,7 @@ doxygen_env.set('PACKAGE_URL', 'https://pipewire.org')
doxygen_env.set('PACKAGE_BUGREPORT', 'https://gitlab.freedesktop.org/pipewire/pipewire/issues')
doxygen_env.set('PIPEWIRE_CONFIG_DIR', pipewire_configdir)
doxygen_env.set('PIPEWIRE_CONFDATADIR', pipewire_confdatadir)
doxygen_env.set('SPA_PLUGINDIR', spa_plugindir)
dot_found = find_program('dot', required: false).found()
summary({'dot (used with doxygen)': dot_found}, bool_yn: true, section: 'Optional programs')
@ -82,6 +83,12 @@ manpage_docs = [
'dox/programs/pw-profiler.1.md',
'dox/programs/pw-reserve.1.md',
'dox/programs/pw-top.1.md',
'dox/programs/pw-v4l2.1.md',
'dox/programs/spa-acp-tool.1.md',
'dox/programs/spa-inspect.1.md',
'dox/programs/spa-json-dump.1.md',
'dox/programs/spa-monitor.1.md',
'dox/programs/spa-resample.1.md',
]
manpages = []