database/postgres
1
0
Fork 0
mirror of https://github.com/postgres/postgres.git synced 2025-07-30 11:03:19 +03:00
Code Activity

psql documentation fixes

Browse Source 
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>
This commit is contained in:
Peter Eisentraut
2017-07-04 21:10:08 -04:00
parent 012d83f57a
commit 5191e357cf
2 changed files with 22 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
doc/src/sgml/ref/psql-ref.sgml
View File

@ -68,7 +68,8 @@ PostgreSQL documentation
<listitem> <listitem>
<para> <para>
Switches to unaligned output mode. (The default output mode is Switches to unaligned output mode. (The default output mode is
otherwise aligned.) otherwise aligned.) This is equivalent to <command>\pset format
unaligned</command>.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -371,8 +372,8 @@ EOF
<listitem> <listitem>
<para> <para>
Use <replaceable class="parameter">separator</replaceable> as the Use <replaceable class="parameter">separator</replaceable> as the
record separator for unaligned output. This is equivalent to the record separator for unaligned output. This is equivalent to
<command>\pset recordsep</command> command. <command>\pset recordsep</command>.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -415,7 +416,8 @@ EOF
<listitem> <listitem>
<para> <para>
Turn off printing of column names and result row count footers, Turn off printing of column names and result row count footers,
etc. This is equivalent to the <command>\t</command> command. etc. This is equivalent to <command>\t</command> or
<command>\pset tuples_only</command>.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -427,7 +429,7 @@ EOF
<para> <para>
Specifies options to be placed within the Specifies options to be placed within the
<acronym>HTML</acronym> <sgmltag>table</sgmltag> tag. See <acronym>HTML</acronym> <sgmltag>table</sgmltag> tag. See
<command>\pset</command> for details. <command>\pset tableattr</command> for details.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -522,8 +524,8 @@ EOF
<term><option>--expanded</></term> <term><option>--expanded</></term>
<listitem> <listitem>
<para> <para>
Turn on the expanded table formatting mode. This is equivalent to the Turn on the expanded table formatting mode. This is equivalent to
<command>\x</command> command. <command>\x</command> or <command>\pset expanded</command>.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -545,7 +547,8 @@ EOF
<term><option>--field-separator-zero</option></term> <term><option>--field-separator-zero</option></term>
<listitem> <listitem>
<para> <para>
Set the field separator for unaligned output to a zero byte. Set the field separator for unaligned output to a zero byte. This is
equvalent to <command>\pset fieldsep_zero</command>.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -557,6 +560,7 @@ EOF
<para> <para>
Set the record separator for unaligned output to a zero byte. This is Set the record separator for unaligned output to a zero byte. This is
useful for interfacing, for example, with <literal>xargs -0</literal>. useful for interfacing, for example, with <literal>xargs -0</literal>.
This is equivalent to <command>\pset recordsep_zero</command>.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -1907,9 +1911,8 @@ Tue Oct 26 21:40:57 CEST 1999
<listitem> <listitem>
<para> <para>
Sets the field separator for unaligned query output. The default Sets the field separator for unaligned query output. The default
is the vertical bar (<literal>|</literal>). See also is the vertical bar (<literal>|</literal>). It is equivalent to
<command>\pset</command> for a generic way of setting output <command>\pset fieldsep</command>.
options.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -2810,8 +2813,9 @@ lo_import 152801
<tip> <tip>
<para> <para>
There are various shortcut commands for <command>\pset</command>. See There are various shortcut commands for <command>\pset</command>. See
<command>\a</command>, <command>\C</command>, <command>\H</command>, <command>\a</command>, <command>\C</command>, <command>\f</command>,
<command>\t</command>, <command>\T</command>, and <command>\x</command>. <command>\H</command>, <command>\t</command>, <command>\T</command>,
and <command>\x</command>.
</para> </para>
</tip> </tip>

8
src/bin/psql/help.c
View File

@ -271,9 +271,11 @@ slashUsage(unsigned short int pager)
fprintf(output, _(" \\H toggle HTML output mode (currently %s)\n"), fprintf(output, _(" \\H toggle HTML output mode (currently %s)\n"),
ON(pset.popt.topt.format == PRINT_HTML)); ON(pset.popt.topt.format == PRINT_HTML));
fprintf(output, _(" \\pset [NAME [VALUE]] set table output option\n" fprintf(output, _(" \\pset [NAME [VALUE]] set table output option\n"
" (NAME := {format|border|expanded|fieldsep|fieldsep_zero|footer|null|\n" " (NAME := {border|columns|expanded|fieldsep|fieldsep_zero|\n"
" numericlocale|recordsep|recordsep_zero|tuples_only|title|tableattr|pager|\n" " footer|format|linestyle|null|numericlocale|pager|\n"
" unicode_border_linestyle|unicode_column_linestyle|unicode_header_linestyle})\n")); " pager_min_lines|recordsep|recordsep_zero|tableattr|title|\n"
" tuples_only|unicode_border_linestyle|\n"
" unicode_column_linestyle|unicode_header_linestyle})\n"));
fprintf(output, _(" \\t [on|off] show only rows (currently %s)\n"), fprintf(output, _(" \\t [on|off] show only rows (currently %s)\n"),
ON(pset.popt.topt.tuples_only)); ON(pset.popt.topt.tuples_only));
fprintf(output, _(" \\T [STRING] set HTML <table> tag attributes, or unset if none\n")); fprintf(output, _(" \\T [STRING] set HTML <table> tag attributes, or unset if none\n"));