mirror of
https://gitlab.freedesktop.org/pipewire/pipewire.git
synced 2025-11-17 07:00:03 -05:00
doc: make all manpages with Doxygen
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:
parent
de954655bc
commit
0fbcc87314
49 changed files with 1717 additions and 2012 deletions
38
doc/dox/programs/pw-mididump.1.md
Normal file
38
doc/dox/programs/pw-mididump.1.md
Normal file
|
|
@ -0,0 +1,38 @@
|
|||
\page page_man_pw-mididump_1 pw-mididump
|
||||
|
||||
The PipeWire MIDI dump
|
||||
|
||||
# SYNOPSIS
|
||||
|
||||
**pw-mididump** \[*options*\] \[*FILE*\]
|
||||
|
||||
# DESCRIPTION
|
||||
|
||||
Dump MIDI messages to stdout.
|
||||
|
||||
When a MIDI file is given, the events inside the file are printed.
|
||||
|
||||
When no file is given, **pw-mididump** creates a PipeWire MIDI input
|
||||
stream and will print all MIDI events received on the port to stdout.
|
||||
|
||||
# OPTIONS
|
||||
|
||||
\par -r | \--remote=NAME
|
||||
The name the remote instance to monitor. If left unspecified, a
|
||||
connection is made to the default PipeWire instance.
|
||||
|
||||
\par -h | \--help
|
||||
Show help.
|
||||
|
||||
\par \--version
|
||||
Show version information.
|
||||
|
||||
# AUTHORS
|
||||
|
||||
The PipeWire Developers <$(PACKAGE_BUGREPORT)>;
|
||||
PipeWire is available from <$(PACKAGE_URL)>
|
||||
|
||||
# SEE ALSO
|
||||
|
||||
\ref page_man_pipewire_1 "pipewire(1)",
|
||||
\ref page_man_pw-cat_1 "pw-cat(1)"
|
||||
Loading…
Add table
Add a link
Reference in a new issue