aboutsummaryrefslogtreecommitdiff
path: root/doc/src
diff options
context:
space:
mode:
authorMichael Paquier <michael@paquier.xyz>2019-03-13 10:43:20 +0900
committerMichael Paquier <michael@paquier.xyz>2019-03-13 10:43:20 +0900
commit6dd263cfaa8447470af4fae3f61c47438f91d71f (patch)
tree05b0730b06caa38d69f448e0dc649c97fa24b72f /doc/src
parentc9ae7f704c6772a99a456ed50d226c1fdf23f6d7 (diff)
downloadpostgresql-6dd263cfaa8447470af4fae3f61c47438f91d71f.tar.gz
postgresql-6dd263cfaa8447470af4fae3f61c47438f91d71f.zip
Rename pg_verify_checksums to pg_checksums
The current tool name is too restrictive and focuses only on verifying checksums. As more options to control checksums for an offline cluster are planned to be added, switch to a more generic name. Documentation as well as all past references to the tool are updated. Author: Michael Paquier Reviewed-by: Michael Banck, Fabien Coelho, Seigei Kornilov Discussion: https://postgr.es/m/20181221201616.GD4974@nighthawk.caipicrew.dd-dns.de
Diffstat (limited to 'doc/src')
-rw-r--r--doc/src/sgml/ref/allfiles.sgml2
-rw-r--r--doc/src/sgml/ref/pg_checksums.sgml (renamed from doc/src/sgml/ref/pg_verify_checksums.sgml)24
-rw-r--r--doc/src/sgml/reference.sgml2
3 files changed, 14 insertions, 14 deletions
diff --git a/doc/src/sgml/ref/allfiles.sgml b/doc/src/sgml/ref/allfiles.sgml
index c81c87ef41c..8d91f3529e6 100644
--- a/doc/src/sgml/ref/allfiles.sgml
+++ b/doc/src/sgml/ref/allfiles.sgml
@@ -199,6 +199,7 @@ Complete list of usable sgml source files in this directory.
<!ENTITY pgarchivecleanup SYSTEM "pgarchivecleanup.sgml">
<!ENTITY pgBasebackup SYSTEM "pg_basebackup.sgml">
<!ENTITY pgbench SYSTEM "pgbench.sgml">
+<!ENTITY pgChecksums SYSTEM "pg_checksums.sgml">
<!ENTITY pgConfig SYSTEM "pg_config-ref.sgml">
<!ENTITY pgControldata SYSTEM "pg_controldata.sgml">
<!ENTITY pgCtl SYSTEM "pg_ctl-ref.sgml">
@@ -210,7 +211,6 @@ Complete list of usable sgml source files in this directory.
<!ENTITY pgResetwal SYSTEM "pg_resetwal.sgml">
<!ENTITY pgRestore SYSTEM "pg_restore.sgml">
<!ENTITY pgRewind SYSTEM "pg_rewind.sgml">
-<!ENTITY pgVerifyChecksums SYSTEM "pg_verify_checksums.sgml">
<!ENTITY pgtestfsync SYSTEM "pgtestfsync.sgml">
<!ENTITY pgtesttiming SYSTEM "pgtesttiming.sgml">
<!ENTITY pgupgrade SYSTEM "pgupgrade.sgml">
diff --git a/doc/src/sgml/ref/pg_verify_checksums.sgml b/doc/src/sgml/ref/pg_checksums.sgml
index 905b8f12225..6a47dda6837 100644
--- a/doc/src/sgml/ref/pg_verify_checksums.sgml
+++ b/doc/src/sgml/ref/pg_checksums.sgml
@@ -1,27 +1,27 @@
<!--
-doc/src/sgml/ref/pg_verify_checksums.sgml
+doc/src/sgml/ref/pg_checksums.sgml
PostgreSQL documentation
-->
-<refentry id="pgverifychecksums">
- <indexterm zone="pgverifychecksums">
- <primary>pg_verify_checksums</primary>
+<refentry id="app-pgchecksums">
+ <indexterm zone="app-pgchecksums">
+ <primary>pg_checksums</primary>
</indexterm>
<refmeta>
- <refentrytitle><application>pg_verify_checksums</application></refentrytitle>
+ <refentrytitle><application>pg_checksums</application></refentrytitle>
<manvolnum>1</manvolnum>
<refmiscinfo>Application</refmiscinfo>
</refmeta>
<refnamediv>
- <refname>pg_verify_checksums</refname>
+ <refname>pg_checksums</refname>
<refpurpose>verify data checksums in a <productname>PostgreSQL</productname> database cluster</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
- <command>pg_verify_checksums</command>
+ <command>pg_checksums</command>
<arg rep="repeat" choice="opt"><replaceable class="parameter">option</replaceable></arg>
<group choice="opt">
<group choice="opt">
@@ -33,12 +33,12 @@ PostgreSQL documentation
</cmdsynopsis>
</refsynopsisdiv>
- <refsect1 id="r1-app-pg_verify_checksums-1">
+ <refsect1 id="r1-app-pg_checksums-1">
<title>Description</title>
<para>
- <command>pg_verify_checksums</command> verifies data checksums in a
+ <application>pg_checksums</application> verifies data checksums in a
<productname>PostgreSQL</productname> cluster. The server must be shut
- down cleanly before running <application>pg_verify_checksums</application>.
+ down cleanly before running <application>pg_checksums</application>.
The exit status is zero if there are no checksum errors, otherwise nonzero.
</para>
</refsect1>
@@ -84,7 +84,7 @@ PostgreSQL documentation
<term><option>--version</option></term>
<listitem>
<para>
- Print the <application>pg_verify_checksums</application> version and exit.
+ Print the <application>pg_checksums</application> version and exit.
</para>
</listitem>
</varlistentry>
@@ -94,7 +94,7 @@ PostgreSQL documentation
<term><option>--help</option></term>
<listitem>
<para>
- Show help about <application>pg_verify_checksums</application> command line
+ Show help about <application>pg_checksums</application> command line
arguments, and exit.
</para>
</listitem>
diff --git a/doc/src/sgml/reference.sgml b/doc/src/sgml/reference.sgml
index db4f4167e3c..cef09dd38b3 100644
--- a/doc/src/sgml/reference.sgml
+++ b/doc/src/sgml/reference.sgml
@@ -276,6 +276,7 @@
&initdb;
&pgarchivecleanup;
+ &pgChecksums;
&pgControldata;
&pgCtl;
&pgResetwal;
@@ -283,7 +284,6 @@
&pgtestfsync;
&pgtesttiming;
&pgupgrade;
- &pgVerifyChecksums;
&pgwaldump;
&postgres;
&postmaster;