Copy-editing of pg_verify_checksums help and ref page

Reformat synopsis, put options into better order, make the desciption
line a bit shorter, and put more details into the description.

diff --git a/doc/src/sgml/ref/pg_verify_checksums.sgml b/doc/src/sgml/ref/pg_verify_checksums.sgml
index c4c15a46bacab7886307a71a49f36bf41053a947..ecc5501eaec60246160969edbcceea90bcafe0b6 100644 (file)
--- a/doc/src/sgml/ref/pg_verify_checksums.sgml
+++ b/doc/src/sgml/ref/pg_verify_checksums.sgml
@@ -16,14 +16,20 @@ PostgreSQL documentation
 
  
   pg_verify_checksums
-  verify data checksums in an offline PostgreSQL database cluster
+  verify data checksums in a PostgreSQL database cluster
  
 
  
   
    pg_verify_checksums
-   option
-   -D--pgdata datadir
+   option
+   
+    
+     -D
+     --pgdata
+    
+     datadir
+   
   
  
 
@@ -31,7 +37,9 @@ PostgreSQL documentation
   Description
   
    pg_verify_checksums verifies data checksums in a
-   PostgreSQL cluster.
+   PostgreSQL cluster.  The server must be shut
+   down cleanly before running pg_verify_checksums.
+   The exit status is zero if there are no checksum errors, otherwise nonzero.
   
  
 
@@ -42,7 +50,6 @@ PostgreSQL documentation
     The following command-line options are available:
 
     
-
      
       -D directory
       --pgdata=directory
@@ -54,19 +61,19 @@ PostgreSQL documentation
      
 
      
-      -r relfilenode
+      -d
       
        
-        Only validate checksums in the relation with specified relfilenode.
+        Enable debug output. Lists all checked blocks and their checksum.
        
       
      
 
      
-      -d
+      -r relfilenode
       
        
-        Enable debug output. Lists all checked blocks and their checksum.
+        Only validate checksums in the relation with specified relfilenode.
        
       
      
@@ -76,7 +83,7 @@ PostgreSQL documentation
        --version
        
        
-       Print the pg_verify_checksums version and exit.
+        Print the pg_verify_checksums version and exit.
        
        
      
@@ -104,20 +111,11 @@ PostgreSQL documentation
 
     
      
-      Specifies the directory where the database cluster is 
+      Specifies the directory where the database cluster is
       stored; can be overridden using the -D option.
      
     
    
   
  
-
- 
-  Notes
-  
-   The cluster must be shut down cleanly before running
-   pg_verify_checksums.
-  
- 
-
 

diff --git a/src/bin/pg_verify_checksums/pg_verify_checksums.c b/src/bin/pg_verify_checksums/pg_verify_checksums.c
index 28c975446ebe0c734da57ae01dcb7194f57fa9e8..7cf3cf35c7aab3c53252adadc0557f064a21a8d5 100644 (file)
--- a/src/bin/pg_verify_checksums/pg_verify_checksums.c
+++ b/src/bin/pg_verify_checksums/pg_verify_checksums.c
@@ -38,13 +38,13 @@ static const char *progname;
 static void
 usage()
 {
-   printf(_("%s verifies page level checksums in offline PostgreSQL database cluster.\n\n"), progname);
+   printf(_("%s verifies data checksums in a PostgreSQL database cluster.\n\n"), progname);
    printf(_("Usage:\n"));
-   printf(_("  %s [OPTION] [DATADIR]\n"), progname);
+   printf(_("  %s [OPTION]... [DATADIR]\n"), progname);
    printf(_("\nOptions:\n"));
    printf(_(" [-D, --pgdata=]DATADIR  data directory\n"));
-   printf(_("  -r relfilenode         check only relation with specified relfilenode\n"));
-   printf(_("  -d                     debug output, listing all checked blocks\n"));
+   printf(_("  -d                     debug output, list all checked blocks\n"));
+   printf(_("  -r RELFILENODE         check only relation with specified relfilenode\n"));
    printf(_("  -V, --version          output version information, then exit\n"));
    printf(_("  -?, --help             show this help, then exit\n"));
    printf(_("\nIf no data directory (DATADIR) is specified, "