Skip to content

Commit c709c60

Browse files
committed
doc: Consistently use = sign in long options synopses
This was already the predominant form in man pages and help output.
1 parent 0be2245 commit c709c60

File tree

5 files changed

+7
-7
lines changed

5 files changed

+7
-7
lines changed

doc/src/sgml/ref/clusterdb.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -316,7 +316,7 @@ PostgreSQL documentation
316316
<literal>foo</literal> in a database named
317317
<literal>xyzzy</literal>:
318318
<screen>
319-
<prompt>$ </prompt><userinput>clusterdb --table foo xyzzy</userinput>
319+
<prompt>$ </prompt><userinput>clusterdb --table=foo xyzzy</userinput>
320320
</screen></para>
321321

322322
</refsect1>

doc/src/sgml/ref/pg_ctl-ref.sgml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -263,7 +263,7 @@ PostgreSQL documentation
263263

264264
<varlistentry>
265265
<term><option>-D <replaceable class="parameter">datadir</replaceable></option></term>
266-
<term><option>--pgdata <replaceable class="parameter">datadir</replaceable></option></term>
266+
<term><option>--pgdata=<replaceable class="parameter">datadir</replaceable></option></term>
267267
<listitem>
268268
<para>
269269
Specifies the file system location of the database configuration files. If
@@ -275,7 +275,7 @@ PostgreSQL documentation
275275

276276
<varlistentry>
277277
<term><option>-l <replaceable class="parameter">filename</replaceable></option></term>
278-
<term><option>--log <replaceable class="parameter">filename</replaceable></option></term>
278+
<term><option>--log=<replaceable class="parameter">filename</replaceable></option></term>
279279
<listitem>
280280
<para>
281281
Append the server log output to
@@ -288,7 +288,7 @@ PostgreSQL documentation
288288

289289
<varlistentry>
290290
<term><option>-m <replaceable class="parameter">mode</replaceable></option></term>
291-
<term><option>--mode <replaceable class="parameter">mode</replaceable></option></term>
291+
<term><option>--mode=<replaceable class="parameter">mode</replaceable></option></term>
292292
<listitem>
293293
<para>
294294
Specifies the shutdown mode. <replaceable>mode</replaceable>

doc/src/sgml/ref/pgupgrade.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -558,7 +558,7 @@ rsync --archive --delete --hard-links --size-only old_pgdata new_pgdata remote_d
558558
run using:
559559

560560
<programlisting>
561-
psql --username postgres --file script.sql postgres
561+
psql --username=postgres --file=script.sql postgres
562562
</programlisting>
563563

564564
The scripts can be run in any order and can be deleted once they have

doc/src/sgml/ref/reindexdb.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -396,7 +396,7 @@ PostgreSQL documentation
396396
To reindex the table <literal>foo</literal> and the index
397397
<literal>bar</literal> in a database named <literal>abcd</literal>:
398398
<screen>
399-
<prompt>$ </prompt><userinput>reindexdb --table foo --index bar abcd</userinput>
399+
<prompt>$ </prompt><userinput>reindexdb --table=foo --index=bar abcd</userinput>
400400
</screen></para>
401401

402402
</refsect1>

doc/src/sgml/ref/vacuumdb.sgml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -430,7 +430,7 @@ PostgreSQL documentation
430430
<literal>xyzzy</literal>, and analyze a single column
431431
<literal>bar</literal> of the table for the optimizer:
432432
<screen>
433-
<prompt>$ </prompt><userinput>vacuumdb --analyze --verbose --table 'foo(bar)' xyzzy</userinput>
433+
<prompt>$ </prompt><userinput>vacuumdb --analyze --verbose --table='foo(bar)' xyzzy</userinput>
434434
</screen></para>
435435

436436
</refsect1>

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy