Skip to content

Commit d378c56

Browse files
committed
Update pg_arman.md
1 parent f441157 commit d378c56

File tree

1 file changed

+21
-22
lines changed

1 file changed

+21
-22
lines changed

doc/pg_arman.md

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

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

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

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

49-
**show**:
50-
Show backup history. The timeline option shows timeline of the backup
51-
and the parent's timeline for each backup.
49+
* **show**:
50+
Show backup history. The timeline option shows timeline of the backup and the parent's timeline for each backup.
5251

53-
**validate**:
52+
* **validate**:
5453
Validate backup files.
5554

56-
**delete**:
57-
Delete backup files.
55+
* **delete**:
56+
Delete backup files.
5857

5958
### INITIALIZATION
6059

@@ -156,13 +155,13 @@ The fields are:
156155
* Log: size of read server log files
157156
* Backup: size of backup (= written size)
158157
* Status: status of backup. Possible values are:
159-
- OK : backup is done and validated.
160-
- DONE : backup is done, but not validated yet.
161-
- RUNNING : backup is running
162-
- DELETING : backup is being deleted.
163-
- DELETED : backup has been deleted.
164-
- ERROR : backup is unavailable because some errors occur during backup.
165-
- CORRUPT : backup is unavailable because it is broken.
158+
* OK : backup is done and validated.
159+
* DONE : backup is done, but not validated yet.
160+
* RUNNING : backup is running
161+
* DELETING : backup is being deleted.
162+
* DELETED : backup has been deleted.
163+
* ERROR : backup is unavailable because some errors occur during backup.
164+
* CORRUPT : backup is unavailable because it is broken.
166165

167166
When a date is specified, more details about a backup is retrieved:
168167

@@ -202,15 +201,15 @@ details.
202201
As a general rule, paths for data location need to be specified as
203202
absolute paths; relative paths are not allowed.
204203

205-
**-D** PATH / **--pgdata**=*PATH*:
204+
**-D** PATH / **--pgdata**=PATH:
206205
The absolute path of database cluster. Required on backup and
207206
restore.
208207

209-
**-A** PATH / **--arclog-path**=*PATH*:
208+
**-A** PATH / **--arclog-path**=PATH:
210209
The absolute path of archive WAL directory. Required for restore
211210
and show command.
212211

213-
**-B** PATH / **--backup-path**=*PATH*:
212+
**-B** PATH / **--backup-path**=PATH:
214213
The absolute path of backup catalog. This option is mandatory.
215214

216215
**-c** / **--check**:

0 commit comments

Comments
 (0)