Skip to content

Commit f441157

Browse files
stalkergstalkerg
committed
Fix doc
1 parent ecb5492 commit f441157

File tree

1 file changed

+44
-41
lines changed

1 file changed

+44
-41
lines changed

‎doc/pg_arman.md

Lines changed: 44 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -37,23 +37,23 @@ It proposes the following features:
3737
pg_arman supports the following commands. See also **OPTIONS** for more
3838
details.
3939

40-
**init**:
40+
**init**:
4141
Initialize a backup catalog.
4242

43-
**backup**:
43+
**backup**:
4444
Take an online backup.
4545

46-
**restore**:
46+
**restore**:
4747
Perform restore.
4848

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

53-
**validate**:
53+
**validate**:
5454
Validate backup files.
5555

56-
**delete**:
56+
**delete**:
5757
Delete backup files.
5858

5959
### INITIALIZATION
@@ -202,38 +202,38 @@ details.
202202
As a general rule, paths for data location need to be specified as
203203
absolute paths; relative paths are not allowed.
204204

205-
**-D** *PATH* / **--pgdata**=*PATH*:
205+
**-D** PATH / **--pgdata**=*PATH*:
206206
The absolute path of database cluster. Required on backup and
207207
restore.
208208

209-
**-A** *PATH* / **--arclog-path**=*PATH*:
209+
**-A** PATH / **--arclog-path**=*PATH*:
210210
The absolute path of archive WAL directory. Required for restore
211211
and show command.
212212

213-
*-B* _PATH_ / *--backup-path*=_PATH_::
213+
**-B** PATH / **--backup-path**=*PATH*:
214214
The absolute path of backup catalog. This option is mandatory.
215215

216-
*-c* / *--check*::
216+
**-c** / **--check**:
217217
If specifed, pg_arman doesn't perform actual jobs but only checks
218218
parameters and required resources. The option is typically used with
219219
--verbose option to verify the operation.
220220

221-
=== BACKUP OPTIONS ===
221+
### BACKUP OPTIONS
222222

223-
*-b* _BACKUPMODE_ / *--backup-mode*=_BACKUPMODE_::
223+
**-b** BACKUPMODE / **--backup-mode**=BACKUPMODE:
224224
Specify backup target files. Available options are: "full",
225225
"page".
226226

227-
*-C* / *--smooth-checkpoint*::
227+
**-C** / **--smooth-checkpoint**:
228228
Checkpoint is performed on every backups. If the option is specified,
229229
do smooth checkpoint then. See also the second argument for
230230
pg_start_backup().
231231

232-
*--validate*::
232+
**--validate**:
233233
Validate a backup just after taking it. Other backups taken
234234
previously are ignored.
235235

236-
*--keep-data-generations*=_NUMBER_ / *--keep-data-days*=_DAYS_::
236+
**--keep-data-generations**=NUMBER / **--keep-data-days**=DAYS:
237237
Specify how long backuped data files will be kept.
238238
--keep-data-generations means number of backup generations.
239239
--keep-data-days means days to be kept.
@@ -312,27 +312,28 @@ Parameters to connect PostgreSQL server.
312312

313313
Some of parameters can be specified as command line arguments, environment
314314
variables or in configuration file as follows:
315-
316-
Short Long Env File
317-
-h --host PGHOST No
318-
-p --port PGPORT No
319-
-d --dbname PGDATABASE No
320-
-U --username PGUSER No
321-
PGPASSWORD No
322-
-w --password No
323-
-W --no-password No
324-
-D --pgdata PGDATA Yes
325-
-B --backup-path BACKUP_PATH Yes
326-
-A --arclog-path ARCLOG_PATH Yes
327-
-b --backup-mode BACKUP_MODE Yes
328-
-C --smooth-checkpoint SMOOTH_CHECKPOINT Yes
329-
--validate VALIDATE Yes
330-
--keep-data-generations KEEP_DATA_GENERATIONS Yes
331-
--keep-data-days KEEP_DATA_DAYS Yes
332-
--recovery-target-timeline RECOVERY_TARGET_TIMELINE Yes
333-
--recovery-target-xid RECOVERY_TARGET_XID Yes
334-
--recovery-target-time RECOVERY_TARGET_TIME Yes
335-
--recovery-target-inclusive RECOVERY_TARGET_INCLUSIVE Yes
315+
```
316+
Short Long Env File
317+
-h --host PGHOST No
318+
-p --port PGPORT No
319+
-d --dbname PGDATABASE No
320+
-U --username PGUSER No
321+
PGPASSWORD No
322+
-w --password No
323+
-W --no-password No
324+
-D --pgdata PGDATA Yes
325+
-B --backup-path BACKUP_PATH Yes
326+
-A --arclog-path ARCLOG_PATH Yes
327+
-b --backup-mode BACKUP_MODE Yes
328+
-C --smooth-checkpoint SMOOTH_CHECKPOINT Yes
329+
--validate VALIDATE Yes
330+
--keep-data-generations KEEP_DATA_GENERATIONS Yes
331+
--keep-data-days KEEP_DATA_DAYS Yes
332+
--recovery-target-timeline RECOVERY_TARGET_TIMELINE Yes
333+
--recovery-target-xid RECOVERY_TARGET_XID Yes
334+
--recovery-target-time RECOVERY_TARGET_TIME Yes
335+
--recovery-target-inclusive RECOVERY_TARGET_INCLUSIVE Yes
336+
```
336337

337338
Variable names in configuration file are the same as long names or names
338339
of environment variables. The password can not be specified in command
@@ -376,11 +377,13 @@ aimed at working with PostgreSQL 9.5 and newer versions.
376377
### EXIT CODE
377378
pg_arman returns exit codes for each error status.
378379

379-
Code Name Description
380-
0 SUCCESS Operation succeeded.
381-
1 ERROR Generic error
382-
2 FATAL Exit because of repeated errors
383-
3 PANIC Unknown critical condition
380+
```
381+
Code Name Description
382+
0 SUCCESS Operation succeeded.
383+
1 ERROR Generic error
384+
2 FATAL Exit because of repeated errors
385+
3 PANIC Unknown critical condition
386+
```
384387

385388
## AUTHOR ##
386389
pg_arman is a fork of pg_arman that was originally written by NTT, now

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