Location via proxy:   [ UP ]  
[Report a bug]   [Manage cookies]                
Skip to content

Commit 5191e35

Browse files
committed
psql documentation fixes
Update the documentation for \pset to mention columns|linestyle|pager_min_lines. Add various mentions of \pset command equivalences that were previously inconsistent. Author: Дилян Палаузов <dpa-postgres@aegee.org>
1 parent 012d83f commit 5191e35

File tree

2 files changed

+22
-16
lines changed

2 files changed

+22
-16
lines changed

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

Lines changed: 17 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,8 @@ PostgreSQL documentation
6868
<listitem>
6969
<para>
7070
Switches to unaligned output mode. (The default output mode is
71-
otherwise aligned.)
71+
otherwise aligned.) This is equivalent to <command>\pset format
72+
unaligned</command>.
7273
</para>
7374
</listitem>
7475
</varlistentry>
@@ -371,8 +372,8 @@ EOF
371372
<listitem>
372373
<para>
373374
Use <replaceable class="parameter">separator</replaceable> as the
374-
record separator for unaligned output. This is equivalent to the
375-
<command>\pset recordsep</command> command.
375+
record separator for unaligned output. This is equivalent to
376+
<command>\pset recordsep</command>.
376377
</para>
377378
</listitem>
378379
</varlistentry>
@@ -415,7 +416,8 @@ EOF
415416
<listitem>
416417
<para>
417418
Turn off printing of column names and result row count footers,
418-
etc. This is equivalent to the <command>\t</command> command.
419+
etc. This is equivalent to <command>\t</command> or
420+
<command>\pset tuples_only</command>.
419421
</para>
420422
</listitem>
421423
</varlistentry>
@@ -427,7 +429,7 @@ EOF
427429
<para>
428430
Specifies options to be placed within the
429431
<acronym>HTML</acronym> <sgmltag>table</sgmltag> tag. See
430-
<command>\pset</command> for details.
432+
<command>\pset tableattr</command> for details.
431433
</para>
432434
</listitem>
433435
</varlistentry>
@@ -522,8 +524,8 @@ EOF
522524
<term><option>--expanded</></term>
523525
<listitem>
524526
<para>
525-
Turn on the expanded table formatting mode. This is equivalent to the
526-
<command>\x</command> command.
527+
Turn on the expanded table formatting mode. This is equivalent to
528+
<command>\x</command> or <command>\pset expanded</command>.
527529
</para>
528530
</listitem>
529531
</varlistentry>
@@ -545,7 +547,8 @@ EOF
545547
<term><option>--field-separator-zero</option></term>
546548
<listitem>
547549
<para>
548-
Set the field separator for unaligned output to a zero byte.
550+
Set the field separator for unaligned output to a zero byte. This is
551+
equvalent to <command>\pset fieldsep_zero</command>.
549552
</para>
550553
</listitem>
551554
</varlistentry>
@@ -557,6 +560,7 @@ EOF
557560
<para>
558561
Set the record separator for unaligned output to a zero byte. This is
559562
useful for interfacing, for example, with <literal>xargs -0</literal>.
563+
This is equivalent to <command>\pset recordsep_zero</command>.
560564
</para>
561565
</listitem>
562566
</varlistentry>
@@ -1907,9 +1911,8 @@ Tue Oct 26 21:40:57 CEST 1999
19071911
<listitem>
19081912
<para>
19091913
Sets the field separator for unaligned query output. The default
1910-
is the vertical bar (<literal>|</literal>). See also
1911-
<command>\pset</command> for a generic way of setting output
1912-
options.
1914+
is the vertical bar (<literal>|</literal>). It is equivalent to
1915+
<command>\pset fieldsep</command>.
19131916
</para>
19141917
</listitem>
19151918
</varlistentry>
@@ -2810,8 +2813,9 @@ lo_import 152801
28102813
<tip>
28112814
<para>
28122815
There are various shortcut commands for <command>\pset</command>. See
2813-
<command>\a</command>, <command>\C</command>, <command>\H</command>,
2814-
<command>\t</command>, <command>\T</command>, and <command>\x</command>.
2816+
<command>\a</command>, <command>\C</command>, <command>\f</command>,
2817+
<command>\H</command>, <command>\t</command>, <command>\T</command>,
2818+
and <command>\x</command>.
28152819
</para>
28162820
</tip>
28172821

src/bin/psql/help.c

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -271,9 +271,11 @@ slashUsage(unsigned short int pager)
271271
fprintf(output, _(" \\H toggle HTML output mode (currently %s)\n"),
272272
ON(pset.popt.topt.format == PRINT_HTML));
273273
fprintf(output, _(" \\pset [NAME [VALUE]] set table output option\n"
274-
" (NAME := {format|border|expanded|fieldsep|fieldsep_zero|footer|null|\n"
275-
" numericlocale|recordsep|recordsep_zero|tuples_only|title|tableattr|pager|\n"
276-
" unicode_border_linestyle|unicode_column_linestyle|unicode_header_linestyle})\n"));
274+
" (NAME := {border|columns|expanded|fieldsep|fieldsep_zero|\n"
275+
" footer|format|linestyle|null|numericlocale|pager|\n"
276+
" pager_min_lines|recordsep|recordsep_zero|tableattr|title|\n"
277+
" tuples_only|unicode_border_linestyle|\n"
278+
" unicode_column_linestyle|unicode_header_linestyle})\n"));
277279
fprintf(output, _(" \\t [on|off] show only rows (currently %s)\n"),
278280
ON(pset.popt.topt.tuples_only));
279281
fprintf(output, _(" \\T [STRING] set HTML <table> tag attributes, or unset if none\n"));

0 commit comments

Comments
 (0)