database/postgres
1
0
Fork 0
mirror of https://github.com/postgres/postgres.git synced 2025-07-28 23:42:10 +03:00
Code Activity

doc: Move options on man pages into more alphabetical order

Browse Source
This commit is contained in:
Peter Eisentraut
2020-06-07 14:07:33 +02:00
parent 9ac0a26210
commit b25da86615
5 changed files with 117 additions and 118 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
doc/src/sgml/ref/dropdb.sgml
View File

@ -76,16 +76,6 @@ PostgreSQL documentation
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry>
<term><option>-i</option></term>
<term><option>--interactive</option></term>
<listitem>
<para>
Issues a verification prompt before doing anything destructive.
</para>
</listitem>
</varlistentry>
<varlistentry> <varlistentry>
<term><option>-f</option></term> <term><option>-f</option></term>
<term><option>--force</option></term> <term><option>--force</option></term>
@ -98,6 +88,16 @@ PostgreSQL documentation
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry>
<term><option>-i</option></term>
<term><option>--interactive</option></term>
<listitem>
<para>
Issues a verification prompt before doing anything destructive.
</para>
</listitem>
</varlistentry>
<varlistentry> <varlistentry>
<term><option>-V</option></term> <term><option>-V</option></term>
<term><option>--version</option></term> <term><option>--version</option></term>

108
doc/src/sgml/ref/pg_basebackup.sgml
View File

@ -500,39 +500,51 @@ PostgreSQL documentation
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>--no-slot</option></term> <term><option>--manifest-checksums=<replaceable class="parameter">algorithm</replaceable></option></term>
<listitem> <listitem>
<para> <para>
This option prevents the creation of a temporary replication slot Specifies the checksum algorithm that should be applied to each file
during the backup even if it's supported by the server. included in the backup manifest. Currently, the available
algorithms are <literal>NONE</literal>, <literal>CRC32C</literal>,
<literal>SHA224</literal>, <literal>SHA256</literal>,
<literal>SHA384</literal>, and <literal>SHA512</literal>.
The default is <literal>CRC32C</literal>.
</para> </para>
<para> <para>
Temporary replication slots are created by default if no slot name If <literal>NONE</literal> is selected, the backup manifest will
is given with the option <option>-S</option> when using log streaming. not contain any checksums. Otherwise, it will contain a checksum
of each file in the backup using the specified algorithm. In addition,
the manifest will always contain a <literal>SHA256</literal>
checksum of its own contents. The <literal>SHA</literal> algorithms
are significantly more CPU-intensive than <literal>CRC32C</literal>,
so selecting one of them may increase the time required to complete
the backup.
</para> </para>
<para> <para>
The main purpose of this option is to allow taking a base backup when Using a SHA hash function provides a cryptographically secure digest
the server is out of free replication slots. Using replication slots of each file for users who wish to verify that the backup has not been
is almost always preferred, because it prevents needed WAL from being tampered with, while the CRC32C algorithm provides a checksum which is
removed by the server during the backup. much faster to calculate and good at catching errors due to accidental
changes but is not resistant to targeted modifications. Note that, to
be useful against an adversary who has access to the backup, the backup
manifest would need to be stored securely elsewhere or otherwise
verified not to have been modified since the backup was taken.
</para>
<para>
<xref linkend="app-pgverifybackup" /> can be used to check the
integrity of a backup against the backup manifest.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>--no-verify-checksums</option></term> <term><option>--manifest-force-encode</option></term>
<listitem> <listitem>
<para> <para>
Disables verification of checksums, if they are enabled on the server Forces all filenames in the backup manifest to be hex-encoded.
the base backup is taken from. If this option is not specified, only non-UTF8 filenames are
</para> hex-encoded. This option is mostly intended to test that tools which
<para> read a backup manifest file properly handle this case.
By default, checksums are verified and checksum failures will result
in a non-zero exit status. However, the base backup will not be
removed in such a case, as if the <option>--no-clean</option> option
had been used. Checksum verifications failures will also be reported
in the <link linkend="monitoring-pg-stat-database-view">
<structname>pg_stat_database</structname></link> view.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
@ -576,51 +588,39 @@ PostgreSQL documentation
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>--manifest-force-encode</option></term> <term><option>--no-slot</option></term>
<listitem> <listitem>
<para> <para>
Forces all filenames in the backup manifest to be hex-encoded. This option prevents the creation of a temporary replication slot
If this option is not specified, only non-UTF8 filenames are during the backup even if it's supported by the server.
hex-encoded. This option is mostly intended to test that tools which </para>
read a backup manifest file properly handle this case. <para>
Temporary replication slots are created by default if no slot name
is given with the option <option>-S</option> when using log streaming.
</para>
<para>
The main purpose of this option is to allow taking a base backup when
the server is out of free replication slots. Using replication slots
is almost always preferred, because it prevents needed WAL from being
removed by the server during the backup.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>--manifest-checksums=<replaceable class="parameter">algorithm</replaceable></option></term> <term><option>--no-verify-checksums</option></term>
<listitem> <listitem>
<para> <para>
Specifies the checksum algorithm that should be applied to each file Disables verification of checksums, if they are enabled on the server
included in the backup manifest. Currently, the available the base backup is taken from.
algorithms are <literal>NONE</literal>, <literal>CRC32C</literal>,
<literal>SHA224</literal>, <literal>SHA256</literal>,
<literal>SHA384</literal>, and <literal>SHA512</literal>.
The default is <literal>CRC32C</literal>.
</para> </para>
<para> <para>
If <literal>NONE</literal> is selected, the backup manifest will By default, checksums are verified and checksum failures will result
not contain any checksums. Otherwise, it will contain a checksum in a non-zero exit status. However, the base backup will not be
of each file in the backup using the specified algorithm. In addition, removed in such a case, as if the <option>--no-clean</option> option
the manifest will always contain a <literal>SHA256</literal> had been used. Checksum verifications failures will also be reported
checksum of its own contents. The <literal>SHA</literal> algorithms in the <link linkend="monitoring-pg-stat-database-view">
are significantly more CPU-intensive than <literal>CRC32C</literal>, <structname>pg_stat_database</structname></link> view.
so selecting one of them may increase the time required to complete
the backup.
</para>
<para>
Using a SHA hash function provides a cryptographically secure digest
of each file for users who wish to verify that the backup has not been
tampered with, while the CRC32C algorithm provides a checksum which is
much faster to calculate and good at catching errors due to accidental
changes but is not resistant to targeted modifications. Note that, to
be useful against an adversary who has access to the backup, the backup
manifest would need to be stored securely elsewhere or otherwise
verified not to have been modified since the backup was taken.
</para>
<para>
<xref linkend="app-pgverifybackup" /> can be used to check the
integrity of a backup against the backup manifest.
</para> </para>
</listitem> </listitem>
</varlistentry> </varlistentry>

23
doc/src/sgml/ref/pg_dumpall.sgml
View File

@ -287,18 +287,6 @@ PostgreSQL documentation
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry>
<term><option>--extra-float-digits=<replaceable class="parameter">ndigits</replaceable></option></term>
<listitem>
<para>
Use the specified value of extra_float_digits when dumping
floating-point data, instead of the maximum available precision.
Routine dumps made for backup purposes should not use this option.
</para>
</listitem>
</varlistentry>
<varlistentry> <varlistentry>
<term><option>--exclude-database=<replaceable class="parameter">pattern</replaceable></option></term> <term><option>--exclude-database=<replaceable class="parameter">pattern</replaceable></option></term>
<listitem> <listitem>
@ -318,6 +306,17 @@ PostgreSQL documentation
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry>
<term><option>--extra-float-digits=<replaceable class="parameter">ndigits</replaceable></option></term>
<listitem>
<para>
Use the specified value of extra_float_digits when dumping
floating-point data, instead of the maximum available precision.
Routine dumps made for backup purposes should not use this option.
</para>
</listitem>
</varlistentry>
<varlistentry> <varlistentry>
<term><option>--if-exists</option></term> <term><option>--if-exists</option></term>
<listitem> <listitem>

34
doc/src/sgml/ref/pg_rewind.sgml
View File

@ -178,23 +178,6 @@ PostgreSQL documentation
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry>
<term><option>--no-ensure-shutdown</option></term>
<listitem>
<para>
<application>pg_rewind</application> requires that the target server
is cleanly shut down before rewinding. By default, if the target server
is not shut down cleanly, <application>pg_rewind</application> starts
the target server in single-user mode to complete crash recovery first,
and stops it.
By passing this option, <application>pg_rewind</application> skips
this and errors out immediately if the server is not cleanly shut
down. Users are expected to handle the situation themselves in that
case.
</para>
</listitem>
</varlistentry>
<varlistentry> <varlistentry>
<term><option>-R</option></term> <term><option>-R</option></term>
<term><option>--write-recovery-conf</option></term> <term><option>--write-recovery-conf</option></term>
@ -268,6 +251,23 @@ PostgreSQL documentation
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry>
<term><option>--no-ensure-shutdown</option></term>
<listitem>
<para>
<application>pg_rewind</application> requires that the target server
is cleanly shut down before rewinding. By default, if the target server
is not shut down cleanly, <application>pg_rewind</application> starts
the target server in single-user mode to complete crash recovery first,
and stops it.
By passing this option, <application>pg_rewind</application> skips
this and errors out immediately if the server is not cleanly shut
down. Users are expected to handle the situation themselves in that
case.
</para>
</listitem>
</varlistentry>
<varlistentry> <varlistentry>
<term><option>-V</option></term> <term><option>-V</option></term>
<term><option>--version</option></term> <term><option>--version</option></term>

50
doc/src/sgml/ref/pgbench.sgml
View File

@ -335,18 +335,6 @@ pgbench <optional> <replaceable>options</replaceable> </optional> <replaceable>d
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry>
<term><option>--partitions=<replaceable>NUM</replaceable></option></term>
<listitem>
<para>
Create a partitioned <literal>pgbench_accounts</literal> table with
<replaceable>NUM</replaceable> partitions of nearly equal size for
the scaled number of accounts.
Default is <literal>0</literal>, meaning no partitioning.
</para>
</listitem>
</varlistentry>
<varlistentry> <varlistentry>
<term><option>--partition-method=<replaceable>NAME</replaceable></option></term> <term><option>--partition-method=<replaceable>NAME</replaceable></option></term>
<listitem> <listitem>
@ -360,6 +348,18 @@ pgbench <optional> <replaceable>options</replaceable> </optional> <replaceable>d
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry>
<term><option>--partitions=<replaceable>NUM</replaceable></option></term>
<listitem>
<para>
Create a partitioned <literal>pgbench_accounts</literal> table with
<replaceable>NUM</replaceable> partitions of nearly equal size for
the scaled number of accounts.
Default is <literal>0</literal>, meaning no partitioning.
</para>
</listitem>
</varlistentry>
<varlistentry> <varlistentry>
<term><option>--tablespace=<replaceable>tablespace</replaceable></option></term> <term><option>--tablespace=<replaceable>tablespace</replaceable></option></term>
<listitem> <listitem>
@ -670,16 +670,6 @@ pgbench <optional> <replaceable>options</replaceable> </optional> <replaceable>d
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry>
<term><option>--show-script</option><replaceable>scriptname</replaceable></term>
<listitem>
<para>
Show the actual code of builtin script <replaceable>scriptname</replaceable>
on stderr, and exit immediately.
</para>
</listitem>
</varlistentry>
<varlistentry> <varlistentry>
<term><option>-t</option> <replaceable>transactions</replaceable></term> <term><option>-t</option> <replaceable>transactions</replaceable></term>
<term><option>--transactions=</option><replaceable>transactions</replaceable></term> <term><option>--transactions=</option><replaceable>transactions</replaceable></term>
@ -750,13 +740,13 @@ pgbench <optional> <replaceable>options</replaceable> </optional> <replaceable>d
</varlistentry> </varlistentry>
<varlistentry> <varlistentry>
<term><option>--random-seed=</option><replaceable>SEED</replaceable></term> <term><option>--random-seed=</option><replaceable>seed</replaceable></term>
<listitem> <listitem>
<para> <para>
Set random generator seed. Seeds the system random number generator, Set random generator seed. Seeds the system random number generator,
which then produces a sequence of initial generator states, one for which then produces a sequence of initial generator states, one for
each thread. each thread.
Values for <replaceable>SEED</replaceable> may be: Values for <replaceable>seed</replaceable> may be:
<literal>time</literal> (the default, the seed is based on the current time), <literal>time</literal> (the default, the seed is based on the current time),
<literal>rand</literal> (use a strong random source, failing if none <literal>rand</literal> (use a strong random source, failing if none
is available), or an unsigned decimal integer value. is available), or an unsigned decimal integer value.
@ -764,7 +754,7 @@ pgbench <optional> <replaceable>options</replaceable> </optional> <replaceable>d
(<literal>random...</literal> functions) or implicitly (for instance option (<literal>random...</literal> functions) or implicitly (for instance option
<option>--rate</option> uses it to schedule transactions). <option>--rate</option> uses it to schedule transactions).
When explicitly set, the value used for seeding is shown on the terminal. When explicitly set, the value used for seeding is shown on the terminal.
Any value allowed for <replaceable>SEED</replaceable> may also be Any value allowed for <replaceable>seed</replaceable> may also be
provided through the environment variable provided through the environment variable
<literal>PGBENCH_RANDOM_SEED</literal>. <literal>PGBENCH_RANDOM_SEED</literal>.
To ensure that the provided seed impacts all possible uses, put this option To ensure that the provided seed impacts all possible uses, put this option
@ -804,6 +794,16 @@ pgbench <optional> <replaceable>options</replaceable> </optional> <replaceable>d
</listitem> </listitem>
</varlistentry> </varlistentry>
<varlistentry>
<term><option>--show-script=</option><replaceable>scriptname</replaceable></term>
<listitem>
<para>
Show the actual code of builtin script <replaceable>scriptname</replaceable>
on stderr, and exit immediately.
</para>
</listitem>
</varlistentry>
</variablelist> </variablelist>
</para> </para>