Skip to content

Commit 3ff83bd

Browse files
author
Liudmila Mantrova
committed
DOC: fixed command syntax and links
1 parent a6fd004 commit 3ff83bd

File tree

1 file changed

+18
-18
lines changed

1 file changed

+18
-18
lines changed

‎doc/src/sgml/pgprobackup.sgml

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -239,7 +239,7 @@ doc/src/sgml/pgprobackup.sgml
239239
</listitem>
240240
</itemizedlist>
241241
<para><emphasis role="strong">See Also</emphasis></para>
242-
<para><xref linkend="pg-probackup-creating-backup"></para>
242+
<para><link linkend="pg-probackup-creating-backup">Creating Backups</link></para>
243243

244244
<refsect2 id="pg-probackup-limitations">
245245
<title>Limitations</title>
@@ -293,7 +293,7 @@ doc/src/sgml/pgprobackup.sgml
293293
</listitem>
294294
<listitem>
295295
<para>
296-
<link linkend="configuring-the-database-cluster-for-backups">Configure the database cluster for backups</link>.
296+
<link linkend="configuring-database-cluster">Configure the database cluster to enable <application>pg_probackup</application> backups</link>.
297297
</para>
298298
</listitem>
299299
</orderedlist>
@@ -385,8 +385,8 @@ pg_probackup init -B <replaceable>backupdir</replaceable> -D <replaceable>datadi
385385
For details, see <xref linkend="configuring-pg-probackup">.
386386
</para>
387387
</refsect2>
388-
<refsect2 id="configuring-the-database-cluster-for-backups">
389-
<title>Configuring the Database Cluster for Backups</title>
388+
<refsect2 id="configuring-database-cluster">
389+
<title>Configuring the Database Cluster</title>
390390
<para>Depending on whether you are going to use autonomous or archive backup
391391
strategies, <productname>&productname;</productname> cluster configuration
392392
will differ. To backup the database cluster from a standby
@@ -415,7 +415,7 @@ pg_probackup init -B <replaceable>backupdir</replaceable> -D <replaceable>datadi
415415
<orderedlist numeration="arabic">
416416
<listitem>
417417
<para>
418-
Create the <literal>backup</literal> role with the
418+
Create the <literal>backup</literal> role with
419419
<link linkend="role-attributes"><literal>LOGIN</literal> and <literal>REPLICATION</literal> privileges</link>.
420420
</para>
421421
<programlisting>
@@ -501,8 +501,8 @@ CREATE ROLE backup WITH LOGIN;
501501
<listitem>
502502
<para>
503503
Set <varname>archive_command</varname> to
504-
<literal>test ! -f backup_dir/wal/%f &amp;&amp; cp %p backup_dir/wal/%f</literal>
505-
where <replaceable>backup_dir</replaceable> is the initialized
504+
<literal>test ! -f backupdir/wal/%f &amp;&amp; cp %p backupdir/wal/%f</literal>
505+
where <replaceable>backupdir</replaceable> is the initialized
506506
backup catalog.
507507
</para>
508508
</listitem>
@@ -1255,7 +1255,7 @@ pg_probackup help [<replaceable>command</replaceable>]
12551255
<title>Creating a Backup</title>
12561256
<para>To create a backup, run the following command:
12571257
<programlisting>
1258-
pg_probackup backup -b <replaceable>backup_mode</replaceable>
1258+
pg_probackup backup -B <replaceable>backupdir</replaceable> -b <replaceable>backup_mode</replaceable>
12591259
</programlisting>
12601260
where <replaceable>backup_mode</replaceable> can take one of the following values:</para>
12611261
<itemizedlist spacing="compact">
@@ -1297,7 +1297,7 @@ Thus, you must create at least one full backup before taking incremental ones.
12971297
To make a backup autonomous, add the <option>--stream</option> option to the above command. For example, to create a full autonomous backup, run:
12981298
</para>
12991299
<programlisting>
1300-
pg_probackup backup -b FULL --stream
1300+
pg_probackup backup -B <replaceable>backupdir</replaceable> -b FULL --stream
13011301
</programlisting>
13021302

13031303
<para>
@@ -1359,7 +1359,7 @@ pg_probackup backup -b FULL --stream
13591359
<replaceable>xid</replaceable> transaction ID, run this command:
13601360
</para>
13611361
<programlisting>
1362-
pg_probackup validate --xid=<replaceable>xid</replaceable>
1362+
pg_probackup validate -B <replaceable>backupdir</replaceable> --xid=<replaceable>xid</replaceable>
13631363
</programlisting>
13641364
<para>
13651365
If validation completes successfully,
@@ -1396,7 +1396,7 @@ pg_probackup validate --xid=<replaceable>xid</replaceable>
13961396
</listitem>
13971397
</orderedlist>
13981398
<programlisting>
1399-
pg_probackup restore -D <replaceable>datadir</replaceable> -i <replaceable>backup_id</replaceable>
1399+
pg_probackup restore -B <replaceable>backupdir</replaceable> -D <replaceable>datadir</replaceable> -i <replaceable>backup_id</replaceable>
14001400
</programlisting>
14011401
<para>
14021402
where:
@@ -1446,13 +1446,13 @@ pg_probackup restore -D <replaceable>datadir</replaceable> -i <replaceable>backu
14461446
format. For example:
14471447
</para>
14481448
<programlisting>
1449-
pg_probackup restore --time='2017-05-18 14:18:11'
1449+
pg_probackup restore -B <replaceable>backupdir</replaceable> --time='2017-05-18 14:18:11'
14501450
</programlisting>
14511451
<para>
14521452
To restore the cluster state up to a specific transaction ID, use the <option>xid</option>:
14531453
</para>
14541454
<programlisting>
1455-
pg_probackup restore --xid=687
1455+
pg_probackup restore -B <replaceable>backupdir</replaceable> --xid=687
14561456
</programlisting>
14571457
<para>
14581458
If the cluster to restore contains tablespaces,
@@ -1471,7 +1471,7 @@ pg_probackup restore --xid=687
14711471
tablespaces. For example:
14721472
</para>
14731473
<programlisting>
1474-
pg_probackup restore -D <replaceable>datadir</replaceable> -j 4 -i <replaceable>backup_id</replaceable> -T <replaceable>/tmp/tablespace1</replaceable>=<replaceable>/tmp/tablespace1_new</replaceable> -T <replaceable>/tmp/tablespace2</replaceable>=<replaceable>/tmp/tablespace2_new</replaceable>
1474+
pg_probackup restore -B <replaceable>backupdir</replaceable> -D <replaceable>datadir</replaceable> -j 4 -i <replaceable>backup_id</replaceable> -T <replaceable>tablespace1_dir</replaceable>=<replaceable>tablespace1_newdir</replaceable> -T <replaceable>tablespace2_dir</replaceable>=<replaceable>tablespace2_newdir</replaceable>
14751475
</programlisting>
14761476
<para>
14771477
Once the <literal>restore</literal> command is complete, start the
@@ -1494,7 +1494,7 @@ pg_probackup restore -D <replaceable>datadir</replaceable> -j 4 -i <replaceable>
14941494
Parallel execution is controlled by the <option>-j</option>/<option>--threads</option>
14951495
command line option. For example, to create a backup using four parallel threads, run:
14961496
<programlisting>
1497-
pg_probackup backup -b full -j 4
1497+
pg_probackup backup -B <replaceable>backupdir</replaceable> -b FULL -j 4
14981498
</programlisting>
14991499
</para>
15001500

@@ -1593,16 +1593,16 @@ pg_probackup delete --expired
15931593
<refsect1 id="managing-backup-catalog">
15941594
<title>Managing the Backup Catalog</title>
15951595
<para>
1596-
With <application>pg_probackup</application>, you can manage and configure
1596+
With <application>pg_probackup</application>, you can manage
15971597
backups from the command line:
15981598
</para>
15991599
<itemizedlist>
16001600
<listitem>
1601-
<para><xref linkend="viewing-backup-info">
1601+
<para><link linkend="viewing-backup-info">View available backups</link>
16021602
</para>
16031603
</listitem>
16041604
<listitem>
1605-
<para><xref linkend="pg-probackup-deleting-backups">
1605+
<para><link linkend="pg-probackup-deleting-backups">Delete backups</link>
16061606
</para>
16071607
</listitem>
16081608
</itemizedlist>

0 commit comments

Comments
 (0)