NotificationsYou must be signed in to change notification settings
Fork4.9k
Star17.7k

Commitb25da86

committed

doc: Move options on man pages into more alphabetical order

1 parent9ac0a26 commitb25da86Copy full SHA for b25da86

File tree

5 files changed

+112

-113

lines changed

doc/src/sgml/ref

5 files changed

+112

-113

lines changed

`‎doc/src/sgml/ref/dropdb.sgml`

Lines changed: 8 additions & 8 deletions

Original file line number	Diff line number	Diff line change
`@@ -77,23 +77,23 @@ PostgreSQL documentation`
`77`	`77`	`</varlistentry>`
`78`	`78`
`79`	`79`	`<varlistentry>`
`80`		`- <term><option>-i</option></term>`
`81`		`- <term><option>--interactive</option></term>`
	`80`	`+ <term><option>-f</option></term>`
	`81`	`+ <term><option>--force</option></term>`
`82`	`82`	`<listitem>`
`83`	`83`	`<para>`
`84`		`- Issues a verification prompt before doing anything destructive.`
	`84`	`+ Attempt to terminate all existing connections to the target database`
	`85`	`+ before dropping it. See <xref linkend="sql-dropdatabase"/> for more`
	`86`	`+ information on this option.`
`85`	`87`	`</para>`
`86`	`88`	`</listitem>`
`87`	`89`	`</varlistentry>`
`88`	`90`
`89`	`91`	`<varlistentry>`
`90`		`- <term><option>-f</option></term>`
`91`		`- <term><option>--force</option></term>`
	`92`	`+ <term><option>-i</option></term>`
	`93`	`+ <term><option>--interactive</option></term>`
`92`	`94`	`<listitem>`
`93`	`95`	`<para>`
`94`		`- Attempt to terminate all existing connections to the target database`
`95`		`- before dropping it. See <xref linkend="sql-dropdatabase"/> for more`
`96`		`- information on this option.`
	`96`	`+ Issues a verification prompt before doing anything destructive.`
`97`	`97`	`</para>`
`98`	`98`	`</listitem>`
`99`	`99`	`</varlistentry>`

`‎doc/src/sgml/ref/pg_basebackup.sgml`

Lines changed: 54 additions & 54 deletions

Original file line number	Diff line number	Diff line change
`@@ -500,39 +500,51 @@ PostgreSQL documentation`
`500`	`500`	`</varlistentry>`
`501`	`501`
`502`	`502`	`<varlistentry>`
`503`		`- <term><option>--no-slot</option></term>`
	`503`	`+ <term><option>--manifest-checksums=<replaceable class="parameter">algorithm</replaceable></option></term>`
`504`	`504`	`<listitem>`
`505`	`505`	`<para>`
`506`		`- This option prevents the creation of a temporary replication slot`
`507`		`- during the backup even if it's supported by the server.`
	`506`	`+ Specifies the checksum algorithm that should be applied to each file`
	`507`	`+ included in the backup manifest. Currently, the available`
	`508`	`+ algorithms are <literal>NONE</literal>, <literal>CRC32C</literal>,`
	`509`	`+ <literal>SHA224</literal>, <literal>SHA256</literal>,`
	`510`	`+ <literal>SHA384</literal>, and <literal>SHA512</literal>.`
	`511`	`+ The default is <literal>CRC32C</literal>.`
`508`	`512`	`</para>`
`509`	`513`	`<para>`
`510`		`- Temporary replication slots are created by default if no slot name`
`511`		`- is given with the option <option>-S</option> when using log streaming.`
	`514`	`+ If <literal>NONE</literal> is selected, the backup manifest will`
	`515`	`+ not contain any checksums. Otherwise, it will contain a checksum`
	`516`	`+ of each file in the backup using the specified algorithm. In addition,`
	`517`	`+ the manifest will always contain a <literal>SHA256</literal>`
	`518`	`+ checksum of its own contents. The <literal>SHA</literal> algorithms`
	`519`	`+ are significantly more CPU-intensive than <literal>CRC32C</literal>,`
	`520`	`+ so selecting one of them may increase the time required to complete`
	`521`	`+ the backup.`
`512`	`522`	`</para>`
`513`	`523`	`<para>`
`514`		`- The main purpose of this option is to allow taking a base backup when`
`515`		`- the server is out of free replication slots. Using replication slots`
`516`		`- is almost always preferred, because it prevents needed WAL from being`
`517`		`- removed by the server during the backup.`
	`524`	`+ Using a SHA hash function provides a cryptographically secure digest`
	`525`	`+ of each file for users who wish to verify that the backup has not been`
	`526`	`+ tampered with, while the CRC32C algorithm provides a checksum which is`
	`527`	`+ much faster to calculate and good at catching errors due to accidental`
	`528`	`+ changes but is not resistant to targeted modifications. Note that, to`
	`529`	`+ be useful against an adversary who has access to the backup, the backup`
	`530`	`+ manifest would need to be stored securely elsewhere or otherwise`
	`531`	`+ verified not to have been modified since the backup was taken.`
	`532`	`+ </para>`
	`533`	`+ <para>`
	`534`	`+ <xref linkend="app-pgverifybackup" /> can be used to check the`
	`535`	`+ integrity of a backup against the backup manifest.`
`518`	`536`	`</para>`
`519`	`537`	`</listitem>`
`520`	`538`	`</varlistentry>`
`521`	`539`
`522`	`540`	`<varlistentry>`
`523`		`- <term><option>--no-verify-checksums</option></term>`
	`541`	`+ <term><option>--manifest-force-encode</option></term>`
`524`	`542`	`<listitem>`
`525`	`543`	`<para>`
`526`		`- Disables verification of checksums, if they are enabled on the server`
`527`		`- the base backup is taken from.`
`528`		`- </para>`
`529`		`- <para>`
`530`		`- By default, checksums are verified and checksum failures will result`
`531`		`- in a non-zero exit status. However, the base backup will not be`
`532`		`- removed in such a case, as if the <option>--no-clean</option> option`
`533`		`- had been used. Checksum verifications failures will also be reported`
`534`		`- in the <link linkend="monitoring-pg-stat-database-view">`
`535`		`- <structname>pg_stat_database</structname></link> view.`
	`544`	`+ Forces all filenames in the backup manifest to be hex-encoded.`
	`545`	`+ If this option is not specified, only non-UTF8 filenames are`
	`546`	`+ hex-encoded. This option is mostly intended to test that tools which`
	`547`	`+ read a backup manifest file properly handle this case.`
`536`	`548`	`</para>`
`537`	`549`	`</listitem>`
`538`	`550`	`</varlistentry>`
`@@ -576,51 +588,39 @@ PostgreSQL documentation`
`576`	`588`	`</varlistentry>`
`577`	`589`
`578`	`590`	`<varlistentry>`
`579`		`- <term><option>--manifest-force-encode</option></term>`
	`591`	`+ <term><option>--no-slot</option></term>`
`580`	`592`	`<listitem>`
`581`	`593`	`<para>`
`582`		`- Forces all filenames in the backup manifest to be hex-encoded.`
`583`		`- If this option is not specified, only non-UTF8 filenames are`
`584`		`- hex-encoded. This option is mostly intended to test that tools which`
`585`		`- read a backup manifest file properly handle this case.`
	`594`	`+ This option prevents the creation of a temporary replication slot`
	`595`	`+ during the backup even if it's supported by the server.`
	`596`	`+ </para>`
	`597`	`+ <para>`
	`598`	`+ Temporary replication slots are created by default if no slot name`
	`599`	`+ is given with the option <option>-S</option> when using log streaming.`
	`600`	`+ </para>`
	`601`	`+ <para>`
	`602`	`+ The main purpose of this option is to allow taking a base backup when`
	`603`	`+ the server is out of free replication slots. Using replication slots`
	`604`	`+ is almost always preferred, because it prevents needed WAL from being`
	`605`	`+ removed by the server during the backup.`
`586`	`606`	`</para>`
`587`	`607`	`</listitem>`
`588`	`608`	`</varlistentry>`
`589`	`609`
`590`	`610`	`<varlistentry>`
`591`		`- <term><option>--manifest-checksums=<replaceable class="parameter">algorithm</replaceable></option></term>`
	`611`	`+ <term><option>--no-verify-checksums</option></term>`
`592`	`612`	`<listitem>`
`593`	`613`	`<para>`
`594`		`- Specifies the checksum algorithm that should be applied to each file`
`595`		`- included in the backup manifest. Currently, the available`
`596`		`- algorithms are <literal>NONE</literal>, <literal>CRC32C</literal>,`
`597`		`- <literal>SHA224</literal>, <literal>SHA256</literal>,`
`598`		`- <literal>SHA384</literal>, and <literal>SHA512</literal>.`
`599`		`- The default is <literal>CRC32C</literal>.`
`600`		`- </para>`
`601`		`- <para>`
`602`		`- If <literal>NONE</literal> is selected, the backup manifest will`
`603`		`- not contain any checksums. Otherwise, it will contain a checksum`
`604`		`- of each file in the backup using the specified algorithm. In addition,`
`605`		`- the manifest will always contain a <literal>SHA256</literal>`
`606`		`- checksum of its own contents. The <literal>SHA</literal> algorithms`
`607`		`- are significantly more CPU-intensive than <literal>CRC32C</literal>,`
`608`		`- so selecting one of them may increase the time required to complete`
`609`		`- the backup.`
`610`		`- </para>`
`611`		`- <para>`
`612`		`- Using a SHA hash function provides a cryptographically secure digest`
`613`		`- of each file for users who wish to verify that the backup has not been`
`614`		`- tampered with, while the CRC32C algorithm provides a checksum which is`
`615`		`- much faster to calculate and good at catching errors due to accidental`
`616`		`- changes but is not resistant to targeted modifications. Note that, to`
`617`		`- be useful against an adversary who has access to the backup, the backup`
`618`		`- manifest would need to be stored securely elsewhere or otherwise`
`619`		`- verified not to have been modified since the backup was taken.`
	`614`	`+ Disables verification of checksums, if they are enabled on the server`
	`615`	`+ the base backup is taken from.`
`620`	`616`	`</para>`
`621`	`617`	`<para>`
`622`		`- <xref linkend="app-pgverifybackup" /> can be used to check the`
`623`		`- integrity of a backup against the backup manifest.`
	`618`	`+ By default, checksums are verified and checksum failures will result`
	`619`	`+ in a non-zero exit status. However, the base backup will not be`
	`620`	`+ removed in such a case, as if the <option>--no-clean</option> option`
	`621`	`+ had been used. Checksum verifications failures will also be reported`
	`622`	`+ in the <link linkend="monitoring-pg-stat-database-view">`
	`623`	`+ <structname>pg_stat_database</structname></link> view.`
`624`	`624`	`</para>`
`625`	`625`	`</listitem>`
`626`	`626`	`</varlistentry>`

`‎doc/src/sgml/ref/pg_dumpall.sgml`

Lines changed: 11 additions & 12 deletions

Original file line number	Diff line number	Diff line change
`@@ -287,18 +287,6 @@ PostgreSQL documentation`
`287`	`287`	`</listitem>`
`288`	`288`	`</varlistentry>`
`289`	`289`
`290`		`- <varlistentry>`
`291`		`- <term><option>--extra-float-digits=<replaceable class="parameter">ndigits</replaceable></option></term>`
`292`		`- <listitem>`
`293`		`- <para>`
`294`		`- Use the specified value of extra_float_digits when dumping`
`295`		`- floating-point data, instead of the maximum available precision.`
`296`		`- Routine dumps made for backup purposes should not use this option.`
`297`		`- </para>`
`298`		`- </listitem>`
`299`		`- </varlistentry>`
`300`		`-`
`301`		`-`
`302`	`290`	`<varlistentry>`
`303`	`291`	`<term><option>--exclude-database=<replaceable class="parameter">pattern</replaceable></option></term>`
`304`	`292`	`<listitem>`
`@@ -318,6 +306,17 @@ PostgreSQL documentation`
`318`	`306`	`</listitem>`
`319`	`307`	`</varlistentry>`
`320`	`308`
	`309`	`+ <varlistentry>`
	`310`	`+ <term><option>--extra-float-digits=<replaceable class="parameter">ndigits</replaceable></option></term>`
	`311`	`+ <listitem>`
	`312`	`+ <para>`
	`313`	`+ Use the specified value of extra_float_digits when dumping`
	`314`	`+ floating-point data, instead of the maximum available precision.`
	`315`	`+ Routine dumps made for backup purposes should not use this option.`
	`316`	`+ </para>`
	`317`	`+ </listitem>`
	`318`	`+ </varlistentry>`
	`319`	`+`
`321`	`320`	`<varlistentry>`
`322`	`321`	`<term><option>--if-exists</option></term>`
`323`	`322`	`<listitem>`

`‎doc/src/sgml/ref/pg_rewind.sgml`

Lines changed: 17 additions & 17 deletions

Original file line number	Diff line number	Diff line change
`@@ -178,23 +178,6 @@ PostgreSQL documentation`
`178`	`178`	`</listitem>`
`179`	`179`	`</varlistentry>`
`180`	`180`
`181`		`- <varlistentry>`
`182`		`- <term><option>--no-ensure-shutdown</option></term>`
`183`		`- <listitem>`
`184`		`- <para>`
`185`		`- <application>pg_rewind</application> requires that the target server`
`186`		`- is cleanly shut down before rewinding. By default, if the target server`
`187`		`- is not shut down cleanly, <application>pg_rewind</application> starts`
`188`		`- the target server in single-user mode to complete crash recovery first,`
`189`		`- and stops it.`
`190`		`- By passing this option, <application>pg_rewind</application> skips`
`191`		`- this and errors out immediately if the server is not cleanly shut`
`192`		`- down. Users are expected to handle the situation themselves in that`
`193`		`- case.`
`194`		`- </para>`
`195`		`- </listitem>`
`196`		`- </varlistentry>`
`197`		`-`
`198`	`181`	`<varlistentry>`
`199`	`182`	`<term><option>-R</option></term>`
`200`	`183`	`<term><option>--write-recovery-conf</option></term>`
`@@ -268,6 +251,23 @@ PostgreSQL documentation`
`268`	`251`	`</listitem>`
`269`	`252`	`</varlistentry>`
`270`	`253`
	`254`	`+ <varlistentry>`
	`255`	`+ <term><option>--no-ensure-shutdown</option></term>`
	`256`	`+ <listitem>`
	`257`	`+ <para>`
	`258`	`+ <application>pg_rewind</application> requires that the target server`
	`259`	`+ is cleanly shut down before rewinding. By default, if the target server`
	`260`	`+ is not shut down cleanly, <application>pg_rewind</application> starts`
	`261`	`+ the target server in single-user mode to complete crash recovery first,`
	`262`	`+ and stops it.`
	`263`	`+ By passing this option, <application>pg_rewind</application> skips`
	`264`	`+ this and errors out immediately if the server is not cleanly shut`
	`265`	`+ down. Users are expected to handle the situation themselves in that`
	`266`	`+ case.`
	`267`	`+ </para>`
	`268`	`+ </listitem>`
	`269`	`+ </varlistentry>`
	`270`	`+`
`271`	`271`	`<varlistentry>`
`272`	`272`	`<term><option>-V</option></term>`
`273`	`273`	`<term><option>--version</option></term>`

`‎doc/src/sgml/ref/pgbench.sgml`

Lines changed: 22 additions & 22 deletions

Original file line number	Diff line number	Diff line change
`@@ -336,26 +336,26 @@ pgbench <optional> <replaceable>options</replaceable> </optional> <replaceable>d`
`336`	`336`	`</varlistentry>`
`337`	`337`
`338`	`338`	`<varlistentry>`
`339`		`- <term><option>--partitions=<replaceable>NUM</replaceable></option></term>`
	`339`	`+ <term><option>--partition-method=<replaceable>NAME</replaceable></option></term>`
`340`	`340`	`<listitem>`
`341`	`341`	`<para>`
`342`	`342`	`Create a partitioned <literal>pgbench_accounts</literal> table with`
`343`		`- <replaceable>NUM</replaceable> partitions of nearly equal size for`
`344`		`- the scaled number of accounts.`
`345`		`- Default is <literal>0</literal>, meaning no partitioning.`
	`343`	`+ <replaceable>NAME</replaceable> method.`
	`344`	`+ Expected values are <literal>range</literal> or <literal>hash</literal>.`
	`345`	`+ This option requires that <option>--partitions</option> is set to non-zero.`
	`346`	`+ If unspecified, default is <literal>range</literal>.`
`346`	`347`	`</para>`
`347`	`348`	`</listitem>`
`348`	`349`	`</varlistentry>`
`349`	`350`
`350`	`351`	`<varlistentry>`
`351`		`- <term><option>--partition-method=<replaceable>NAME</replaceable></option></term>`
	`352`	`+ <term><option>--partitions=<replaceable>NUM</replaceable></option></term>`
`352`	`353`	`<listitem>`
`353`	`354`	`<para>`
`354`	`355`	`Create a partitioned <literal>pgbench_accounts</literal> table with`
`355`		`- <replaceable>NAME</replaceable> method.`
`356`		`- Expected values are <literal>range</literal> or <literal>hash</literal>.`
`357`		`- This option requires that <option>--partitions</option> is set to non-zero.`
`358`		`- If unspecified, default is <literal>range</literal>.`
	`356`	`+ <replaceable>NUM</replaceable> partitions of nearly equal size for`
	`357`	`+ the scaled number of accounts.`
	`358`	`+ Default is <literal>0</literal>, meaning no partitioning.`
`359`	`359`	`</para>`
`360`	`360`	`</listitem>`
`361`	`361`	`</varlistentry>`
`@@ -670,16 +670,6 @@ pgbench <optional> <replaceable>options</replaceable> </optional> <replaceable>d`
`670`	`670`	`</listitem>`
`671`	`671`	`</varlistentry>`
`672`	`672`
`673`		`- <varlistentry>`
`674`		`- <term><option>--show-script</option><replaceable>scriptname</replaceable></term>`
`675`		`- <listitem>`
`676`		`- <para>`
`677`		`- Show the actual code of builtin script <replaceable>scriptname</replaceable>`
`678`		`- on stderr, and exit immediately.`
`679`		`- </para>`
`680`		`- </listitem>`
`681`		`- </varlistentry>`
`682`		`-`
`683`	`673`	`<varlistentry>`
`684`	`674`	`<term><option>-t</option> <replaceable>transactions</replaceable></term>`
`685`	`675`	`<term><option>--transactions=</option><replaceable>transactions</replaceable></term>`
`@@ -750,21 +740,21 @@ pgbench <optional> <replaceable>options</replaceable> </optional> <replaceable>d`
`750`	`740`	`</varlistentry>`
`751`	`741`
`752`	`742`	`<varlistentry>`
`753`		`- <term><option>--random-seed=</option><replaceable>SEED</replaceable></term>`
	`743`	`+ <term><option>--random-seed=</option><replaceable>seed</replaceable></term>`
`754`	`744`	`<listitem>`
`755`	`745`	`<para>`
`756`	`746`	`Set random generator seed. Seeds the system random number generator,`
`757`	`747`	`which then produces a sequence of initial generator states, one for`
`758`	`748`	`each thread.`
`759`		`- Values for <replaceable>SEED</replaceable> may be:`
	`749`	`+ Values for <replaceable>seed</replaceable> may be:`
`760`	`750`	`<literal>time</literal> (the default, the seed is based on the current time),`
`761`	`751`	`<literal>rand</literal> (use a strong random source, failing if none`
`762`	`752`	`is available), or an unsigned decimal integer value.`
`763`	`753`	`The random generator is invoked explicitly from a pgbench script`
`764`	`754`	`(<literal>random...</literal> functions) or implicitly (for instance option`
`765`	`755`	`<option>--rate</option> uses it to schedule transactions).`
`766`	`756`	`When explicitly set, the value used for seeding is shown on the terminal.`
`767`		`- Any value allowed for <replaceable>SEED</replaceable> may also be`
	`757`	`+ Any value allowed for <replaceable>seed</replaceable> may also be`
`768`	`758`	`provided through the environment variable`
`769`	`759`	`<literal>PGBENCH_RANDOM_SEED</literal>.`
`770`	`760`	`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`
`804`	`794`	`</listitem>`
`805`	`795`	`</varlistentry>`
`806`	`796`
	`797`	`+ <varlistentry>`
	`798`	`+ <term><option>--show-script=</option><replaceable>scriptname</replaceable></term>`
	`799`	`+ <listitem>`
	`800`	`+ <para>`
	`801`	`+ Show the actual code of builtin script <replaceable>scriptname</replaceable>`
	`802`	`+ on stderr, and exit immediately.`
	`803`	`+ </para>`
	`804`	`+ </listitem>`
	`805`	`+ </varlistentry>`
	`806`	`+`
`807`	`807`	`</variablelist>`
`808`	`808`	`</para>`
`809`	`809`

0 commit comments

Comments

(0)

Movatterモバイル変換

Navigation Menu

Search code, repositories, users, issues, pull requests...

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Commitb25da86

File tree

5 files changed

5 files changed

`‎doc/src/sgml/ref/dropdb.sgml`

`‎doc/src/sgml/ref/pg_basebackup.sgml`

`‎doc/src/sgml/ref/pg_dumpall.sgml`

`‎doc/src/sgml/ref/pg_rewind.sgml`

`‎doc/src/sgml/ref/pgbench.sgml`

0 commit comments