aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPeter Eisentraut <peter_e@gmx.net>2018-08-23 20:32:56 +0200
committerPeter Eisentraut <peter_e@gmx.net>2018-08-23 20:33:39 +0200
commit9126b4ee1c59ef07c55227b55c45a8d4bc6590d9 (patch)
tree06942c99aae4dc8900ae6c6d67ffc9321d32fb36
parentca02434a0b86e7dbc5b790f1a4d6b782ca8f4916 (diff)
downloadpostgresql-9126b4ee1c59ef07c55227b55c45a8d4bc6590d9.tar.gz
postgresql-9126b4ee1c59ef07c55227b55c45a8d4bc6590d9.zip
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.
-rw-r--r--doc/src/sgml/ref/pg_verify_checksums.sgml38
-rw-r--r--src/bin/pg_verify_checksums/pg_verify_checksums.c8
2 files changed, 22 insertions, 24 deletions
diff --git a/doc/src/sgml/ref/pg_verify_checksums.sgml b/doc/src/sgml/ref/pg_verify_checksums.sgml
index c4c15a46bac..ecc5501eaec 100644
--- a/doc/src/sgml/ref/pg_verify_checksums.sgml
+++ b/doc/src/sgml/ref/pg_verify_checksums.sgml
@@ -16,14 +16,20 @@ PostgreSQL documentation
<refnamediv>
<refname>pg_verify_checksums</refname>
- <refpurpose>verify data checksums in an offline <productname>PostgreSQL</productname> database cluster</refpurpose>
+ <refpurpose>verify data checksums in a <productname>PostgreSQL</productname> database cluster</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>pg_verify_checksums</command>
- <arg choice="opt"><replaceable class="parameter">option</replaceable></arg>
- <arg choice="opt"><arg choice="opt"><option>-D</option></arg><arg choice="opt"><option>--pgdata</option></arg> <replaceable class="parameter">datadir</replaceable></arg>
+ <arg rep="repeat" choice="opt"><replaceable class="parameter">option</replaceable></arg>
+ <group choice="opt">
+ <group choice="opt">
+ <arg choice="plain"><option>-D</option></arg>
+ <arg choice="plain"><option>--pgdata</option></arg>
+ </group>
+ <replaceable class="parameter"> datadir</replaceable>
+ </group>
</cmdsynopsis>
</refsynopsisdiv>
@@ -31,7 +37,9 @@ PostgreSQL documentation
<title>Description</title>
<para>
<command>pg_verify_checksums</command> verifies data checksums in a
- <productname>PostgreSQL</productname> cluster.
+ <productname>PostgreSQL</productname> cluster. The server must be shut
+ down cleanly before running <application>pg_verify_checksums</application>.
+ The exit status is zero if there are no checksum errors, otherwise nonzero.
</para>
</refsect1>
@@ -42,7 +50,6 @@ PostgreSQL documentation
The following command-line options are available:
<variablelist>
-
<varlistentry>
<term><option>-D <replaceable>directory</replaceable></option></term>
<term><option>--pgdata=<replaceable>directory</replaceable></option></term>
@@ -54,19 +61,19 @@ PostgreSQL documentation
</varlistentry>
<varlistentry>
- <term><option>-r <replaceable>relfilenode</replaceable></option></term>
+ <term><option>-d</option></term>
<listitem>
<para>
- Only validate checksums in the relation with specified relfilenode.
+ Enable debug output. Lists all checked blocks and their checksum.
</para>
</listitem>
</varlistentry>
<varlistentry>
- <term><option>-d</option></term>
+ <term><option>-r <replaceable>relfilenode</replaceable></option></term>
<listitem>
<para>
- Enable debug output. Lists all checked blocks and their checksum.
+ Only validate checksums in the relation with specified relfilenode.
</para>
</listitem>
</varlistentry>
@@ -76,7 +83,7 @@ PostgreSQL documentation
<term><option>--version</option></term>
<listitem>
<para>
- Print the <application>pg_verify_checksums</application> version and exit.
+ Print the <application>pg_verify_checksums</application> version and exit.
</para>
</listitem>
</varlistentry>
@@ -104,20 +111,11 @@ PostgreSQL documentation
<listitem>
<para>
- Specifies the directory where the database cluster is
+ Specifies the directory where the database cluster is
stored; can be overridden using the <option>-D</option> option.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
-
- <refsect1>
- <title>Notes</title>
- <para>
- The cluster must be shut down cleanly before running
- <application>pg_verify_checksums</application>.
- </para>
- </refsect1>
-
</refentry>
diff --git a/src/bin/pg_verify_checksums/pg_verify_checksums.c b/src/bin/pg_verify_checksums/pg_verify_checksums.c
index 28c975446eb..7cf3cf35c7a 100644
--- 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, "