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

Commit1868223

Browse files
author
Michael Paquier
committed
Use strong text for option names and underline option values
This makes the whole documentation more readable.
1 parent26ed2bb commit1868223

File tree

1 file changed

+41
-41
lines changed

1 file changed

+41
-41
lines changed

‎doc/pg_rman.txt‎

Lines changed: 41 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -36,26 +36,26 @@ It proposes the following features:
3636

3737
== COMMANDS ==
3838

39-
pg_rman supports the following commands. See also OPTIONS for more
39+
pg_rman supports the following commands. See also*OPTIONS* for more
4040
details.
4141

42-
init::
42+
*init*::
4343
Initialize a backup catalog.
4444

45-
backup::
45+
*backup*::
4646
Take an online backup.
4747

48-
restore::
48+
*restore*::
4949
Perform restore.
5050

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

55-
validate::
55+
*validate*::
5656
Validate backup files.
5757

58-
delete::
58+
*delete*::
5959
Delete backup files.
6060

6161
=== INITIALIZATION ===
@@ -67,7 +67,7 @@ are initialized, pg_rman can adjust the config file to the setting. In this
6767
case, you have to specify the database cluster path for PostgreSQL. Please
6868
specify it in PGDATA environmental variable or -D/--pgdata option.
6969

70-
$ pg_rman init -B<a backup catalogpath>
70+
$ pg_rman init -B/path/to/backup/
7171

7272
=== BACKUP ===
7373

@@ -194,68 +194,68 @@ the specified date.
194194
== OPTIONS ==
195195

196196
pg_rman accepts the following command line parameters. Some of them can
197-
be also specified as environment variables. See also PARAMETERS for the
197+
be also specified as environment variables. See also*PARAMETERS* for the
198198
details.
199199

200200
=== COMMON OPTIONS ===
201201
As a general rule, paths for data location need to be specified as
202202
absolute paths; relative paths are not allowed.
203203

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

208-
-A PATH / --arclog-path=PATH::
208+
*-A* _PATH_ /*--arclog-path*=_PATH_::
209209
The absolute path of archive WAL directory. Required on backup
210210
and restore.
211211

212-
-S PATH / --srvlog-path=PATH::
212+
*-S* _PATH_ /*--srvlog-path*=_PATH_::
213213
The absolute path of server log directory. Required on backup with
214214
server logs and restore.
215215

216-
-B PATH / --backup-path=PATH::
216+
*-B* _PATH_ /*--backup-path*=_PATH_::
217217
The absolute path of backup catalog. This option is mandatory.
218218

219-
-c / --check::
219+
*-c* /*--check*::
220220
If specifed, pg_rman doesn't perform actual jobs but only checks
221221
parameters and required resources. The option is typically used with
222222
--verbose option to verify the operation.
223223

224-
-v / --verbose::
224+
*-v* /*--verbose*::
225225
If specified, pg_rman works in verbose mode.
226226

227227
=== BACKUP OPTIONS ===
228228

229-
-b { full | incremental | archive } /--backup-mode={ full | incremental | archive }::
230-
Specify backup target files. Available options are: "full" backup,
231-
"incremental"backup,and "archive" backup. Abbreviated forms
232-
(prefix match) are also available. For example, -b f means "full"
233-
backup.
229+
*-b* _BACKUPMODE_ / *--backup-mode*=_BACKUPMODE_::
230+
Specify backup target files. Available options are: "full",
231+
"incremental" and "archive".
232+
Abbreviated forms(prefix match) are also available. For example,
233+
-b f means "full"backup.
234234

235-
-s / --with-serverlog::
235+
*-s* /*--with-serverlog*::
236236
Backup server log files if specified.
237237

238-
-Z / --compress-data::
238+
*-Z* /*--compress-data*::
239239
Compress backup files with zlib if specified.
240240

241-
-C / --smooth-checkpoint::
241+
*-C* /*--smooth-checkpoint*::
242242
Checkpoint is performed on every backups. If the option is specified,
243243
do smooth checkpoint then. See also the second argument for
244244
pg_start_backup().
245245

246-
--keep-data-generations / --keep-data-days::
246+
*--keep-data-generations*=_NUMBER_ /*--keep-data-days*=_DAYS_::
247247
Specify how long backuped data files will be kept.
248248
--keep-data-generations means number of backup generations.
249249
--keep-data-days means days to be kept.
250250
Only files exceeded one of those settings are deleted.
251251

252-
--keep-arclog-files / --keep-arclog-days::
252+
*--keep-arclog-files*=_NUMBER_ /*--keep-arclog-days*=_DAYS_::
253253
Specify how long backuped archive WAL files will be kept.
254254
--keep-arclog-files means number of backup files.
255255
--keep-arclog-days means days to be kept. When backup is run, only
256256
files exceeded one of those settings are deleted from archive storage.
257257

258-
--keep-srvlog-files / --keep-srvlog-days::
258+
*--keep-srvlog-files*=_NUMBER_ /*--keep-srvlog-days*=_DAYS_::
259259
Specify how long backuped serverlog files will be kept.
260260
--keep-srvlog-files means number of backup files.
261261
--keep-srvlog-days means days to be kept.
@@ -269,57 +269,57 @@ absolute paths; relative paths are not allowed.
269269
The parameters whose name start are started with --recovery refer to
270270
the same parameters as the ones in recovery.confin recovery.conf.
271271

272-
--recovery-target-timeline TIMELINE::
272+
*--recovery-target-timeline*=_TIMELINE_::
273273
Specifies recovering into a particular timeline.
274274
If not specified, the current timeline is used.
275275

276-
--recovery-target-time TIMESTAMP::
276+
*--recovery-target-time*=_TIMESTAMP_::
277277
This parameter specifies the timestamp up to which recovery will
278278
proceed.
279279

280-
--recovery-target-xid XID::
280+
*--recovery-target-xid*=_XID::
281281
This parameter specifies the transaction ID up to which recovery
282282
will proceed.
283283

284-
--recovery-target-inclusive::
284+
*--recovery-target-inclusive*::
285285
Specifies whether server pauses when recovery target is reached.
286286

287-
--hard-copy::
287+
*--hard-copy*::
288288
Archived WAL files are copied to archive WAL storage area. If you
289289
do not specify --hard-copy, pg_rman makes symlink to archive WAL
290290
where are in the backup catalog directory.
291291

292292
=== CATALOG OPTIONS ===
293293

294-
-a / --show-all::
294+
*-a* /*--show-all*::
295295
Show all existing backups, including the deleted ones.
296296

297297
=== CONNECTION OPTIONS ===
298298
Parameters to connect PostgreSQL server.
299299

300-
-d DBNAME / --dbname=DBNAME::
300+
*-d* _DBNAME_ /*--dbname*=_DBNAME_::
301301
The database name to execute pg_start_backup() and pg_stop_backup().
302302

303-
-h HOSTNAME / --host=HOSTNAME::
303+
*-h* _HOSTNAME_ /*--host*=_HOSTNAME_::
304304
Specifies the host name of the machine on which the server is running.
305305
If the value begins with a slash, it is used as the directory for the
306306
Unix domain socket.
307307

308-
-p PORT / --port=PORT::
308+
*-p* _PORT_ /*--port*=_PORT_::
309309
Specifies the TCP port or local Unix domain socket file extension on
310310
which the server is listening for connections.
311311

312-
-U USERNAME / --username=USERNAME::
312+
*-U* _USERNAME_ /*--username*=_USERNAME_::
313313
User name to connect as.
314314

315-
-w / --no-password::
315+
*-w* /*--no-password*::
316316
Never issue a password prompt. If the server requires password
317317
authentication and a password is not available by other means such as
318318
a .pgpass file, the connection attempt will fail. This option can be
319319
useful in batch jobs and scripts where no user is present to enter a
320320
password.
321321

322-
-W / --password::
322+
*-W* /*--password*::
323323
Force pg_rman to prompt for a password before connecting to a database.
324324
This option is never essential, since pg_rman will automatically
325325
prompt for a password if the server demands password authentication.
@@ -329,13 +329,13 @@ Parameters to connect PostgreSQL server.
329329

330330
=== GLOBAL OPTIONS ===
331331

332-
--help::
332+
*--help*::
333333
Print help, then exit.
334334

335-
-V / --version::
335+
*-V* /*--version*::
336336
Print version information, then exit.
337337

338-
-! / --debug::
338+
*-!* /*--debug*::
339339
Show debug information.
340340

341341
== PARAMETERS ==

0 commit comments

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