mirror of
https://gitlab.freedesktop.org/pipewire/pipewire.git
synced 2025-11-01 22:58:50 -04:00
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.
This commit is contained in:
parent
91f1b44499
commit
e41187d643
23 changed files with 813 additions and 912 deletions
51
man/pw-mididump.1.rst.in
Normal file
51
man/pw-mididump.1.rst.in
Normal file
|
|
@ -0,0 +1,51 @@
|
|||
.. This file is part of PipeWire.
|
||||
|
||||
pw-mididump
|
||||
###########
|
||||
|
||||
----------------------
|
||||
The PipeWire MIDI dump
|
||||
----------------------
|
||||
|
||||
:Manual section: 1
|
||||
:Manual group: General Commands Manual
|
||||
|
||||
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
|
||||
=======
|
||||
|
||||
-r | --remote=NAME
|
||||
The name the remote instance to monitor. If left unspecified,
|
||||
a connection is made to the default PipeWire instance.
|
||||
|
||||
-h | --help
|
||||
Show help.
|
||||
|
||||
--version
|
||||
Show version information.
|
||||
|
||||
AUTHORS
|
||||
=======
|
||||
|
||||
The PipeWire Developers <@PACKAGE_BUGREPORT@>; PipeWire is available from @PACKAGE_URL@
|
||||
|
||||
SEE ALSO
|
||||
========
|
||||
|
||||
``pipewire(1)``,
|
||||
``pw-cat(1)``,
|
||||
Loading…
Add table
Add a link
Reference in a new issue