Skip to content

Commit 2d41d91

Browse files
peterepetere
committed
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.
1 parent d2cc897 commit 2d41d91

File tree

2 files changed

+22
-24
lines changed

2 files changed

+22
-24
lines changed

‎doc/src/sgml/ref/pg_verify_checksums.sgml

Lines changed: 18 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -16,22 +16,30 @@ PostgreSQL documentation
1616

1717
<refnamediv>
1818
<refname>pg_verify_checksums</refname>
19-
<refpurpose>verify data checksums in an offline <productname>PostgreSQL</productname> database cluster</refpurpose>
19+
<refpurpose>verify data checksums in a <productname>PostgreSQL</productname> database cluster</refpurpose>
2020
</refnamediv>
2121

2222
<refsynopsisdiv>
2323
<cmdsynopsis>
2424
<command>pg_verify_checksums</command>
25-
<arg choice="opt"><replaceable class="parameter">option</replaceable></arg>
26-
<arg choice="opt"><arg choice="opt"><option>-D</option></arg><arg choice="opt"><option>--pgdata</option></arg> <replaceable class="parameter">datadir</replaceable></arg>
25+
<arg rep="repeat" choice="opt"><replaceable class="parameter">option</replaceable></arg>
26+
<group choice="opt">
27+
<group choice="opt">
28+
<arg choice="plain"><option>-D</option></arg>
29+
<arg choice="plain"><option>--pgdata</option></arg>
30+
</group>
31+
<replaceable class="parameter"> datadir</replaceable>
32+
</group>
2733
</cmdsynopsis>
2834
</refsynopsisdiv>
2935

3036
<refsect1 id="r1-app-pg_verify_checksums-1">
3137
<title>Description</title>
3238
<para>
3339
<command>pg_verify_checksums</command> verifies data checksums in a
34-
<productname>PostgreSQL</productname> cluster.
40+
<productname>PostgreSQL</productname> cluster. The server must be shut
41+
down cleanly before running <application>pg_verify_checksums</application>.
42+
The exit status is zero if there are no checksum errors, otherwise nonzero.
3543
</para>
3644
</refsect1>
3745

@@ -42,7 +50,6 @@ PostgreSQL documentation
4250
The following command-line options are available:
4351

4452
<variablelist>
45-
4653
<varlistentry>
4754
<term><option>-D <replaceable>directory</replaceable></option></term>
4855
<term><option>--pgdata=<replaceable>directory</replaceable></option></term>
@@ -54,19 +61,19 @@ PostgreSQL documentation
5461
</varlistentry>
5562

5663
<varlistentry>
57-
<term><option>-r <replaceable>relfilenode</replaceable></option></term>
64+
<term><option>-d</option></term>
5865
<listitem>
5966
<para>
60-
Only validate checksums in the relation with specified relfilenode.
67+
Enable debug output. Lists all checked blocks and their checksum.
6168
</para>
6269
</listitem>
6370
</varlistentry>
6471

6572
<varlistentry>
66-
<term><option>-d</option></term>
73+
<term><option>-r <replaceable>relfilenode</replaceable></option></term>
6774
<listitem>
6875
<para>
69-
Enable debug output. Lists all checked blocks and their checksum.
76+
Only validate checksums in the relation with specified relfilenode.
7077
</para>
7178
</listitem>
7279
</varlistentry>
@@ -76,7 +83,7 @@ PostgreSQL documentation
7683
<term><option>--version</option></term>
7784
<listitem>
7885
<para>
79-
Print the <application>pg_verify_checksums</application> version and exit.
86+
Print the <application>pg_verify_checksums</application> version and exit.
8087
</para>
8188
</listitem>
8289
</varlistentry>
@@ -104,20 +111,11 @@ PostgreSQL documentation
104111

105112
<listitem>
106113
<para>
107-
Specifies the directory where the database cluster is
114+
Specifies the directory where the database cluster is
108115
stored; can be overridden using the <option>-D</option> option.
109116
</para>
110117
</listitem>
111118
</varlistentry>
112119
</variablelist>
113120
</refsect1>
114-
115-
<refsect1>
116-
<title>Notes</title>
117-
<para>
118-
The cluster must be shut down cleanly before running
119-
<application>pg_verify_checksums</application>.
120-
</para>
121-
</refsect1>
122-
123121
</refentry>

‎src/bin/pg_verify_checksums/pg_verify_checksums.c

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -38,13 +38,13 @@ static const char *progname;
3838
static void
3939
usage()
4040
{
41-
printf(_("%s verifies page level checksums in offline PostgreSQL database cluster.\n\n"), progname);
41+
printf(_("%s verifies data checksums in a PostgreSQL database cluster.\n\n"), progname);
4242
printf(_("Usage:\n"));
43-
printf(_(" %s [OPTION] [DATADIR]\n"), progname);
43+
printf(_(" %s [OPTION]... [DATADIR]\n"), progname);
4444
printf(_("\nOptions:\n"));
4545
printf(_(" [-D, --pgdata=]DATADIR data directory\n"));
46-
printf(_(" -r relfilenode check only relation with specified relfilenode\n"));
47-
printf(_(" -d debug output, listing all checked blocks\n"));
46+
printf(_(" -d debug output, list all checked blocks\n"));
47+
printf(_(" -r RELFILENODE check only relation with specified relfilenode\n"));
4848
printf(_(" -V, --version output version information, then exit\n"));
4949
printf(_(" -?, --help show this help, then exit\n"));
5050
printf(_("\nIf no data directory (DATADIR) is specified, "

0 commit comments

Comments
 (0)