man: add pw-config man page

man/meson.build

@@ -12,6 +12,7 @@ manpages = [
   'pipewire.conf.5.rst.in',
   'pw-cat.1.rst.in',
   'pw-cli.1.rst.in',
+  'pw-config.1.rst.in',
   'pw-dot.1.rst.in',
   'pw-link.1.rst.in',
   'pw-metadata.1.rst.in',

man/pw-config.1.rst.in

@@ -0,0 +1,110 @@
+pw-config
+#######
+
+-----------------------------
+Debug PipeWire Config parsing
+-----------------------------
+
+:Manual section: 1
+:Manual group: General Commands Manual
+
+SYNOPSIS
+========
+
+| **pw-config** [*options*] paths
+
+| **pw-config** [*options*] list [*SECTION*]
+
+| **pw-config** [*options*] merge *SECTION*
+
+DESCRIPTION
+===========
+
+List config paths and config sections and display the parsed
+output.
+
+This tool can be used to get an overview of the config file that will be
+parsed by the PipeWire server and clients.
+
+COMMON OPTIONS
+==============
+
+-h | --help
+  Show help.
+
+--version
+  Show version information.
+
+-n | --name=NAME
+  Config Name (default 'pipewire.conf')
+
+-p | --prefix=PREFIX
+  Config Prefix (default '')
+
+-L | --no-newline
+  Omit newlines after values
+
+-r | --recurse
+  Reformat config sections recursively
+
+-N | --no-colors
+  Disable color output
+
+-C | --color[=WHEN]
+  whether to enable color support. WHEN is `never`, `always`, or `auto`
+
+LISTING PATHS
+=============
+
+Specify the paths command. It will display all the config files that will
+be parsed and in what order.
+
+LISTING CONFIG SECTIONS
+=======================
+
+Specify the list command with an optional *SECTION* to list the configuration
+fragments used for *SECTION*. Without a *SECTION*, all sections will be
+listed.
+
+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
+a merged config section and dump the results. This will be the section used by
+the client or server.
+
+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 <@PACKAGE_BUGREPORT@>; PipeWire is available from @PACKAGE_URL@
+
+SEE ALSO
+========
+
+``pipewire(1)``,
+``pw-dump(1)``,

src/tools/pw-config.c

@@ -125,8 +125,8 @@ static void show_help(const char *name, bool error)
 		"      --version                         Show version\n"
 		"  -n, --name                            Config Name (default '%2$s')\n"
 		"  -p, --prefix                          Config Prefix (default '%3$s')\n"
-		"  -L, --no-newline                      Omit newline after values\n"
-		"  -r, --recurse                         Dump values recursively\n"
+		"  -L, --no-newline                      Omit newlines after values\n"
+		"  -r, --recurse                         Reformat config sections recursively\n"
 		"  -N, --no-colors                       disable color output\n"
 		"  -C, --color[=WHEN]                    whether to enable color support. WHEN is `never`, `always`, or `auto`\n",
 		name, DEFAULT_NAME, DEFAULT_PREFIX);