Document --dump-config.

Closes ticket 32467.

diff --git a/changes/ticket32467 b/changes/ticket32467
new file mode 100644 (file)
index 0000000..8cbb238
--- /dev/null
+++ b/changes/ticket32467
@@ -0,0 +1,3 @@
+  o Documentation:
+    - Describe the --dump-config command in the manual page. Closes ticket
+      32467.

diff --git a/doc/tor.1.txt b/doc/tor.1.txt
index a3c05961e37c00a49185c81679289d7c0af3ceaf..b2f6f59ca10cdf9bdcc9be92c4d12a14b975ebd4 100644 (file)
--- a/doc/tor.1.txt
+++ b/doc/tor.1.txt
@@ -96,6 +96,13 @@ The following options in this section are only recognized on the
 [[opt-verify-config]] **`--verify-config`**::
     Verify whether the configuration file is valid.
 
+[[opt-dump-config]] **`--dump-config`** **`short`**|**`full`**|**`non-builtin`**::
+    Write a complete list of Tor's configured options to standard output.
+    When the `short` flag is selected, only write the options that
+    are different from their default values.  When `non-builtin` is selected,
+    write options that are not zero or the empty string.
+    When `full` is selected, write every option.
+
 [[opt-serviceinstall]] **`--service install`** [**`--options`** __command-line options__]::
     Install an instance of Tor as a Windows service, with the provided
     command-line options. Current instructions can be found at