Skip to content

Commit 0d9bdbc

Browse files
peterepetere
committed
Put documentation of options and commands in more alphabetical order
1 parent 8e72239 commit 0d9bdbc

File tree

4 files changed

+68
-67
lines changed

4 files changed

+68
-67
lines changed

‎doc/src/sgml/ref/initdb.sgml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -276,8 +276,8 @@ PostgreSQL documentation
276276
</varlistentry>
277277

278278
<varlistentry>
279-
<term><option>-T <replaceable>CFG</></option></term>
280-
<term><option>--text-search-config=<replaceable>CFG</></option></term>
279+
<term><option>-T <replaceable>config</></option></term>
280+
<term><option>--text-search-config=<replaceable>config</></option></term>
281281
<listitem>
282282
<para>
283283
Sets the default text search configuration.

‎doc/src/sgml/ref/pg_dump.sgml‎

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -816,6 +816,20 @@ PostgreSQL documentation
816816
</listitem>
817817
</varlistentry>
818818

819+
<varlistentry>
820+
<term><option>--no-sync</option></term>
821+
<listitem>
822+
<para>
823+
By default, <command>pg_dump</command> will wait for all files
824+
to be written safely to disk. This option causes
825+
<command>pg_dump</command> to return without waiting, which is
826+
faster, but means that a subsequent operating system crash can leave
827+
the dump corrupt. Generally, this option is useful for testing
828+
but should not be used when dumping data from production installation.
829+
</para>
830+
</listitem>
831+
</varlistentry>
832+
819833
<varlistentry>
820834
<term><option>--no-synchronized-snapshots</></term>
821835
<listitem>
@@ -856,20 +870,6 @@ PostgreSQL documentation
856870
</listitem>
857871
</varlistentry>
858872

859-
<varlistentry>
860-
<term><option>--no-sync</option></term>
861-
<listitem>
862-
<para>
863-
By default, <command>pg_dump</command> will wait for all files
864-
to be written safely to disk. This option causes
865-
<command>pg_dump</command> to return without waiting, which is
866-
faster, but means that a subsequent operating system crash can leave
867-
the dump corrupt. Generally, this option is useful for testing
868-
but should not be used when dumping data from production installation.
869-
</para>
870-
</listitem>
871-
</varlistentry>
872-
873873
<varlistentry>
874874
<term><option>--quote-all-identifiers</></term>
875875
<listitem>

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

Lines changed: 45 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -1250,6 +1250,23 @@ testdb=&gt;
12501250
</varlistentry>
12511251

12521252

1253+
<varlistentry>
1254+
<term><literal>\dD[S+] [ <link linkend="APP-PSQL-patterns"><replaceable class="parameter">pattern</replaceable></link> ]</literal></term>
1255+
<listitem>
1256+
<para>
1257+
Lists domains. If <replaceable
1258+
class="parameter">pattern</replaceable>
1259+
is specified, only domains whose names match the pattern are shown.
1260+
By default, only user-created objects are shown; supply a
1261+
pattern or the <literal>S</literal> modifier to include system
1262+
objects.
1263+
If <literal>+</literal> is appended to the command name, each object
1264+
is listed with its associated permissions and description.
1265+
</para>
1266+
</listitem>
1267+
</varlistentry>
1268+
1269+
12531270
<varlistentry>
12541271
<term><literal>\ddp [ <link linkend="APP-PSQL-patterns"><replaceable class="parameter">pattern</replaceable></link> ]</literal></term>
12551272
<listitem>
@@ -1272,23 +1289,6 @@ testdb=&gt;
12721289
</varlistentry>
12731290

12741291

1275-
<varlistentry>
1276-
<term><literal>\dD[S+] [ <link linkend="APP-PSQL-patterns"><replaceable class="parameter">pattern</replaceable></link> ]</literal></term>
1277-
<listitem>
1278-
<para>
1279-
Lists domains. If <replaceable
1280-
class="parameter">pattern</replaceable>
1281-
is specified, only domains whose names match the pattern are shown.
1282-
By default, only user-created objects are shown; supply a
1283-
pattern or the <literal>S</literal> modifier to include system
1284-
objects.
1285-
If <literal>+</literal> is appended to the command name, each object
1286-
is listed with its associated permissions and description.
1287-
</para>
1288-
</listitem>
1289-
</varlistentry>
1290-
1291-
12921292
<varlistentry>
12931293
<term><literal>\dE[S+] [ <link linkend="APP-PSQL-patterns"><replaceable class="parameter">pattern</replaceable></link> ]</literal></term>
12941294
<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
19441944
</varlistentry>
19451945

19461946

1947-
<varlistentry>
1948-
<term><literal>\gx [ <replaceable class="parameter">filename</replaceable> ]</literal></term>
1949-
<term><literal>\gx [ |<replaceable class="parameter">command</replaceable> ]</literal></term>
1950-
<listitem>
1951-
<para>
1952-
<literal>\gx</literal> is equivalent to <literal>\g</literal>, but
1953-
forces expanded output mode for this query. See <literal>\x</literal>.
1954-
</para>
1955-
</listitem>
1956-
</varlistentry>
1957-
1958-
19591947
<varlistentry>
19601948
<term><literal>\gexec</literal></term>
19611949

@@ -2046,6 +2034,19 @@ hello 10
20462034
</listitem>
20472035
</varlistentry>
20482036

2037+
2038+
<varlistentry>
2039+
<term><literal>\gx [ <replaceable class="parameter">filename</replaceable> ]</literal></term>
2040+
<term><literal>\gx [ |<replaceable class="parameter">command</replaceable> ]</literal></term>
2041+
<listitem>
2042+
<para>
2043+
<literal>\gx</literal> is equivalent to <literal>\g</literal>, but
2044+
forces expanded output mode for this query. See <literal>\x</literal>.
2045+
</para>
2046+
</listitem>
2047+
</varlistentry>
2048+
2049+
20492050
<varlistentry>
20502051
<term><literal>\h</literal> or <literal>\help</literal> <literal>[ <replaceable class="parameter">command</replaceable> ]</literal></term>
20512052
<listitem>
@@ -2117,21 +2118,6 @@ hello 10
21172118
</varlistentry>
21182119

21192120

2120-
<varlistentry>
2121-
<term><literal>\ir</literal> or <literal>\include_relative</literal> <replaceable class="parameter">filename</replaceable></term>
2122-
<listitem>
2123-
<para>
2124-
The <literal>\ir</> command is similar to <literal>\i</>, but resolves
2125-
relative file names differently. When executing in interactive mode,
2126-
the two commands behave identically. However, when invoked from a
2127-
script, <literal>\ir</literal> interprets file names relative to the
2128-
directory in which the script is located, rather than the current
2129-
working directory.
2130-
</para>
2131-
</listitem>
2132-
</varlistentry>
2133-
2134-
21352121
<varlistentry>
21362122
<term><literal>\if</literal> <replaceable class="parameter">expression</replaceable></term>
21372123
<term><literal>\elif</literal> <replaceable class="parameter">expression</replaceable></term>
@@ -2221,6 +2207,21 @@ SELECT
22212207
</varlistentry>
22222208

22232209

2210+
<varlistentry>
2211+
<term><literal>\ir</literal> or <literal>\include_relative</literal> <replaceable class="parameter">filename</replaceable></term>
2212+
<listitem>
2213+
<para>
2214+
The <literal>\ir</> command is similar to <literal>\i</>, but resolves
2215+
relative file names differently. When executing in interactive mode,
2216+
the two commands behave identically. However, when invoked from a
2217+
script, <literal>\ir</literal> interprets file names relative to the
2218+
directory in which the script is located, rather than the current
2219+
working directory.
2220+
</para>
2221+
</listitem>
2222+
</varlistentry>
2223+
2224+
22242225
<varlistentry>
22252226
<term><literal>\l[+]</literal> or <literal>\list[+] [ <link linkend="APP-PSQL-patterns"><replaceable class="parameter">pattern</replaceable></link> ]</literal></term>
22262227
<listitem>

‎src/bin/psql/help.c‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -171,13 +171,13 @@ slashUsage(unsigned short int pager)
171171

172172
fprintf(output, _("General\n"));
173173
fprintf(output, _(" \\copyright show PostgreSQL usage and distribution terms\n"));
174+
fprintf(output, _(" \\crosstabview [COLUMNS] execute query and display results in crosstab\n"));
174175
fprintf(output, _(" \\errverbose show most recent error message at maximum verbosity\n"));
175176
fprintf(output, _(" \\g [FILE] or ; execute query (and send results to file or |pipe)\n"));
176-
fprintf(output, _(" \\gx [FILE] as \\g, but forces expanded output mode\n"));
177177
fprintf(output, _(" \\gexec execute query, then execute each value in its result\n"));
178178
fprintf(output, _(" \\gset [PREFIX] execute query and store results in psql variables\n"));
179+
fprintf(output, _(" \\gx [FILE] as \\g, but forces expanded output mode\n"));
179180
fprintf(output, _(" \\q quit psql\n"));
180-
fprintf(output, _(" \\crosstabview [COLUMNS] execute query and display results in crosstab\n"));
181181
fprintf(output, _(" \\watch [SEC] execute query every SEC seconds\n"));
182182
fprintf(output, "\n");
183183

@@ -227,8 +227,9 @@ slashUsage(unsigned short int pager)
227227
fprintf(output, _(" \\dc[S+] [PATTERN] list conversions\n"));
228228
fprintf(output, _(" \\dC[+] [PATTERN] list casts\n"));
229229
fprintf(output, _(" \\dd[S] [PATTERN] show object descriptions not displayed elsewhere\n"));
230-
fprintf(output, _(" \\ddp [PATTERN] list default privileges\n"));
231230
fprintf(output, _(" \\dD[S+] [PATTERN] list domains\n"));
231+
fprintf(output, _(" \\ddp [PATTERN] list default privileges\n"));
232+
fprintf(output, _(" \\dE[S+] [PATTERN] list foreign tables\n"));
232233
fprintf(output, _(" \\det[+] [PATTERN] list foreign tables\n"));
233234
fprintf(output, _(" \\des[+] [PATTERN] list foreign servers\n"));
234235
fprintf(output, _(" \\deu[+] [PATTERN] list user mappings\n"));
@@ -255,7 +256,6 @@ slashUsage(unsigned short int pager)
255256
fprintf(output, _(" \\dT[S+] [PATTERN] list data types\n"));
256257
fprintf(output, _(" \\du[S+] [PATTERN] list roles\n"));
257258
fprintf(output, _(" \\dv[S+] [PATTERN] list views\n"));
258-
fprintf(output, _(" \\dE[S+] [PATTERN] list foreign tables\n"));
259259
fprintf(output, _(" \\dx[+] [PATTERN] list extensions\n"));
260260
fprintf(output, _(" \\dy [PATTERN] list event triggers\n"));
261261
fprintf(output, _(" \\l[+] [PATTERN] list databases\n"));
@@ -289,9 +289,9 @@ slashUsage(unsigned short int pager)
289289
else
290290
fprintf(output, _(" \\c[onnect] {[DBNAME|- USER|- HOST|- PORT|-] | conninfo}\n"
291291
" connect to new database (currently no connection)\n"));
292+
fprintf(output, _(" \\conninfo display information about current connection\n"));
292293
fprintf(output, _(" \\encoding [ENCODING] show or set client encoding\n"));
293294
fprintf(output, _(" \\password [USERNAME] securely change the password for a user\n"));
294-
fprintf(output, _(" \\conninfo display information about current connection\n"));
295295
fprintf(output, "\n");
296296

297297
fprintf(output, _("Operating System\n"));
@@ -413,10 +413,10 @@ helpVariables(unsigned short int pager)
413413
fprintf(output, _(" PGAPPNAME same as the application_name connection parameter\n"));
414414
fprintf(output, _(" PGDATABASE same as the dbname connection parameter\n"));
415415
fprintf(output, _(" PGHOST same as the host connection parameter\n"));
416-
fprintf(output, _(" PGPORT same as the port connection parameter\n"));
417-
fprintf(output, _(" PGUSER same as the user connection parameter\n"));
418416
fprintf(output, _(" PGPASSWORD connection password (not recommended)\n"));
419417
fprintf(output, _(" PGPASSFILE password file name\n"));
418+
fprintf(output, _(" PGPORT same as the port connection parameter\n"));
419+
fprintf(output, _(" PGUSER same as the user connection parameter\n"));
420420
fprintf(output, _(" PSQL_EDITOR, EDITOR, VISUAL\n"
421421
" editor used by the \\e, \\ef, and \\ev commands\n"));
422422
fprintf(output, _(" PSQL_EDITOR_LINENUMBER_ARG\n"

0 commit comments

Comments
 (0)