Add small example about pg_archivecleanup -x option

petere · petere · commit 92a953fbf8c9 · 2012-05-23T01:06:33.000+03:00
Every time I read this I had doubts about whether the argument to the
-x option should include the dot (yes).  A small example should
clarify this.
diff --git a/doc/src/sgml/pgarchivecleanup.sgml b/doc/src/sgml/pgarchivecleanup.sgml
@@ -114,7 +114,12 @@ pg_archivecleanup:  removing file "archive/00000001000000370000000E"
         that will be stripped from all file names before deciding if they
         should be deleted.  This is typically useful for cleaning up archives
         that have been compressed during storage, and therefore have had an
-        extension added by the compression program.  Note that the
+        extension added by the compression program.  For example: <literal>-x
+        .gz</literal>.
+       </para>
+
+       <para>
+        Note that the
         <filename>.backup</> file name passed to the program should not
         include the extension.
        </para>
