Skip to content

Commit 5429f70

Browse files
author
Michael Paquier
committed
Fix whitespaces and typos in documentation
The output of "show" command was incorrect as well.
1 parent c8ebcc9 commit 5429f70

File tree

1 file changed

+25
-27
lines changed

1 file changed

+25
-27
lines changed

doc/pg_arman.txt

Lines changed: 25 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ details.
4848

4949
*show*::
5050
Show backup history. The timeline option shows timeline of the backup
51-
and the parent's timeline for each backup.
51+
and the parent's timeline for each backup.
5252

5353
*validate*::
5454
Validate backup files.
@@ -71,12 +71,12 @@ specify it in PGDATA environmental variable or -D/--pgdata option.
7171

7272
Backup target can be one of the following types:
7373

74-
- Full backup, backup a whole database cluster.
74+
- Full backup, backup a whole database cluster.
7575
- Incremental backup, backup only files or pages modified after the last
76-
verified backup.
76+
verified backup.
7777

7878
It is recommended to verify backup files as soon as possible after backup.
79-
Unverified backup cannot be used in restore and in incremental backup.
79+
Unverified backup cannot be used in restore and in incremental backup.
8080

8181
=== RESTORE ===
8282

@@ -93,7 +93,7 @@ has succeeded.
9393
If "--recovery-target-timeline" is not specifed, the last checkpoint's
9494
TimeLineID in control file ($PGDATA/global/pg_control) will be the restore
9595
target. If pg_control is not present, TimeLineID in the full backup used by
96-
the restore will be a restore target.
96+
the restore will be a restore target.
9797

9898

9999
== EXAMPLES ==
@@ -130,12 +130,12 @@ Here are some commands to restore from a backup:
130130
=== SHOW A BACKUP ===
131131

132132
$ pg_arman show
133-
==================================================================================================
134-
Start Mode Current TLI Parent TLI Time Data WAL Log Backup Status
135-
==================================================================================================
136-
2013-12-25 03:02:31 INCR 1 0 0m 203kB 67MB ---- 67MB DONE
137-
2013-12-25 03:02:31 INCR 1 0 0m 0B ---- ---- 0B ERROR
138-
2013-12-25 03:02:25 FULL 1 0 0m 33MB 33MB ---- 64MB OK
133+
===================================================================================
134+
Start Mode Current TLI Parent TLI Time Data Backup Status
135+
===================================================================================
136+
2013-12-25 03:02:31 INCR 1 0 0m 203kB 67MB DONE
137+
2013-12-25 03:02:31 INCR 1 0 0m 0B 0B ERROR
138+
2013-12-25 03:02:25 FULL 1 0 0m 33MB 364MB OK
139139

140140
The fields are:
141141

@@ -205,7 +205,7 @@ absolute paths; relative paths are not allowed.
205205
*-c* / *--check*::
206206
If specifed, pg_arman doesn't perform actual jobs but only checks
207207
parameters and required resources. The option is typically used with
208-
--verbose option to verify the operation.
208+
--verbose option to verify the operation.
209209

210210
*-v* / *--verbose*::
211211
If specified, pg_arman works in verbose mode.
@@ -215,15 +215,15 @@ absolute paths; relative paths are not allowed.
215215
*-b* _BACKUPMODE_ / *--backup-mode*=_BACKUPMODE_::
216216
Specify backup target files. Available options are: "full",
217217
"incremental". Abbreviated forms (prefix match) are also available.
218-
For example, -b f means "full" backup.
218+
For example, -b f means "full" backup.
219219

220220
*-Z* / *--compress-data*::
221-
Compress backup files with zlib if specified.
221+
Compress backup files with zlib if specified.
222222

223223
*-C* / *--smooth-checkpoint*::
224224
Checkpoint is performed on every backups. If the option is specified,
225225
do smooth checkpoint then. See also the second argument for
226-
pg_start_backup().
226+
pg_start_backup().
227227

228228
*--validate*::
229229
Validate a backup just after taking it. Other backups taken
@@ -241,16 +241,16 @@ The parameters whose name start are started with --recovery refer to
241241
the same parameters as the ones in recovery.confin recovery.conf.
242242

243243
*--recovery-target-timeline*=_TIMELINE_::
244-
Specifies recovering into a particular timeline.
245-
If not specified, the current timeline is used.
244+
Specifies recovering into a particular timeline. If not specified,
245+
the current timeline is used.
246246

247247
*--recovery-target-time*=_TIMESTAMP_::
248248
This parameter specifies the timestamp up to which recovery will
249249
proceed.
250250

251251
*--recovery-target-xid*=_XID::
252252
This parameter specifies the transaction ID up to which recovery
253-
will proceed.
253+
will proceed.
254254

255255
*--recovery-target-inclusive*::
256256
Specifies whether server pauses when recovery target is reached.
@@ -276,22 +276,22 @@ Parameters to connect PostgreSQL server.
276276
which the server is listening for connections.
277277

278278
*-U* _USERNAME_ / *--username*=_USERNAME_::
279-
User name to connect as.
279+
User name to connect as.
280280

281281
*-w* / *--no-password*::
282282
Never issue a password prompt. If the server requires password
283283
authentication and a password is not available by other means such as
284284
a .pgpass file, the connection attempt will fail. This option can be
285285
useful in batch jobs and scripts where no user is present to enter a
286-
password.
286+
password.
287287

288288
*-W* / *--password*::
289289
Force pg_arman to prompt for a password before connecting to a database.
290290
This option is never essential, since pg_arman will automatically
291291
prompt for a password if the server demands password authentication.
292292
However, pg_arman will waste a connection attempt in order to find out
293293
if the server wants a password. In some cases it is worth typing -W
294-
to avoid the extra connection attempt.
294+
to avoid the extra connection attempt.
295295

296296
=== GLOBAL OPTIONS ===
297297

@@ -326,19 +326,17 @@ variables or in configuration file as follows:
326326
--validate VALIDATE Yes
327327
--keep-data-generations KEEP_DATA_GENERATIONS Yes
328328
--keep-data-days KEEP_DATA_DAYS Yes
329-
--keep-arclog-files KEEP_ARCLOG_FILES Yes
330-
--keep-arclog-days KEEP_ARCLOG_DAYS Yes
331329
--recovery-target-timeline RECOVERY_TARGET_TIMELINE Yes
332330
--recovery-target-xid RECOVERY_TARGET_XID Yes
333331
--recovery-target-time RECOVERY_TARGET_TIME Yes
334332
--recovery-target-inclusive RECOVERY_TARGET_INCLUSIVE Yes
335333

336334
Variable names in configuration file are the same as long names or names
337335
of environment variables. The password can not be specified in command
338-
line and configuration file for security reason.
336+
line and configuration file for security reason.
339337

340338
This utility, like most other PostgreSQL utilities, also uses the
341-
environment variables supported by libpq (see Environment Variables)
339+
environment variables supported by libpq (see Environment Variables).
342340

343341
== RESTRICTIONS ==
344342

@@ -394,7 +392,7 @@ pg_arman returns exit codes for each error status.
394392
26 ERROR_PID_BROKEN postmaster.pid is broken
395393

396394
== AUTHOR ==
397-
pg_arman is a fork of pg_rman that was originally written by NTT, now
398-
maintained by Michael Paquier.
395+
pg_arman is a fork of pg_rman that was originally written by NTT, now developed
396+
and maintained by Michael Paquier.
399397

400398
Please report bug reports at <https://github.com/michaelpq/pg_arman>.

0 commit comments

Comments
 (0)