Fix documentation of initdb --show option
authorPeter Eisentraut
Thu, 13 Jun 2024 09:52:35 +0000 (11:52 +0200)
committerPeter Eisentraut
Thu, 13 Jun 2024 09:52:35 +0000 (11:52 +0200)
It wasn't in the documentation at all (even though we document all the
other debugging-like options).  Also, change the --help output to show
that it exits after showing, similar to other options.

doc/src/sgml/ref/initdb.sgml
src/bin/initdb/initdb.c

index 74008a9a82f8756a4c6d8b3c52cc43d2cd451e93..bdd613e77ffdd8fcb05ab6de5926a8636389a8d2 100644 (file)
@@ -525,6 +525,18 @@ PostgreSQL documentation
       
      
 
+     
+      
+      
+      
+       
+        Show internal settings and exit, without doing anything else.  This
+        can be used to debug the initdb
+        installation.
+       
+      
+     
+
      
       
       
index 12ae194067f5da7d382cb58321f4c29428134af2..f00718a0150c2fd06870953906769411f087a7a0 100644 (file)
@@ -2481,7 +2481,7 @@ usage(const char *progname)
    printf(_("  -n, --no-clean            do not clean up after errors\n"));
    printf(_("  -N, --no-sync             do not wait for changes to be written safely to disk\n"));
    printf(_("      --no-instructions     do not print instructions for next steps\n"));
-   printf(_("  -s, --show                show internal settings\n"));
+   printf(_("  -s, --show                show internal settings, then exit\n"));
    printf(_("      --sync-method=METHOD  set method for syncing files to disk\n"));
    printf(_("  -S, --sync-only           only sync database files to disk, then exit\n"));
    printf(_("\nOther options:\n"));