Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Commit85e97a1

Browse files
committed
Start move document to markdown
1 parent8d4477f commit85e97a1

File tree

1 file changed

+27
-27
lines changed

1 file changed

+27
-27
lines changed

‎doc/pg_arman.md

Lines changed: 27 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
= pg_arman(1)=
1+
#pg_arman(1)
22

3-
== NAME==
3+
##NAME
44

55
pg_arman - Backup and recovery manager for PostgreSQL
66

7-
== SYNOPSIS==
7+
##SYNOPSIS
88

99
pg_arman[ OPTIONS]
1010
{ init |
@@ -18,7 +18,7 @@ DATE is the start time of the target backup in ISO-format:
1818
(YYYY-MM-DD HH:MI:SS). Prefix match is used to compare DATE and backup
1919
files.
2020

21-
== DESCRIPTION==
21+
##DESCRIPTION
2222

2323
pg_arman is a utility program to backup and restore PostgreSQL database.
2424

@@ -31,7 +31,7 @@ It proposes the following features:
3131
- Support for full and differential backup
3232
- Management of backups with integrated catalog
3333

34-
== COMMANDS==
34+
##COMMANDS
3535

3636
pg_arman supports the following commands. See also*OPTIONS* for more
3737
details.
@@ -55,7 +55,7 @@ details.
5555
*delete*::
5656
Delete backup files.
5757

58-
=== INITIALIZATION===
58+
###INITIALIZATION
5959

6060
First, you need to create "a backup catalog" to store backup files and
6161
their metadata. It is recommended to setup archive_mode and archive_command
@@ -66,7 +66,7 @@ specify it in PGDATA environmental variable or -D/--pgdata option.
6666

6767
$ pg_arman init -B /path/to/backup/
6868

69-
=== BACKUP===
69+
###BACKUP
7070

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

@@ -81,7 +81,7 @@ has been run needs to be forcibly switched.
8181
It is recommended to verify backup files as soon as possible after backup.
8282
Unverified backup cannot be used in restore and in differential backup.
8383

84-
=== RESTORE===
84+
###RESTORE
8585

8686
PostgreSQL server should be stopped before performing a restore. If database
8787
cluster still exists, restore command will save unarchived transaction log
@@ -99,7 +99,7 @@ target. If pg_control is not present, TimeLineID in the full backup used by
9999
the restore will be a restore target.
100100

101101

102-
== EXAMPLES==
102+
###EXAMPLES
103103

104104
To reduce the number of command line arguments, you can set BACKUP_PATH,
105105
an environment variable, to the absolute path of the backup catalog and
@@ -111,32 +111,32 @@ write default configuration into ${BACKUP_PATH}/pg_arman.ini.
111111
KEEP_DATA_GENERATIONS = 3
112112
KEEP_DATA_DAYS = 120
113113

114-
=== TAKE A BACKUP===
114+
###TAKE A BACKUP
115115

116116
This example takes a full backup of the whole database. Then, it validates
117117
all unvalidated backups.
118118

119119
$ pg_arman backup --backup-mode=full
120120
$ pg_arman validate
121121

122-
=== RESTORE FROM A BACKUP===
122+
###RESTORE FROM A BACKUP
123123

124124
Here are some commands to restore from a backup:
125125

126126
$ pg_ctl stop -m immediate
127127
$ pg_arman restore
128128
$ pg_ctl start
129129

130-
=== SHOW A BACKUP===
131-
130+
###SHOW A BACKUP
131+
```
132132
$ pg_arman show
133133
===================================================================================
134134
Start Mode Current TLI Parent TLI Time Data Backup Status
135135
===================================================================================
136136
2013-12-25 03:02:31 PAGE 1 0 0m 203kB 67MB DONE
137137
2013-12-25 03:02:31 PAGE 1 0 0m 0B 0B ERROR
138138
2013-12-25 03:02:25 FULL 1 0 0m 33MB 364MB OK
139-
139+
```
140140
The fields are:
141141

142142
* Start: start time of backup
@@ -182,13 +182,13 @@ the specified date. This command also cleans up in the WAL archive the
182182
WAL segments that are no longer needed to restore from the remaining
183183
backups.
184184

185-
== OPTIONS==
185+
###OPTIONS
186186

187187
pg_arman accepts the following command line parameters. Some of them can
188188
be also specified as environment variables. See also*PARAMETERS* for the
189189
details.
190190

191-
=== COMMON OPTIONS===
191+
###COMMON OPTIONS
192192
As a general rule, paths for data location need to be specified as
193193
absolute paths; relative paths are not allowed.
194194

@@ -229,7 +229,7 @@ absolute paths; relative paths are not allowed.
229229
--keep-data-days means days to be kept.
230230
Only files exceeded one of those settings are deleted.
231231

232-
=== RESTORE OPTIONS===
232+
###RESTORE OPTIONS
233233

234234
The parameters whose name start are started with --recovery refer to
235235
the same parameters as the ones in recovery.confin recovery.conf.
@@ -254,7 +254,7 @@ the same parameters as the ones in recovery.confin recovery.conf.
254254
*-a* /*--show-all*::
255255
Show all existing backups, including the deleted ones.
256256

257-
=== CONNECTION OPTIONS===
257+
###CONNECTION OPTIONS
258258
Parameters to connect PostgreSQL server.
259259

260260
*-d*_DBNAME_ /*--dbname*=_DBNAME_::
@@ -287,7 +287,7 @@ Parameters to connect PostgreSQL server.
287287
if the server wants a password. In some cases it is worth typing -W
288288
to avoid the extra connection attempt.
289289

290-
=== GLOBAL OPTIONS===
290+
###GLOBAL OPTIONS
291291

292292
*--help*::
293293
Print help, then exit.
@@ -298,7 +298,7 @@ Parameters to connect PostgreSQL server.
298298
*-v* /*--verbose*::
299299
If specified, pg_arman works in verbose mode.
300300

301-
== PARAMETERS==
301+
##PARAMETERS
302302

303303
Some of parameters can be specified as command line arguments, environment
304304
variables or in configuration file as follows:
@@ -331,7 +331,7 @@ line and configuration file for security reason.
331331
This utility, like most other PostgreSQL utilities, also uses the
332332
environment variables supported by libpq (see Environment Variables).
333333

334-
== RESTRICTIONS==
334+
##RESTRICTIONS##
335335

336336
pg_arman has the following restrictions.
337337

@@ -344,26 +344,26 @@ pg_arman has the following restrictions.
344344
WAL directory or archived WAL directory, the backup or restore will fail
345345
depending on the backup mode selected.
346346

347-
== DETAILS==
347+
##DETAILS##
348348

349-
=== RECOVERY TO POINT-IN-TIME===
349+
###RECOVERY TO POINT-IN-TIME
350350
pg_arman can recover to point-in-time if timeline, transaction ID, or
351351
timestamp is specified in recovery.conf. xlogdump is a contrib module of
352352
PostgreSQL core that allows checking in the content of WAL files and
353353
determine when to recover. This might help.
354354

355-
=== CONFIGURATION FILE===
355+
###CONFIGURATION FILE
356356
Setting parameters in configuration file is done as "name=value". Quotes
357357
are required if the value contains whitespaces. Comments should start with
358358
"#" and are automatically ignored. Whitespaces and tabs are ignored
359359
excluding values.
360360

361-
=== Restrictions===
361+
###Restrictions
362362
In order to work, the PostgreSQL instance on which backups are taken need
363363
to have data checksums enabled or to enable wal_log_hints. pg_arman is
364364
aimed at working with PostgreSQL 9.5 and newer versions.
365365

366-
=== EXIT CODE===
366+
###EXIT CODE
367367
pg_arman returns exit codes for each error status.
368368

369369
CodeNameDescription
@@ -372,7 +372,7 @@ pg_arman returns exit codes for each error status.
372372
2FATALExit because of repeated errors
373373
3PANICUnknown critical condition
374374

375-
== AUTHOR==
375+
##AUTHOR##
376376
pg_arman is a fork of pg_arman that was originally written by NTT, now
377377
developed and maintained by Michael Paquier.
378378

0 commit comments

Comments
 (0)
[8]ページ先頭
©2009-2025 Movatter.jp