1
Fork 0
Commit Graph

83 Commits

Author SHA1 Message Date
Simon Ruderich 615f950c2f pw-top: add missing options to man page and improve --help output 2023-09-11 18:50:24 +00:00
Boud Roukema ffff61e869 Clarify in man page that pipewire-pulse runs its own pipewire process
Prior to this commit, the man page for pipewire-pulse did not
make it clear that although pipewire-pulse is "integrated"
in a general sense with the pipewire system, it runs its own
pipewire process, that is, in some sense, independent. For
example, restarting the pipewire service does not restart
the pipewire-pulse service.

The aim of this commit is to improve people's understanding of the
relation between pipewire-pulse and pipewire in the most obvious
place where they would expect to find it.
2023-09-01 08:06:43 +00:00
Felix Yan feb21a25f0 Correct a typo in pipewire.conf.5.rst.in 2023-08-31 10:04:25 +00:00
Wim Taymans aca8bced9e man: improve pw-cat man page formats
See #3389
2023-07-27 14:41:29 +02:00
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
Wim Taymans 7f8e863e9b man: fix underline in pw-config man 2023-04-20 10:26:12 +02:00
Wim Taymans e90e948166 man: add pw-config man page 2023-04-20 10:24:29 +02:00
Wim Taymans ccd118368e pw-metadata: add -l option to list available metadata 2023-04-14 15:06:55 +02:00
Simon Ruderich 85e971dc06 man: pipewire.conf(5): fix rendering of quotes in JSON
Breaking the line causes the first line to be rendered in bold and the
second to be indented.
2023-04-12 10:13:05 +00:00
Simon Ruderich 107fb7c854 man: pw-cli: remove empty examples section 2023-04-12 10:13:05 +00:00
Simon Ruderich d491adf4dd man: pw-metadata: add examples 2023-04-12 10:13:05 +00:00
Simon Ruderich 17c46a9f68 man: pw-metadata: document --name option 2023-04-12 10:13:05 +00:00
Simon Ruderich f74f600601 man: pw-metadata: fix display of --delete and remove unnecessary paragraph
With the extra newline the -d/--delete option is not styled as bold in
the resulting man page.
2023-04-12 10:13:05 +00:00
Dylan Aïssi 4329961a67 man: fix typo in pw-link: Whithout -> Without 2023-01-12 18:08:28 +01:00
Dylan Aïssi d653f26343 man: fix typo in pw-cat: seperator -> separator 2023-01-12 18:07:57 +01:00
Wim Taymans d247db8d26 pw-top: improve output
Show the node state in the S column
Use the node state to show or hide info, this will only show info for
active nodes.
Do redraw updates when something important changes
Update man page
2022-10-25 16:24:03 +02:00
Wim Taymans ed8be8e393 man: add some more see also manpages 2022-09-26 10:07:32 +02:00
Wim Taymans e9b7667b55 pw-top: remove some slashes to avoid confusion
Update man page
2022-09-06 18:32:56 +02:00
Wim Taymans d90d2c92f4 man: update man page 2022-09-06 15:47:13 +02:00
Wim Taymans 8efc221fa8 man: clarify MIDI and DSD playback
These tools don't render MIDI or DSD, you need separate tools or
hardware for that.
2022-09-06 10:03:52 +02: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
Wim Taymans 840fa000eb man: escape |
It is used for delimiting a reference.
2022-05-21 19:46:02 +02:00
Wim Taymans 700b1e7ff8 man: update pw-cat man page 2022-05-20 08:23:43 +02:00
jasker5183 8358f020db Add --volume description 2022-05-02 15:42:09 +00:00
Wim Taymans df98c748b4 man: update pw-top man page 2022-04-19 19:50:08 +02:00
Wim Taymans 1dcc81b260 man: improve pw-top man page 2022-04-19 15:20:10 +02:00
Wim Taymans 339c22dce9 pw-cat: update man page 2022-04-13 16:04:35 +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
Michael D eec017f245 Update man/pw-top.1.rst.in 2022-03-04 22:43:51 +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
Wim Taymans ae077a4967 doc: update with config overrides info 2022-02-03 17:31:01 +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 671410b3bf pw-mon: add support for colored output
Same CLI as pw-dump, i.e. -N, --no-colors, --color=always etc are
supported.

This uses a for-loop macro hack to automatically print prefixes and
suffixes, the with_prefix() macro resolves into the correct printf
statements to insert either just the marker "*" or the ansi sequences
for color/reset. Use of the macro is simply:
```
   with_prefix(true, stderr) {
	fprintf(stderr, "this will be prefixed\n");
   }
```
2021-11-11 08:21:58 +00: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
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
Peter Hutterer 69e935e8a4 daemon: allow for a -v, -vv, -vvv argument to increase verbosity
Sometimes that's faster than having to play with PIPEWIRE_DEBUG.
Same for pipewire-media-session.
2021-09-24 10:49:42 +00:00
Peter Hutterer 39fa2e503f man: fix an indentation issue in pipewire.1 2021-09-24 10:49:42 +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 d51634a2f1 man: add --config to the pipewire man page 2021-07-05 08:57:41 +00:00
Peter Hutterer c8c0a152b7 man: drop --name documentation from pipewire.1
Support for this was dropped in 80825aeaea
2021-05-27 11:27:39 +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 59a8253047 man: fix the pipewire.conf man page
This still referred to a config file format prior to 49d11acde0. Reword
sections accordingly and try to explain the actual configuration file format.

xmltoman is quite limited in its supported tags, so we need to use wrong tags
to get some sensible formatting, notably <opt> to get a bold word.
2021-05-20 07:34:17 +00:00
Andrea Gelmini 85b136d8ce Fix typos
Signed-off-by: Andrea Gelmini <andrea.gelmini@gelma.net>
2021-04-30 16:27:34 +00:00