@@ -25,6 +25,7 @@ It takes a physical online backup of whole database cluster, archive
2525WALs, and server logs.
2626
2727It proposes the following features:
28+
2829- Backup while database runs including tablespaces with just one
2930 command
3031- Recovery from backup with just one command, with customized targets
@@ -35,8 +36,8 @@ It proposes the following features:
3536
3637== COMMANDS ==
3738
38- pg_rman supports the following commands. See alsoOptions fordetails of
39- OPTIONS .
39+ pg_rman supports the following commands. See alsoOPTIONS formore
40+ details .
4041
4142init::
4243 Initialize a backup catalog.
@@ -73,10 +74,8 @@ specify it in PGDATA environmental variable or -D/--pgdata option.
7374Backup target can be one of the following types also serverlogs can be added):
7475
7576- Full backup, backup a whole database cluster.
76-
7777- Incremental backup, backup only files or pages modified after the last
7878verified backup.
79-
8079- Archive WAL backup, Backup only archive WAL files.
8180
8281It is recommended to verify backup files as soon as possible after backup.
@@ -100,7 +99,7 @@ target. If pg_control is not present, TimeLineID in the full backup used by
10099the restore will be a restore target.
101100
102101
103- ==Examples ==
102+ ==EXAMPLES ==
104103
105104To reduce the number of command line arguments, you can set BACKUP_PATH,
106105an environment variable, to the absolute path of the backup catalog and
@@ -122,12 +121,14 @@ write default configuration into ${BACKUP_PATH}/pg_rman.ini.
122121
123122This example takes a full backup of the whole database with server logs.
124123Then, it validates all unvalidated backups.
124+
125125$ pg_rman backup --backup-mode=full --with-serverlog
126126$ pg_rman validate
127127
128128=== RESTORE FROM A BACKUP ===
129129
130130Here are some commands to restore from a backup:
131+
131132$ pg_ctl stop -m immediate
132133$ pg_rman restore
133134$ pg_ctl start
@@ -143,27 +144,24 @@ Here are some commands to restore from a backup:
1431442013-12-25 03:02:25 FULL 1 0 0m 33MB 33MB ---- 64MB OK
144145
145146The fields are:
146- - Start : start time of backup
147- - Mode: Mode of backup
148- -- FULL for a full backup
149- -- INCR for an incremental backup
150- -- ARCH for archive backup
151- - Current TLI: current timeline of backup
152- - Parent TLI: parent timeline of backup
153- - Time : total time necessary to take this backup
154- - Total : Total size of backup
155- - Data : size of data files
156- - WAL : size of read WAL archive files
157- - Log : size of read server log files
158- - Backup: size of backup (= written size)
159- - Status: status of backup. Possible values are:
160- -- OK : backup is done and validated.
161- -- DONE : backup is done, but not validated yet.
162- -- RUNNING : backup is running
163- -- DELETING : backup is being deleted.
164- -- DELETED : backup has been deleted.
165- -- ERROR : backup is unavailable because some errors occur during backup.
166- -- CORRUPT : backup is unavailable because it is broken.
147+
148+ * Start: start time of backup
149+ * Mode: Mode of backup: FULL (full), INCR (incremental) or ARCH (archive)
150+ * Current TLI: current timeline of backup
151+ * Parent TLI: parent timeline of backup
152+ * Time: total time necessary to take this backup
153+ * Data: size of data files
154+ * WAL: size of read WAL archive files
155+ * Log: size of read server log files
156+ * Backup: size of backup (= written size)
157+ * Status: status of backup. Possible values are:
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.
167165
168166When a date is specified, more details about a backup is retrieved:
169167
@@ -196,7 +194,7 @@ the specified date.
196194== OPTIONS ==
197195
198196pg_rman accepts the following command line parameters. Some of them can
199- be also sepcified as environment variables. See alsoParameters for the
197+ be also sepcified as environment variables. See alsoPARAMETERS for the
200198details.
201199
202200=== COMMON OPTIONS ===
@@ -228,16 +226,12 @@ absolute paths; relative paths are not allowed.
228226
229227=== BACKUP OPTIONS ===
230228
231- -b { full | incremental | archive } --backup-mode={ full | incremental | archive }::
229+ -b { full | incremental | archive }/ --backup-mode={ full | incremental | archive }::
232230 Specify backup target files. Available options are: "full" backup,
233231 "incremental" backup, and "archive" backup. Abbreviated forms
234232 (prefix match) are also available. For example, -b f means "full"
235233 backup.
236234
237- full : Whole database backup and archive backup
238- incremental : Incremental backup and archive backup
239- archive : Only archive backup
240-
241235-s / --with-serverlog::
242236 Backup server log files if specified.
243237
@@ -438,7 +432,7 @@ pg_rman returns exit codes for each error status.
43843226ERROR_PID_BROKENpostmaster.pid is broken
439433
440434== AUTHOR ==
441- pg_rman was originally written by NTT,and maintained in some way by Michael
442- Paquier.
435+ pg_rman was originally written by NTT,mainly Itagaki Takahiro, and maintained
436+ in some way by Michael Paquier.
443437
444438Please report bug reports at <https://github.com/michaelpq/pg_rman>.
