]> granicus.if.org Git - postgresql/commitdiff
Put documentation of options and commands in more alphabetical order
authorPeter Eisentraut <peter_e@gmx.net>
Wed, 14 Jun 2017 15:09:33 +0000 (11:09 -0400)
committerPeter Eisentraut <peter_e@gmx.net>
Wed, 14 Jun 2017 15:10:17 +0000 (11:10 -0400)
doc/src/sgml/ref/initdb.sgml
doc/src/sgml/ref/pg_dump.sgml
doc/src/sgml/ref/psql-ref.sgml
src/bin/psql/help.c

index 3ce99e248b4d573f0b7c861ca5b0f0aa8753906a..6efb2e442d59c954c8a80149617c896c2933d2fb 100644 (file)
@@ -276,8 +276,8 @@ PostgreSQL documentation
      </varlistentry>
 
      <varlistentry>
-      <term><option>-T <replaceable>CFG</></option></term>
-      <term><option>--text-search-config=<replaceable>CFG</></option></term>
+      <term><option>-T <replaceable>config</></option></term>
+      <term><option>--text-search-config=<replaceable>config</></option></term>
       <listitem>
        <para>
         Sets the default text search configuration.
index bb0bf5d5662159dd8c694ec21e990bf35c00561d..bafa031e1a8ec4b674260c03da3b5b74663a911e 100644 (file)
@@ -816,6 +816,20 @@ PostgreSQL documentation
       </listitem>
      </varlistentry>
 
+     <varlistentry>
+      <term><option>--no-sync</option></term>
+      <listitem>
+       <para>
+        By default, <command>pg_dump</command> will wait for all files
+        to be written safely to disk.  This option causes
+        <command>pg_dump</command> 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.
+       </para>
+      </listitem>
+     </varlistentry>
+
      <varlistentry>
       <term><option>--no-synchronized-snapshots</></term>
       <listitem>
@@ -856,20 +870,6 @@ PostgreSQL documentation
       </listitem>
      </varlistentry>
 
-     <varlistentry>
-      <term><option>--no-sync</option></term>
-      <listitem>
-       <para>
-        By default, <command>pg_dump</command> will wait for all files
-        to be written safely to disk.  This option causes
-        <command>pg_dump</command> 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.
-       </para>
-      </listitem>
-     </varlistentry>
-
      <varlistentry>
       <term><option>--quote-all-identifiers</></term>
       <listitem>
index 3b866128623531981f3a07c550a0555ecd0d590f..e6eba21edabf5a46af2c3a9b15de3269dc768ccd 100644 (file)
@@ -1250,6 +1250,23 @@ testdb=&gt;
       </varlistentry>
 
 
+      <varlistentry>
+        <term><literal>\dD[S+] [ <link linkend="APP-PSQL-patterns"><replaceable class="parameter">pattern</replaceable></link> ]</literal></term>
+        <listitem>
+        <para>
+        Lists domains. If <replaceable
+        class="parameter">pattern</replaceable>
+        is specified, only domains whose names match the pattern are shown.
+        By default, only user-created objects are shown;  supply a
+        pattern or the <literal>S</literal> modifier to include system
+        objects.
+        If <literal>+</literal> is appended to the command name, each object
+        is listed with its associated permissions and description.
+        </para>
+        </listitem>
+      </varlistentry>
+
+
       <varlistentry>
         <term><literal>\ddp [ <link linkend="APP-PSQL-patterns"><replaceable class="parameter">pattern</replaceable></link> ]</literal></term>
         <listitem>
@@ -1272,23 +1289,6 @@ testdb=&gt;
       </varlistentry>
 
 
-      <varlistentry>
-        <term><literal>\dD[S+] [ <link linkend="APP-PSQL-patterns"><replaceable class="parameter">pattern</replaceable></link> ]</literal></term>
-        <listitem>
-        <para>
-        Lists domains. If <replaceable
-        class="parameter">pattern</replaceable>
-        is specified, only domains whose names match the pattern are shown.
-        By default, only user-created objects are shown;  supply a
-        pattern or the <literal>S</literal> modifier to include system
-        objects.
-        If <literal>+</literal> is appended to the command name, each object
-        is listed with its associated permissions and description.
-        </para>
-        </listitem>
-      </varlistentry>
-
-
       <varlistentry>
         <term><literal>\dE[S+] [ <link linkend="APP-PSQL-patterns"><replaceable class="parameter">pattern</replaceable></link> ]</literal></term>
         <term><literal>\di[S+] [ <link linkend="APP-PSQL-patterns"><replaceable class="parameter">pattern</replaceable></link> ]</literal></term>
@@ -1944,18 +1944,6 @@ Tue Oct 26 21:40:57 CEST 1999
       </varlistentry>
 
 
-      <varlistentry>
-        <term><literal>\gx [ <replaceable class="parameter">filename</replaceable> ]</literal></term>
-        <term><literal>\gx [ |<replaceable class="parameter">command</replaceable> ]</literal></term>
-        <listitem>
-        <para>
-        <literal>\gx</literal> is equivalent to <literal>\g</literal>, but
-        forces expanded output mode for this query.  See <literal>\x</literal>.
-        </para>
-        </listitem>
-      </varlistentry>
-
-
       <varlistentry>
         <term><literal>\gexec</literal></term>
 
@@ -2046,6 +2034,19 @@ hello 10
         </listitem>
       </varlistentry>
 
+
+      <varlistentry>
+        <term><literal>\gx [ <replaceable class="parameter">filename</replaceable> ]</literal></term>
+        <term><literal>\gx [ |<replaceable class="parameter">command</replaceable> ]</literal></term>
+        <listitem>
+        <para>
+        <literal>\gx</literal> is equivalent to <literal>\g</literal>, but
+        forces expanded output mode for this query.  See <literal>\x</literal>.
+        </para>
+        </listitem>
+      </varlistentry>
+
+
       <varlistentry>
         <term><literal>\h</literal> or <literal>\help</literal> <literal>[ <replaceable class="parameter">command</replaceable> ]</literal></term>
         <listitem>
@@ -2117,21 +2118,6 @@ hello 10
       </varlistentry>
 
 
-      <varlistentry>
-        <term><literal>\ir</literal> or <literal>\include_relative</literal> <replaceable class="parameter">filename</replaceable></term>
-        <listitem>
-        <para>
-        The <literal>\ir</> command is similar to <literal>\i</>, but resolves
-        relative file names differently.  When executing in interactive mode,
-        the two commands behave identically.  However, when invoked from a
-        script, <literal>\ir</literal> interprets file names relative to the
-        directory in which the script is located, rather than the current
-        working directory.
-        </para>
-        </listitem>
-      </varlistentry>
-
-
       <varlistentry>
         <term><literal>\if</literal> <replaceable class="parameter">expression</replaceable></term>
         <term><literal>\elif</literal> <replaceable class="parameter">expression</replaceable></term>
@@ -2221,6 +2207,21 @@ SELECT
       </varlistentry>
 
 
+      <varlistentry>
+        <term><literal>\ir</literal> or <literal>\include_relative</literal> <replaceable class="parameter">filename</replaceable></term>
+        <listitem>
+        <para>
+        The <literal>\ir</> command is similar to <literal>\i</>, but resolves
+        relative file names differently.  When executing in interactive mode,
+        the two commands behave identically.  However, when invoked from a
+        script, <literal>\ir</literal> interprets file names relative to the
+        directory in which the script is located, rather than the current
+        working directory.
+        </para>
+        </listitem>
+      </varlistentry>
+
+
       <varlistentry>
         <term><literal>\l[+]</literal> or <literal>\list[+] [ <link linkend="APP-PSQL-patterns"><replaceable class="parameter">pattern</replaceable></link> ]</literal></term>
         <listitem>
index ac435220e62d3e3a590aab753780810ebc1d167c..f097b06594a707aadf2d5a3ceb97ffc4580377f9 100644 (file)
@@ -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"