From: Tom Lane <tgl@sss.pgh.pa.us>
Date: Sun, 8 Apr 2018 20:35:42 +0000 (-0400)
Subject: Doc: clarify explanation of pg_dump usage.
X-Git-Tag: REL_10_4~43
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=2ecd5fba9b4562a71c92eddff52b20a1b4b3af32;p=postgresql

Doc: clarify explanation of pg_dump usage.

This section confusingly used both "infile" and "outfile" to refer
to the same file, i.e. the textual output of pg_dump.  Use "dumpfile"
for both cases, per suggestion from Jonathan Katz.

Discussion: https://postgr.es/m/152311295239.31235.6487236091906987117@wrigleys.postgresql.org
---

diff --git a/doc/src/sgml/backup.sgml b/doc/src/sgml/backup.sgml
index 95aeb35507..327d87302b 100644
--- a/doc/src/sgml/backup.sgml
+++ b/doc/src/sgml/backup.sgml
@@ -35,7 +35,7 @@
    <xref linkend="app-pgdump"> for this purpose. The basic usage of this
    command is:
 <synopsis>
-pg_dump <replaceable class="parameter">dbname</replaceable> &gt; <replaceable class="parameter">outfile</replaceable>
+pg_dump <replaceable class="parameter">dbname</replaceable> &gt; <replaceable class="parameter">dumpfile</replaceable>
 </synopsis>
    As you see, <application>pg_dump</> writes its result to the
    standard output. We will see below how this can be useful.
@@ -109,9 +109,9 @@ pg_dump <replaceable class="parameter">dbname</replaceable> &gt; <replaceable cl
     be read in by the <application>psql</application> program. The
     general command form to restore a dump is
 <synopsis>
-psql <replaceable class="parameter">dbname</replaceable> &lt; <replaceable class="parameter">infile</replaceable>
+psql <replaceable class="parameter">dbname</replaceable> &lt; <replaceable class="parameter">dumpfile</replaceable>
 </synopsis>
-    where <replaceable class="parameter">infile</replaceable> is the
+    where <replaceable class="parameter">dumpfile</replaceable> is the
     file output by the <application>pg_dump</> command. The database <replaceable
     class="parameter">dbname</replaceable> will not be created by this
     command, so you must create it yourself from <literal>template0</>
@@ -141,7 +141,7 @@ psql <replaceable class="parameter">dbname</replaceable> &lt; <replaceable class
     behavior and have <application>psql</application> exit with an
     exit status of 3 if an SQL error occurs:
 <programlisting>
-psql --set ON_ERROR_STOP=on dbname &lt; infile
+psql --set ON_ERROR_STOP=on dbname &lt; dumpfile
 </programlisting>
     Either way, you will only have a partially restored database.
     Alternatively, you can specify that the whole dump should be
@@ -201,11 +201,11 @@ pg_dump -h <replaceable>host1</> <replaceable>dbname</> | psql -h <replaceable>h
     cluster, and also preserves cluster-wide data such as role and
     tablespace definitions. The basic usage of this command is:
 <synopsis>
-pg_dumpall &gt; <replaceable>outfile</>
+pg_dumpall &gt; <replaceable>dumpfile</>
 </synopsis>
     The resulting dump can be restored with <application>psql</>:
 <synopsis>
-psql -f <replaceable class="parameter">infile</replaceable> postgres
+psql -f <replaceable class="parameter">dumpfile</replaceable> postgres
 </synopsis>
     (Actually, you can specify any existing database name to start from,
     but if you are loading into an empty cluster then <literal>postgres</>