From b0a738f428ca4e52695c0f019c1560c64cc59aef Mon Sep 17 00:00:00 2001 From: Peter Eisentraut Date: Tue, 10 Mar 2015 22:33:24 -0400 Subject: Move pg_xlogdump from contrib/ to src/bin/ Reviewed-by: Michael Paquier --- doc/src/sgml/contrib.sgml | 1 - doc/src/sgml/filelist.sgml | 1 - doc/src/sgml/pg_xlogdump.sgml | 228 -------------------------------------- doc/src/sgml/ref/allfiles.sgml | 1 + doc/src/sgml/ref/pg_xlogdump.sgml | 228 ++++++++++++++++++++++++++++++++++++++ doc/src/sgml/reference.sgml | 1 + 6 files changed, 230 insertions(+), 230 deletions(-) delete mode 100644 doc/src/sgml/pg_xlogdump.sgml create mode 100644 doc/src/sgml/ref/pg_xlogdump.sgml (limited to 'doc/src') diff --git a/doc/src/sgml/contrib.sgml b/doc/src/sgml/contrib.sgml index 29e4f2df9b5..49a6ce8b0b6 100644 --- a/doc/src/sgml/contrib.sgml +++ b/doc/src/sgml/contrib.sgml @@ -202,6 +202,5 @@ pages. &pgstandby; - &pgxlogdump; diff --git a/doc/src/sgml/filelist.sgml b/doc/src/sgml/filelist.sgml index 2f4896d4ce3..26aa7ee50ee 100644 --- a/doc/src/sgml/filelist.sgml +++ b/doc/src/sgml/filelist.sgml @@ -134,7 +134,6 @@ - diff --git a/doc/src/sgml/pg_xlogdump.sgml b/doc/src/sgml/pg_xlogdump.sgml deleted file mode 100644 index d9f4a6a499c..00000000000 --- a/doc/src/sgml/pg_xlogdump.sgml +++ /dev/null @@ -1,228 +0,0 @@ - - - - - pg_xlogdump - - - - pg_xlogdump - 1 - Application - - - - pg_xlogdump - Display a human-readable rendering of the write-ahead log of a PostgreSQL database cluster - - - - - pg_xlogdump - - - - - - - - - Description - - pg_xlogdump displays the write-ahead log (WAL) and is mainly - useful for debugging or educational purposes. - - - - This utility can only be run by the user who installed the server, because - it requires read-only access to the data directory. - - - - - Options - - - The following command-line options control the location and format of the - output: - - - - - startseg - - - Start reading at the specified log segment file. This implicitly determines - the path in which files will be searched for, and the timeline to use. - - - - - - endseg - - - Stop after reading the specified log segment file. - - - - - - - - - - Output detailed information about backup blocks. - - - - - - - - - - Stop reading at the specified log position, instead of reading to the - end of the log stream. - - - - - - - - - - After reaching the end of valid WAL, keep polling once per second for - new WAL to appear. - - - - - - - - - - Display the specified number of records, then stop. - - - - - - - - - - Directory in which to find log segment files. The default is to search - for them in the pg_xlog subdirectory of the current - directory. - - - - - - - - - - Only display records generated by the specified resource manager. - If list is passed as name, print a list of valid resource manager - names, and exit. - - - - - - - - - - Log position at which to start reading. The default is to start reading - the first valid log record found in the earliest file found. - - - - - - - - - - Timeline from which to read log records. The default is to use the - value in startseg, if that is specified; otherwise, the - default is 1. - - - - - - - - - - Print the pg_xlogdump version and exit. - - - - - - - - - - Only display records marked with the given TransactionId. - - - - - - - - - - Display summary statistics (number and size of records and - full-page images) instead of individual records. Optionally - generate statistics per-record instead of per-rmgr. - - - - - - - - - - Show help about pg_xlogdump command line - arguments, and exit. - - - - - - - - - Notes - - Can give wrong results when the server is running. - - - - Only the specified timeline is displayed (or the default, if none is - specified). Records in other timelines are ignored. - - - - - See Also - - - - - - - diff --git a/doc/src/sgml/ref/allfiles.sgml b/doc/src/sgml/ref/allfiles.sgml index 0e0a1f4f462..f09fc250f08 100644 --- a/doc/src/sgml/ref/allfiles.sgml +++ b/doc/src/sgml/ref/allfiles.sgml @@ -196,6 +196,7 @@ Complete list of usable sgml source files in this directory. + diff --git a/doc/src/sgml/ref/pg_xlogdump.sgml b/doc/src/sgml/ref/pg_xlogdump.sgml new file mode 100644 index 00000000000..d9f4a6a499c --- /dev/null +++ b/doc/src/sgml/ref/pg_xlogdump.sgml @@ -0,0 +1,228 @@ + + + + + pg_xlogdump + + + + pg_xlogdump + 1 + Application + + + + pg_xlogdump + Display a human-readable rendering of the write-ahead log of a PostgreSQL database cluster + + + + + pg_xlogdump + + + + + + + + + Description + + pg_xlogdump displays the write-ahead log (WAL) and is mainly + useful for debugging or educational purposes. + + + + This utility can only be run by the user who installed the server, because + it requires read-only access to the data directory. + + + + + Options + + + The following command-line options control the location and format of the + output: + + + + + startseg + + + Start reading at the specified log segment file. This implicitly determines + the path in which files will be searched for, and the timeline to use. + + + + + + endseg + + + Stop after reading the specified log segment file. + + + + + + + + + + Output detailed information about backup blocks. + + + + + + + + + + Stop reading at the specified log position, instead of reading to the + end of the log stream. + + + + + + + + + + After reaching the end of valid WAL, keep polling once per second for + new WAL to appear. + + + + + + + + + + Display the specified number of records, then stop. + + + + + + + + + + Directory in which to find log segment files. The default is to search + for them in the pg_xlog subdirectory of the current + directory. + + + + + + + + + + Only display records generated by the specified resource manager. + If list is passed as name, print a list of valid resource manager + names, and exit. + + + + + + + + + + Log position at which to start reading. The default is to start reading + the first valid log record found in the earliest file found. + + + + + + + + + + Timeline from which to read log records. The default is to use the + value in startseg, if that is specified; otherwise, the + default is 1. + + + + + + + + + + Print the pg_xlogdump version and exit. + + + + + + + + + + Only display records marked with the given TransactionId. + + + + + + + + + + Display summary statistics (number and size of records and + full-page images) instead of individual records. Optionally + generate statistics per-record instead of per-rmgr. + + + + + + + + + + Show help about pg_xlogdump command line + arguments, and exit. + + + + + + + + + Notes + + Can give wrong results when the server is running. + + + + Only the specified timeline is displayed (or the default, if none is + specified). Records in other timelines are ignored. + + + + + See Also + + + + + + + diff --git a/doc/src/sgml/reference.sgml b/doc/src/sgml/reference.sgml index a526638ec9b..c52eb28c8c4 100644 --- a/doc/src/sgml/reference.sgml +++ b/doc/src/sgml/reference.sgml @@ -266,6 +266,7 @@ &pgtestfsync; &pgtesttiming; &pgupgrade; + &pgxlogdump; &postgres; &postmaster; -- cgit v1.2.3