From 0d9bdbcaae00dac89a82c25e66e4a859130e2fe8 Mon Sep 17 00:00:00 2001 From: Peter Eisentraut Date: Wed, 14 Jun 2017 11:09:33 -0400 Subject: [PATCH] Put documentation of options and commands in more alphabetical order --- doc/src/sgml/ref/initdb.sgml | 4 +- doc/src/sgml/ref/pg_dump.sgml | 28 +++++------ doc/src/sgml/ref/psql-ref.sgml | 89 +++++++++++++++++----------------- src/bin/psql/help.c | 14 +++--- 4 files changed, 68 insertions(+), 67 deletions(-) diff --git a/doc/src/sgml/ref/initdb.sgml b/doc/src/sgml/ref/initdb.sgml index 3ce99e248b..6efb2e442d 100644 --- a/doc/src/sgml/ref/initdb.sgml +++ b/doc/src/sgml/ref/initdb.sgml @@ -276,8 +276,8 @@ PostgreSQL documentation - - + + Sets the default text search configuration. diff --git a/doc/src/sgml/ref/pg_dump.sgml b/doc/src/sgml/ref/pg_dump.sgml index bb0bf5d566..bafa031e1a 100644 --- a/doc/src/sgml/ref/pg_dump.sgml +++ b/doc/src/sgml/ref/pg_dump.sgml @@ -816,6 +816,20 @@ PostgreSQL documentation + + + + + By default, pg_dump will wait for all files + to be written safely to disk. This option causes + pg_dump to return without waiting, which is + faster, but means that a subsequent operating system crash can leave + the dump corrupt. Generally, this option is useful for testing + but should not be used when dumping data from production installation. + + + + @@ -856,20 +870,6 @@ PostgreSQL documentation - - - - - By default, pg_dump will wait for all files - to be written safely to disk. This option causes - pg_dump to return without waiting, which is - faster, but means that a subsequent operating system crash can leave - the dump corrupt. Generally, this option is useful for testing - but should not be used when dumping data from production installation. - - - - diff --git a/doc/src/sgml/ref/psql-ref.sgml b/doc/src/sgml/ref/psql-ref.sgml index 3b86612862..e6eba21eda 100644 --- a/doc/src/sgml/ref/psql-ref.sgml +++ b/doc/src/sgml/ref/psql-ref.sgml @@ -1250,6 +1250,23 @@ testdb=> + + \dD[S+] [ pattern ] + + + Lists domains. If pattern + is specified, only domains whose names match the pattern are shown. + By default, only user-created objects are shown; supply a + pattern or the S modifier to include system + objects. + If + is appended to the command name, each object + is listed with its associated permissions and description. + + + + + \ddp [ pattern ] @@ -1272,23 +1289,6 @@ testdb=> - - \dD[S+] [ pattern ] - - - Lists domains. If pattern - is specified, only domains whose names match the pattern are shown. - By default, only user-created objects are shown; supply a - pattern or the S modifier to include system - objects. - If + is appended to the command name, each object - is listed with its associated permissions and description. - - - - - \dE[S+] [ pattern ] \di[S+] [ pattern ] @@ -1944,18 +1944,6 @@ Tue Oct 26 21:40:57 CEST 1999 - - \gx [ filename ] - \gx [ |command ] - - - \gx is equivalent to \g, but - forces expanded output mode for this query. See \x. - - - - - \gexec @@ -2046,6 +2034,19 @@ hello 10 + + + \gx [ filename ] + \gx [ |command ] + + + \gx is equivalent to \g, but + forces expanded output mode for this query. See \x. + + + + + \h or \help [ command ] @@ -2117,21 +2118,6 @@ hello 10 - - \ir or \include_relative filename - - - The \ir command is similar to \i, but resolves - relative file names differently. When executing in interactive mode, - the two commands behave identically. However, when invoked from a - script, \ir interprets file names relative to the - directory in which the script is located, rather than the current - working directory. - - - - - \if expression \elif expression @@ -2221,6 +2207,21 @@ SELECT + + \ir or \include_relative filename + + + The \ir command is similar to \i, but resolves + relative file names differently. When executing in interactive mode, + the two commands behave identically. However, when invoked from a + script, \ir interprets file names relative to the + directory in which the script is located, rather than the current + working directory. + + + + + \l[+] or \list[+] [ pattern ] diff --git a/src/bin/psql/help.c b/src/bin/psql/help.c index ac435220e6..f097b06594 100644 --- a/src/bin/psql/help.c +++ b/src/bin/psql/help.c @@ -171,13 +171,13 @@ slashUsage(unsigned short int pager) fprintf(output, _("General\n")); fprintf(output, _(" \\copyright show PostgreSQL usage and distribution terms\n")); + fprintf(output, _(" \\crosstabview [COLUMNS] execute query and display results in crosstab\n")); fprintf(output, _(" \\errverbose show most recent error message at maximum verbosity\n")); fprintf(output, _(" \\g [FILE] or ; execute query (and send results to file or |pipe)\n")); - fprintf(output, _(" \\gx [FILE] as \\g, but forces expanded output mode\n")); fprintf(output, _(" \\gexec execute query, then execute each value in its result\n")); fprintf(output, _(" \\gset [PREFIX] execute query and store results in psql variables\n")); + fprintf(output, _(" \\gx [FILE] as \\g, but forces expanded output mode\n")); fprintf(output, _(" \\q quit psql\n")); - fprintf(output, _(" \\crosstabview [COLUMNS] execute query and display results in crosstab\n")); fprintf(output, _(" \\watch [SEC] execute query every SEC seconds\n")); fprintf(output, "\n"); @@ -227,8 +227,9 @@ slashUsage(unsigned short int pager) fprintf(output, _(" \\dc[S+] [PATTERN] list conversions\n")); fprintf(output, _(" \\dC[+] [PATTERN] list casts\n")); fprintf(output, _(" \\dd[S] [PATTERN] show object descriptions not displayed elsewhere\n")); - fprintf(output, _(" \\ddp [PATTERN] list default privileges\n")); fprintf(output, _(" \\dD[S+] [PATTERN] list domains\n")); + fprintf(output, _(" \\ddp [PATTERN] list default privileges\n")); + fprintf(output, _(" \\dE[S+] [PATTERN] list foreign tables\n")); fprintf(output, _(" \\det[+] [PATTERN] list foreign tables\n")); fprintf(output, _(" \\des[+] [PATTERN] list foreign servers\n")); fprintf(output, _(" \\deu[+] [PATTERN] list user mappings\n")); @@ -255,7 +256,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")); @@ -289,9 +289,9 @@ slashUsage(unsigned short int pager) else fprintf(output, _(" \\c[onnect] {[DBNAME|- USER|- HOST|- PORT|-] | conninfo}\n" " connect to new database (currently no connection)\n")); + fprintf(output, _(" \\conninfo display information about current connection\n")); fprintf(output, _(" \\encoding [ENCODING] show or set client encoding\n")); fprintf(output, _(" \\password [USERNAME] securely change the password for a user\n")); - fprintf(output, _(" \\conninfo display information about current connection\n")); fprintf(output, "\n"); fprintf(output, _("Operating System\n")); @@ -413,10 +413,10 @@ helpVariables(unsigned short int pager) fprintf(output, _(" PGAPPNAME same as the application_name connection parameter\n")); fprintf(output, _(" PGDATABASE same as the dbname connection parameter\n")); fprintf(output, _(" PGHOST same as the host connection parameter\n")); - fprintf(output, _(" PGPORT same as the port connection parameter\n")); - fprintf(output, _(" PGUSER same as the user connection parameter\n")); fprintf(output, _(" PGPASSWORD connection password (not recommended)\n")); fprintf(output, _(" PGPASSFILE password file name\n")); + fprintf(output, _(" PGPORT same as the port connection parameter\n")); + fprintf(output, _(" PGUSER same as the user connection parameter\n")); fprintf(output, _(" PSQL_EDITOR, EDITOR, VISUAL\n" " editor used by the \\e, \\ef, and \\ev commands\n")); fprintf(output, _(" PSQL_EDITOR_LINENUMBER_ARG\n"