From 639ed4e84b7493594860f56b78b25fd113e78fd7 Mon Sep 17 00:00:00 2001
From: Alvaro Herrera
Date: Fri, 22 Feb 2013 16:46:24 -0300
Subject: Add pg_xlogdump contrib program
This program relies on rm_desc backend routines and the xlogreader
infrastructure to emit human-readable rendering of WAL records.
Author: Andres Freund, with many reworks by Álvaro
Reviewed (in a much earlier version) by Peter Eisentraut
---
doc/src/sgml/contrib.sgml | 1 +
doc/src/sgml/filelist.sgml | 1 +
doc/src/sgml/pg_xlogdump.sgml | 205 +++++++++++++++++++++++++++++++++++++++
doc/src/sgml/ref/pg_isready.sgml | 2 +-
4 files changed, 208 insertions(+), 1 deletion(-)
create mode 100644 doc/src/sgml/pg_xlogdump.sgml
(limited to 'doc/src')
diff --git a/doc/src/sgml/contrib.sgml b/doc/src/sgml/contrib.sgml
index 39e9827fca7..dd8e09ed291 100644
--- a/doc/src/sgml/contrib.sgml
+++ b/doc/src/sgml/contrib.sgml
@@ -207,5 +207,6 @@ pages.
&pgtestfsync;
&pgtesttiming;
&pgupgrade;
+ &pgxlogdump;
diff --git a/doc/src/sgml/filelist.sgml b/doc/src/sgml/filelist.sgml
index 5d55ef357b0..b623f58b1a9 100644
--- a/doc/src/sgml/filelist.sgml
+++ b/doc/src/sgml/filelist.sgml
@@ -134,6 +134,7 @@
+
diff --git a/doc/src/sgml/pg_xlogdump.sgml b/doc/src/sgml/pg_xlogdump.sgml
new file mode 100644
index 00000000000..15bdfbb46c7
--- /dev/null
+++ b/doc/src/sgml/pg_xlogdump.sgml
@@ -0,0 +1,205 @@
+
+
+
+
+ pg_xlogdump
+ 1
+ Application
+
+
+
+ pg_xlogdump
+ Display a human-readable rendering of the write-ahead log of a PostgreSQL database cluster
+
+
+
+ pg_xlogdump
+
+
+
+
+ pg_xlogdump
+
+
+
+
+
+
+
+
+ Description
+
+ pg_xlogdump display 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.
+
+
+
+
+
+
+
+
+
+ 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.
+
+
+
+
+
+
+
+
+
+ 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/pg_isready.sgml b/doc/src/sgml/ref/pg_isready.sgml
index 407d73ba5bd..19ff1d4935d 100644
--- a/doc/src/sgml/ref/pg_isready.sgml
+++ b/doc/src/sgml/ref/pg_isready.sgml
@@ -12,7 +12,7 @@ PostgreSQL documentation
pg_isready
- checks the connection status of a PostgreSQL server
+ check the connection status of a PostgreSQL server
--
cgit v1.2.3