Skip to content

Commit b02ee82

Browse files
tglsfdctglsfdc
committed
Assorted minor fixes for psql metacommand docs.
Document the long forms of \H \i \ir \o \p \r \w ... apparently, we have a long and dishonorable history of leaving out the unabbreviated names of psql backslash commands. Avoid saying "Unix shell"; we can just say "shell" with equal clarity, and not leave Windows users wondering whether the feature works for them. Improve consistency of documentation of \g \o \w metacommands. There's no reason to use slightly different wording or markup for each one.
1 parent 0489123 commit b02ee82

File tree

1 file changed

+23
-22
lines changed

1 file changed

+23
-22
lines changed

‎doc/src/sgml/ref/psql-ref.sgml

Lines changed: 23 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -598,7 +598,8 @@ EOF
598598
determined at compile time.
599599
Since the database server uses the same default, you will not have
600600
to specify the port in most cases. The default user name is your
601-
Unix user name, as is the default database name. Note that you cannot
601+
operating-system user name, as is the default database name.
602+
Note that you cannot
602603
just connect to any database under any user name. Your database
603604
administrator should have informed you about your access rights.
604605
</para>
@@ -1628,14 +1629,14 @@ Tue Oct 26 21:40:57 CEST 1999
16281629

16291630

16301631
<varlistentry>
1631-
<term><literal>\g</literal> [ { <replaceable class="parameter">filename</replaceable> | <literal>|</literal><replaceable class="parameter">command</replaceable> } ]</term>
1632-
1632+
<term><literal>\g [ <replaceable class="parameter">filename</replaceable> ]</literal></term>
1633+
<term><literal>\g [ |<replaceable class="parameter">command</replaceable> ]</literal></term>
16331634
<listitem>
16341635
<para>
1635-
Sends the current query input buffer to the server and
1636+
Sends the current query input buffer to the server, and
16361637
optionally stores the query's output in <replaceable
16371638
class="parameter">filename</replaceable> or pipes the output
1638-
into a separate Unix shell executing <replaceable
1639+
to the shell command <replaceable
16391640
class="parameter">command</replaceable>. The file or command is
16401641
written to only if the query successfully returns zero or more tuples,
16411642
not if the query fails or is a non-data-returning SQL command.
@@ -1649,7 +1650,7 @@ Tue Oct 26 21:40:57 CEST 1999
16491650
</varlistentry>
16501651

16511652
<varlistentry>
1652-
<term><literal>\gset</literal> [ <replaceable class="parameter">prefix</replaceable> ]</term>
1653+
<term><literal>\gset [ <replaceable class="parameter">prefix</replaceable> ]</literal></term>
16531654

16541655
<listitem>
16551656
<para>
@@ -1713,7 +1714,7 @@ hello 10
17131714

17141715

17151716
<varlistentry>
1716-
<term><literal>\H</literal></term>
1717+
<term><literal>\H</literal> or <literal>\html</literal></term>
17171718
<listitem>
17181719
<para>
17191720
Turns on <acronym>HTML</acronym> query output format. If the
@@ -1727,7 +1728,7 @@ hello 10
17271728

17281729

17291730
<varlistentry>
1730-
<term><literal>\i <replaceable class="parameter">filename</replaceable></literal></term>
1731+
<term><literal>\i</literal> or <literal>\include</literal> <replaceable class="parameter">filename</replaceable></term>
17311732
<listitem>
17321733
<para>
17331734
Reads input from the file <replaceable
@@ -1746,7 +1747,7 @@ hello 10
17461747

17471748

17481749
<varlistentry>
1749-
<term><literal>\ir <replaceable class="parameter">filename</replaceable></literal></term>
1750+
<term><literal>\ir</literal> or <literal>\include_relative</literal> <replaceable class="parameter">filename</replaceable></term>
17501751
<listitem>
17511752
<para>
17521753
The <literal>\ir</> command is similar to <literal>\i</>, but resolves
@@ -1862,15 +1863,15 @@ lo_import 152801
18621863

18631864

18641865
<varlistentry>
1865-
<term><literal>\o</literal> [ {<replaceable class="parameter">filename</replaceable> | <literal>|</literal><replaceable class="parameter">command</replaceable>} ]</term>
1866-
1866+
<term><literal>\o</literal> or <literal>\out [ <replaceable class="parameter">filename</replaceable> ]</literal></term>
1867+
<term><literal>\o</literal> or <literal>\out [ |<replaceable class="parameter">command</replaceable> ]</literal></term>
18671868
<listitem>
18681869
<para>
1869-
Saves future query results to the file <replaceable
1870-
class="parameter">filename</replaceable> or pipes future results
1871-
into a separate Unix shell to execute <replaceable
1872-
class="parameter">command</replaceable>. If no arguments are
1873-
specified, the query output will be reset to the standard output.
1870+
Arranges to save future query results to the file <replaceable
1871+
class="parameter">filename</replaceable> or pipe future results
1872+
to the shell command <replaceable
1873+
class="parameter">command</replaceable>. If no argument is
1874+
specified, the query output is reset to the standard output.
18741875
</para>
18751876

18761877
<para><quote>Query results</quote> includes all tables, command
@@ -1891,7 +1892,7 @@ lo_import 152801
18911892

18921893

18931894
<varlistentry>
1894-
<term><literal>\p</literal></term>
1895+
<term><literal>\p</literal> or <literal>\print</literal></term>
18951896
<listitem>
18961897
<para>
18971898
Print the current query buffer to the standard output.
@@ -2323,7 +2324,7 @@ lo_import 152801
23232324

23242325

23252326
<varlistentry>
2326-
<term><literal>\r</literal></term>
2327+
<term><literal>\r</literal> or <literal>\reset</literal></term>
23272328
<listitem>
23282329
<para>
23292330
Resets (clears) the query buffer.
@@ -2483,12 +2484,12 @@ testdb=&gt; <userinput>\setenv LESS -imx4F</userinput>
24832484

24842485

24852486
<varlistentry>
2486-
<term><literal>\w</literal> <replaceable class="parameter">filename</replaceable></term>
2487-
<term><literal>\w</literal> <literal>|</><replaceable class="parameter">command</replaceable></term>
2487+
<term><literal>\w</literal> or <literal>\write</literal> <replaceable class="parameter">filename</replaceable></term>
2488+
<term><literal>\w</literal> or <literal>\write</literal> <literal>|</><replaceable class="parameter">command</replaceable></term>
24882489
<listitem>
24892490
<para>
24902491
Outputs the current query buffer to the file <replaceable
2491-
class="parameter">filename</replaceable> or pipes it to the Unix
2492+
class="parameter">filename</replaceable> or pipes it to the shell
24922493
command <replaceable class="parameter">command</replaceable>.
24932494
</para>
24942495
</listitem>
@@ -2541,7 +2542,7 @@ testdb=&gt; <userinput>\setenv LESS -imx4F</userinput>
25412542
<term><literal>\! [ <replaceable class="parameter">command</replaceable> ]</literal></term>
25422543
<listitem>
25432544
<para>
2544-
Escapes to a separate Unix shell or executes the Unix command
2545+
Escapes to a separate shell or executes the shell command
25452546
<replaceable class="parameter">command</replaceable>. The
25462547
arguments are not further interpreted; the shell will see them
25472548
as-is. In particular, the variable substitution rules and

0 commit comments

Comments
 (0)