pw-config(1)

✨ pw-config(1) β€” the PipeWire config whisperer ✨

okay bestie, so like… this is pw-config, a General Commands Manual situation from the PipeWire girlies πŸ’–. It's the tool for debugging PipeWire Config parsing, and honestly? It's giving backstage pass to your entire config setup. No cap.


🌸 NAME 🌸

pw-config β€” Debug PipeWire Config parsing πŸ¦‹


πŸŽ€ SYNOPSIS πŸŽ€

pw-config [options] paths

pw-config [options] list [SECTION]

pw-config [options] merge SECTION

πŸ’… DESCRIPTION πŸ’…

So what does it actually do, you ask? It lists config paths and config sections and displays the parsed output ✨.

Lowkey the whole point: this tool gets you an overview of the config file that will be parsed by the PipeWire server and the clients. Main character energy for your debugging era πŸ‘‘


⭐ COMMON OPTIONS ⭐

  • -h | --help β€” shows help. iconic, we love a supportive king 🫢
  • --version β€” shows version information. vibe check on which build you're running πŸ’œ
  • -n | --name=NAME β€” the Config Name. default is 'pipewire.conf' πŸ“
  • -p | --prefix=PREFIX β€” the Config Prefix. default is '' (yes, empty, it's that girl) 🌸
  • -L | --no-newline β€” omits newlines after values. compact mode fr fr 😌
  • -r | --recurse β€” reformats config sections recursively πŸ”βœ¨
  • -N | --no-colors β€” disables color output. (sad, but sometimes you gotta) 😭
  • -C | -color[=WHEN] β€” whether to enable color support. WHEN is never, always, or auto 🌈
ngl the -C one is written with a single dash for -color, bestie β€” that's not a typo on my end, that's literally what the manpage says, so don't come for me πŸ’€

πŸ¦‹ LISTING PATHS πŸ¦‹

Say the magic word β€” specify the paths command β€” and it will display all the config files that will be parsed and in what order πŸ“‹πŸ’–

It's giving a full lineup announcement for your config files. slay.


🌈 LISTING CONFIG SECTIONS 🌈

Specify the list command, optionally with a SECTION, and it lists the configuration fragments used for SECTION ✨. Leave out the SECTION and all sections get listed. generous queen.

Use the -r options to reformat the sections πŸ’«


πŸ‘‘ MERGING A CONFIG SECTION πŸ‘‘

With the merge option and a SECTION, pw-config will merge all config files into one merged config section and dump the results πŸ“¦βœ¨.

This will be the section used by the client or server. iykyk, that's the real one πŸ”₯

Use the -r options to reformat the sections πŸ’«


🧚 EXAMPLES 🧚

  • pw-config β€” list all config files that will be used πŸ’–
  • pw-config -n pipewire-pulse.conf β€” list all config files that will be used by the PipeWire pulseaudio server 🎧
  • pw-config -n pipewire-pulse.conf list β€” list all config sections used by the PipeWire pulseaudio server πŸ“œ
  • pw-config -n jack.conf list context.properties β€” list the context.properties fragments used by the JACK clients πŸŽ›οΈ
  • pw-config -n jack.conf merge context.properties β€” list the merged context.properties used by the JACK clients πŸ”—
  • pw-config -n pipewire.conf -r merge context.modules β€” list the merged context.modules used by the PipeWire server and reformat βœ¨πŸ”

πŸ’œ AUTHORS πŸ’œ

The PipeWire Developers πŸ‘‘

Issues live at <https://gitlab.freedesktop.org/pipewire/pipewire/issues>; PipeWire is available from <https://pipewire.org> 🌐


πŸ™ˆ SEE ALSO πŸ™ˆ

pipewire(1), pw-dump(1), 🫢


okay that's the whole page, bestie, we ate and left absolutely no crumbs πŸ’…βœ¨ this was PipeWire 1.6.11, periodt. go debug your configs, you gorgeous genius πŸŽ€πŸ¦‹πŸ’–

πŸ“¦ where this page comes from