Commit graph

7 commits

Author SHA1 Message Date
Wim Taymans
f996249fff man: update man page some more
Add some more mentions that modules can not be loaded in a remote
instance in PipeWire.

Also mention the special internal remote name to connect to the local
pw-cli instance.

Fixes #2988
2023-05-15 13:31:13 +02:00
Simon Ruderich
107fb7c854 man: pw-cli: remove empty examples section 2023-04-12 10:13:05 +00:00
Wim Taymans
851bfba6ed pw-cli: add alias in comand help
Add alias to docs and mention alias in help.

Fixes #2552
2022-08-10 10:35:35 +02:00
Wim Taymans
fd46ef16ed man: update pw-cli man page
See #2552
2022-07-19 16:58:47 +02: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
Peter Hutterer
7d58ce9e24 pw-cli: add a 'quit' command to exit
Slightly less confusing for new users if we have at least one
help-listed command to exit.
2021-09-28 07:19:13 +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