mirrors/postgres
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Copy-editing of pg_verify_checksums help and ref page

Browse Source 
Reformat synopsis, put options into better order, make the desciption
line a bit shorter, and put more details into the description.
This commit is contained in:
Peter Eisentraut 2018-08-23 20:32:56 +02:00
parent ca02434a0b
commit 9126b4ee1c
2 changed files with 27 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
doc/src/sgml/ref/pg_verify_checksums.sgml
View File

@ -16,14 +16,20 @@ PostgreSQL documentation
<refnamediv> <refnamediv>
<refname>pg_verify_checksums</refname> <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> </refnamediv>
<refsynopsisdiv> <refsynopsisdiv>
<cmdsynopsis> <cmdsynopsis>
<command>pg_verify_checksums</command> <command>pg_verify_checksums</command>
<arg choice="opt"><replaceable class="parameter">option</replaceable></arg> <arg rep="repeat" 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> <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> </cmdsynopsis>
</refsynopsisdiv> </refsynopsisdiv>
@ -31,7 +37,9 @@ PostgreSQL documentation
<title>Description</title> <title>Description</title>
<para> <para>
<command>pg_verify_checksums</command> verifies data checksums in a <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> </para>
</refsect1> </refsect1>
@ -42,7 +50,6 @@ PostgreSQL documentation
The following command-line options are available: The following command-line options are available:
<variablelist> <variablelist>
<varlistentry> <varlistentry>
<term><option>-D <replaceable>directory</replaceable></option></term> <term><option>-D <replaceable>directory</replaceable></option></term>
<term><option>--pgdata=<replaceable>directory</replaceable></option></term> <term><option>--pgdata=<replaceable>directory</replaceable></option></term>
@ -54,19 +61,19 @@ PostgreSQL documentation
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>-r <replaceable>relfilenode</replaceable></option></term> <term><option>-d</option></term>
<listitem> <listitem>
<para> <para>
Only validate checksums in the relation with specified relfilenode. Enable debug output. Lists all checked blocks and their checksum.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>-d</option></term> <term><option>-r <replaceable>relfilenode</replaceable></option></term>
<listitem> <listitem>
<para> <para>
Enable debug output. Lists all checked blocks and their checksum. Only validate checksums in the relation with specified relfilenode.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -111,13 +118,4 @@ PostgreSQL documentation
</varlistentry> </varlistentry>
</variablelist> </variablelist>
</refsect1> </refsect1>
<refsect1>
<title>Notes</title>
<para>
The cluster must be shut down cleanly before running
<application>pg_verify_checksums</application>.
</para>
</refsect1>
</refentry> </refentry>

8
src/bin/pg_verify_checksums/pg_verify_checksums.c
View File

@ -38,13 +38,13 @@ static const char *progname;
static void static void
usage() 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(_("Usage:\n"));
printf(_(" %s [OPTION] [DATADIR]\n"), progname); printf(_(" %s [OPTION]... [DATADIR]\n"), progname);
printf(_("\nOptions:\n")); printf(_("\nOptions:\n"));
printf(_(" [-D, --pgdata=]DATADIR data directory\n")); printf(_(" [-D, --pgdata=]DATADIR data directory\n"));
printf(_(" -r relfilenode check only relation with specified relfilenode\n")); printf(_(" -d debug output, list all checked blocks\n"));
printf(_(" -d debug output, listing all checked blocks\n")); printf(_(" -r RELFILENODE check only relation with specified relfilenode\n"));
printf(_(" -V, --version output version information, then exit\n")); printf(_(" -V, --version output version information, then exit\n"));
printf(_(" -?, --help show this help, then exit\n")); printf(_(" -?, --help show this help, then exit\n"));
printf(_("\nIf no data directory (DATADIR) is specified, " printf(_("\nIf no data directory (DATADIR) is specified, "