[PATCH] Refresh documentation for psql

From: Дилян Палаузов <dpa-postgres(at)aegee(dot)org>
To: pgsql-bugs(at)postgresql(dot)org
Subject: [PATCH] Refresh documentation for psql
Date: 2017-05-05 20:48:32
Message-ID: 20170505204832.26930-1-dpa-postgres@aegee.org
Views: Raw Message | Whole Thread | Download mbox | Resend email
Thread:
Lists: pgsql-bugs

in src/bin/psql/help.c: on \? ensure the output is alphabetically ordered
in regards to \d; update the documenation for \pset to mention
columns|linestyle|pager_min_lines
---
doc/src/sgml/ref/psql-ref.sgml | 30 +++++++++++++++++-------------
src/bin/psql/help.c | 11 ++++++-----
2 files changed, 23 insertions(+), 18 deletions(-)

diff --git a/doc/src/sgml/ref/psql-ref.sgml b/doc/src/sgml/ref/psql-ref.sgml
index 0c846e1452..d16b359f74 100644
--- a/doc/src/sgml/ref/psql-ref.sgml
+++ b/doc/src/sgml/ref/psql-ref.sgml
@@ -68,7 +68,8 @@ PostgreSQL documentation
<listitem>
<para>
Switches to unaligned output mode. (The default output mode is
- otherwise aligned.)
+ otherwise aligned.) This is equivalent to <command>\pset format
+ unaligned</command>.
</para>
</listitem>
</varlistentry>
@@ -371,8 +372,8 @@ EOF
<listitem>
<para>
Use <replaceable class="parameter">separator</replaceable> as the
- record separator for unaligned output. This is equivalent to the
- <command>\pset recordsep</command> command.
+ record separator for unaligned output. This is equivalent to
+ <command>\pset recordsep</command>.
</para>
</listitem>
</varlistentry>
@@ -415,7 +416,8 @@ EOF
<listitem>
<para>
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>
</listitem>
</varlistentry>
@@ -427,7 +429,7 @@ EOF
<para>
Specifies options to be placed within the
<acronym>HTML</acronym> <sgmltag>table</sgmltag> tag. See
- <command>\pset</command> for details.
+ <command>\pset tableattr</command> for details.
</para>
</listitem>
</varlistentry>
@@ -522,8 +524,8 @@ EOF
<term><option>--expanded</></term>
<listitem>
<para>
- Turn on the expanded table formatting mode. This is equivalent to the
- <command>\x</command> command.
+ Turn on the expanded table formatting mode. This is equivalent to
+ <command>\x</command> or <command>\pset expanded</command>.
</para>
</listitem>
</varlistentry>
@@ -545,7 +547,8 @@ EOF
<term><option>--field-separator-zero</option></term>
<listitem>
<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>
</listitem>
</varlistentry>
@@ -557,6 +560,7 @@ EOF
<para>
Set the record separator for unaligned output to a zero byte. This is
useful for interfacing, for example, with <literal>xargs -0</literal>.
+ This is equivalent to <command>\pset recordsep_zero</command>.
</para>
</listitem>
</varlistentry>
@@ -1832,9 +1836,8 @@ Tue Oct 26 21:40:57 CEST 1999
<listitem>
<para>
Sets the field separator for unaligned query output. The default
- is the vertical bar (<literal>|</literal>). See also
- <command>\pset</command> for a generic way of setting output
- options.
+ is the vertical bar (<literal>|</literal>). It is equivalent to
+ <command>\pset fieldsep</command>.
</para>
</listitem>
</varlistentry>
@@ -2597,8 +2600,9 @@ lo_import 152801
<tip>
<para>
There are various shortcut commands for <command>\pset</command>. See
- <command>\a</command>, <command>\C</command>, <command>\H</command>,
- <command>\t</command>, <command>\T</command>, and <command>\x</command>.
+ <command>\a</command>, <command>\f</command>, <command>\C</command>,
+ <command>\H</command>, <command>\t</command>, <command>\T</command>,
+ and <command>\x</command>.
</para>
</tip>

diff --git a/src/bin/psql/help.c b/src/bin/psql/help.c
index a69c4dd8cf..92e7f308fd 100644
--- a/src/bin/psql/help.c
+++ b/src/bin/psql/help.c
@@ -226,7 +226,8 @@ slashUsage(unsigned short int pager)
fprintf(output, _(" \\des[+] [PATTERN] list foreign servers\n"));
fprintf(output, _(" \\deu[+] [PATTERN] list user mappings\n"));
fprintf(output, _(" \\dew[+] [PATTERN] list foreign-data wrappers\n"));
- fprintf(output, _(" \\df[antw][S+] [PATRN] list [only agg/normal/trigger/window] functions\n"));
+ fprintf(output, _(" \\dE[S+] [PATTERN] list foreign tables\n"));
+ fprintf(output, _(" \\df[antwS+] [PATRN] list [only agg/normal/trigger/window] functions\n"));
fprintf(output, _(" \\dF[+] [PATTERN] list text search configurations\n"));
fprintf(output, _(" \\dFd[+] [PATTERN] list text search dictionaries\n"));
fprintf(output, _(" \\dFp[+] [PATTERN] list text search parsers\n"));
@@ -246,7 +247,6 @@ slashUsage(unsigned short int pager)
fprintf(output, _(" \\dT[S+] [PATTERN] list data types\n"));
fprintf(output, _(" \\du[S+] [PATTERN] list roles\n"));
fprintf(output, _(" \\dv[S+] [PATTERN] list views\n"));
- fprintf(output, _(" \\dE[S+] [PATTERN] list foreign tables\n"));
fprintf(output, _(" \\dx[+] [PATTERN] list extensions\n"));
fprintf(output, _(" \\dy [PATTERN] list event triggers\n"));
fprintf(output, _(" \\l[+] [PATTERN] list databases\n"));
@@ -262,9 +262,10 @@ slashUsage(unsigned short int pager)
fprintf(output, _(" \\H toggle HTML output mode (currently %s)\n"),
ON(pset.popt.topt.format == PRINT_HTML));
fprintf(output, _(" \\pset [NAME [VALUE]] set table output option\n"
- " (NAME := {format|border|expanded|fieldsep|fieldsep_zero|footer|null|\n"
- " numericlocale|recordsep|recordsep_zero|tuples_only|title|tableattr|pager|\n"
- " unicode_border_linestyle|unicode_column_linestyle|unicode_header_linestyle})\n"));
+ " (NAME := {border|columns|expanded|fieldsep|fieldsep_zero|footer|format|\n"
+ " linestyle|null|numericlocale|pager|pager_min_lines|recordsep|recordsep_zero|\n"
+ " tableattr|title|tuples_only|unicode_border_linestyle|\n"
+ " unicode_column_linestyle|unicode_header_linestyle})\n"));
fprintf(output, _(" \\t [on|off] show only rows (currently %s)\n"),
ON(pset.popt.topt.tuples_only));
fprintf(output, _(" \\T [STRING] set HTML <table> tag attributes, or unset if none\n"));
--
2.12.2.89.g49800c940

Responses

Browse pgsql-bugs by date

  From Date Subject
Next Message Дилян Палаузов 2017-05-05 20:52:05 psql history and "-- lines"
Previous Message Tom Lane 2017-05-05 19:01:22 Re: BUG #13810: cursor_to_xml ignores tableforest parameter