summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMark Wong <mark@2ndQuadrant.com>2019-06-27 01:33:40 +0000
committerMark Wong <mark@2ndQuadrant.com>2019-06-27 01:34:30 +0000
commit86f51a826d8e2da5a01302a3f97081d5d27c72b2 (patch)
treecedc221b790620d91233eab21ad23e644e6ee576
parent901f7ad18b1f07ef3ae7ebd4cf8afe41eea5fffe (diff)
Update documentationtest
Lots of various updates: * Removed FAQ, mostly covered by README * Updated manpage * Updated INSTALL * Updated README
-rw-r--r--FAQ91
-rw-r--r--INSTALL10
-rw-r--r--README30
-rw-r--r--pg_top.1.in134
4 files changed, 90 insertions, 175 deletions
diff --git a/FAQ b/FAQ
deleted file mode 100644
index 5977311..0000000
--- a/FAQ
+++ /dev/null
@@ -1,91 +0,0 @@
- pg_top
- Version 3.7.0
-
-
- Frequently Asked Questions and their Answers
-
-
-
- GENERAL
-
- 1. What is pg_top?
-
- pg_top is 'top' for PostgreSQL. It is derived from Unix Top. Similar to top,
- pg_top allows you to monitor PostgreSQL processes. It also allows you to:
-
- * View currently running SQL statement of a process.
- * View query plan of a currently running SELECT statement.
- * View locks held by a process.
-
- 2. Where do I get the latest version of pg_top?
-
- If you have git, you can checkout the latest at:
-
- git clone git://git.postgresql.org/git/pg_top.git
-
- 3. Is there a web page for pg_top?
-
- http://ptop.projects.postgresql.org/
-
- 4. Is there a mailing list or on-line bulletin board for pg_top?
-
- Subscribe or browse the archives of ptop-hackers at:
-
- http://lists.pgfoundry.org/mailman/listinfo/ptop-hackers
-
- 5. What about Y2K/Year 2038 compliance?
-
- A full statement concerning top and the year 2000 can be found in the file
- "Y2K" included with the distribution.
-
- 6. Will there be another major release of pg_top? Will there be a pg_top
- version 4?
-
- We hope so! Depends on how much fun we have. :)
-
- 7. We just upgraded our operating system to a new version and pg_top broke.
- What should we do?
-
- Recompile it. pg_top is very sensitive to changes in internal kernel
- data structures. It is not uncommon for a new version of the
- operating system to include changes to kernel data structures.
-
-
- RUNNING
-
- 8. I just finished compiling top and it works fine for root, but when I
- try to run it as a regular user it either complains about files it
- can't open or it doesn't display all the information it should. Did I
- do something wrong?
-
- Well, you're just not done. On many operating systems today, access
- to many of the kernel memory devices and other system files is
- restricted to either root or a particular group. The configure script
- figures this out (usually) and makes sure that the "install" rule in
- the Makefile will install top so that anyone can run it successfully.
- However, you have to *install* it first. Do this with the command
- "make install".
-
- 9. pg_top is (not) displaying idle processes and I don't (do) want it to.
-
- This default has only changed about a dozen times, and I finally got
- tired of people whining about it. Go read the manual page for the
- current version and pay special attention to the description of the
- "PG_TOP" environment variable.
-
-10. The cpu state percentages are all wrong, indicating that my machine
- is using 95% system time when it is clearly idle. What's wrong?
-
- This can happen if you compiled with gcc using the wrong include
- files. See the previous question.
-
-
- STILL STUCK
-
-11. I'm still stuck. To whom do I report problems with top?
-
- If after reading all of this file and checking everything you can you
- are still stuck, then please refer to the mailing to ask further
- questions:
-
- http://lists.pgfoundry.org/mailman/listinfo/ptop-hackers
diff --git a/INSTALL b/INSTALL
index 08016d1..918acb8 100644
--- a/INSTALL
+++ b/INSTALL
@@ -1,8 +1,4 @@
pg_top
- Version 4.0.0
-
- Mark Wong
- and a cast of ... a few
INSTALLATION
@@ -23,12 +19,6 @@ options:
display. Use -DENABLE_COLOR=0 if you do not want this feature compiled in
to the code. The configure script also recognizes the spelling "colour".
- -DENABLE_COLOR=0
-
- Default on. Include code that allows for the use of color in the output
- display. Use -DENABLE_COLOR=0 if you do not want this feature compiled in
- to the code. The configure script also recognizes the spelling "colour".
-
Installing
----------
diff --git a/README b/README
index 04d3a8a..87db9ee 100644
--- a/README
+++ b/README
@@ -1,9 +1,4 @@
- pg_top
- Version 3.7.0
-
- Mark Wong
- and a cast of ... a few
-
+ pg_top
pg_top is 'top' for PostgreSQL. It is derived from Unix Top. Similar to top,
pg_top allows you to monitor PostgreSQL processes. It also allows you to:
@@ -17,29 +12,29 @@ directions and advice contained therein.
If you make any kind of change to "pg_top" that you feel would be
beneficial to others who use this program, or if you find and fix a bug,
-please send the change to the pg_top mailing list.
+please submit the change to the pg_top issue tracker:
+
+ https://gitlab.com/pg_top/pg_top/issues
+
In order to monitor a remote database, the pg_proctab extension needs to be
created on the database to be monitored. Any operating system that pg_proctab
supports can be monitored remotely on any operating system. See details for
-pg_protab here:
-
-http://pgxn.org/dist/pg_proctab/
+pg_proctab here:
-Be sure to read the FAQ enclosed with the distrubution. It contains
-answers to the most commonly asked questions about the configuration,
-installation, and operation of pg_top.
+ https://gitlab.com/pg_top/pg_proctab
AVAILABILITY
Project home page:
-http://ptop.projects.postgresql.org/
+ https://pg_top.gitlab.io/
+
If you have git, you can download the source code:
-git clone git://git.postgresql.org/git/pg_top.git
+ git clone git://git.postgresql.org/git/pg_top.git
LOGO
@@ -59,8 +54,3 @@ LICENSE
pg_top is distributed free of charge under the same terms as the BSD
license. For an official statement, please refer to the file "LICENSE"
which should be included with the source distribution.
-
-
-AUTHOR
-
-Mark Wong
diff --git a/pg_top.1.in b/pg_top.1.in
index 2306183..9886063 100644
--- a/pg_top.1.in
+++ b/pg_top.1.in
@@ -46,31 +46,28 @@ is redirected to a file, it acts as if it were being run on a dumb
terminal.
.SH OPTIONS
.TP
-.B \-C, \-\-color-mode
-Turn off the use of color in the display.
-.TP
-.B \-I, \-\-hide-idle
-Do not display idle processes.
-By default, pg_top displays both active and idle processes.
-.TP
-.B \-T, \-\-show-tags
-List all available color tags and the current set of tests used for
-color highlighting, then exit.
-.TP
-.B \-W, \-\-password
-Forces pg_top to prompt for a password before connecting to a database. pg_top
-will also keep the database connection open while running, and will clear the
-database connection from memory for security.
-.TP
.B \-b, \-\-batch
Use \*(lqbatch\*(rq mode. In this mode, all input from the terminal is
ignored. Interrupt characters (such as ^C and ^\e) still have an effect.
This is the default on a dumb terminal, or when the output is not a terminal.
.TP
+.B \-C, \-\-color-mode
+Turn off the use of color in the display.
+.TP
.B \-c, \-\-show-command
Show the command name for each process. Default is to show the full
command line. This option is not supported on all platforms.
.TP
+\fB\-h \fR\fB\fIHOST\fR\fR, \fB\-\-host=\fR\fB\fIHOST\fR\fR
+Specifies the host name of the machine on which the server is running. If
+the value begins with a slash, it is used as the directory for the Unix
+domain socket. The default is taken from the PGHOST environment variable,
+if set.
+.TP
+.B \-I, \-\-hide-idle
+Do not display idle processes.
+By default, pg_top displays both active and idle processes.
+.TP
.B \-i, \-\-interactive
Use \*(lqinteractive\*(rq mode. In this mode, any input is immediately
read for processing. See the section on \*(lqInteractive Mode\*(rq
@@ -84,29 +81,57 @@ intelligent terminal.
Use \*(lqnon-interactive\*(rq mode. This is indentical to \*(lqbatch\*(rq
mode.
.TP
+\fB\-o \fR\fB\fIFIELD\fR\fR, \fB\-\-order-field=\fR\fB\fIFIELD\fR\fR
+Sort the process display area on the specified field. The field name is
+the name of the column as seen in the output, but in lower case. Likely
+values are \*(lqcpu\*(rq, \*(lqsize\*(rq, \*(lqres\*(rq, \*(lqxtime\*(rq and
+\*(lqqtime\*(rq, but may vary on different operating systems. Note that not
+all operating systems support this option.
+.TP
+\fB\-p \fR\fB\fIPORT\fR\fR, \fB\-\-port=\fR\fB\fIPORT\fR\fR
+Specifies the TCP port or local Unix domain socket file extension on which
+the server is listening for connections. Defaults to the PGPORT environment
+variable, if set.
+.TP
+\fB\-R
+Display WAL sender processes' replication activity to connected standy servers.
+Only directly connected standbys are listed; no information is available about
+downstream standby servers.
+.TP
.B \-r, \-\-remote-mode
Monitor a remote database where the database is on a system other than where
pg_top is running from.
.I pg_top
will monitor a remote database if it has the pg_proctab extension installed.
.TP
-.B \-V, \-\-version
-Write version number information to stderr then exit immediately.
-No other processing takes place when this option is used. To see current
-revision information while pg_top is running, use the help command \*(lq?\*(rq.
-.TP
\fB\-s \fR\fB\fITIME\fR\fR, \fB\-\-set-delay=\fR\fB\fITIME\fR\fR
.I TIME
Set the delay between screen updates to
.I TIME
seconds. The default delay between updates is \nD seconds.
.TP
-\fB\-o \fR\fB\fIFIELD\fR\fR, \fB\-\-order-field=\fR\fB\fIFIELD\fR\fR
-Sort the process display area on the specified field. The field name is
-the name of the column as seen in the output, but in lower case. Likely
-values are \*(lqcpu\*(rq, \*(lqsize\*(rq, \*(lqres\*(rq, \*(lqxtime\*(rq and
-\*(lqqtime\*(rq, but may vary on different operating systems. Note that not
-all operating systems support this option.
+.B \-T, \-\-show-tags
+List all available color tags and the current set of tests used for
+color highlighting, then exit.
+.TP
+\fB\-U \fR\fB\fIUSERNAME\fR\fR, \fB\-\-username=\fR\fB\fIUSERNAME\fR\fR
+User name to connect as.
+.TP
+.B \-V, \-\-version
+Write version number information to stderr then exit immediately.
+No other processing takes place when this option is used. To see current
+revision information while pg_top is running, use the help command \*(lq?\*(rq.
+.TP
+.B \-W, \-\-password
+Forces pg_top to prompt for a password before connecting to a database. pg_top
+will also keep the database connection open while running, and will clear the
+database connection from memory for security.
+.TP
+\fB\-X
+Display I/O activity per process. This depends on whether the platform pg_top
+is run on supports getting I/O statistics per process, or whether the database
+system that pg_proctab is installed on supports getting I/O statistics when
+pg_top attempts to get operating system statistics remotely.
.TP
\fB\-x \fR\fB\fICOUNT\fR\fR, \fB\-\-set-display=\fR\fB\fICOUNT\fR\fR
Show only
@@ -122,31 +147,6 @@ is set. The default is 1 for dumb terminals.
Show only those processes owned by
.IR USERNAME .
This option currently only accepts usernames.
-.TP
-\fB\-h \fR\fB\fIHOST\fR\fR, \fB\-\-host=\fR\fB\fIHOST\fR\fR
-Specifies the host name of the machine on which the server is running. If
-the value begins with a slash, it is used as the directory for the Unix
-domain socket. The default is taken from the PGHOST environment variable,
-if set.
-.TP
-\fB\-p \fR\fB\fIPORT\fR\fR, \fB\-\-port=\fR\fB\fIPORT\fR\fR
-Specifies the TCP port or local Unix domain socket file extension on which
-the server is listening for connections. Defaults to the PGPORT environment
-variable, if set.
-.TP
-\fB\-U \fR\fB\fIUSERNAME\fR\fR, \fB\-\-username=\fR\fB\fIUSERNAME\fR\fR
-User name to connect as.
-.TP
-\fB\-R
-Display WAL sender processes' replication activity to connected standy servers.
-Only directly connected standbys are listed; no information is available about
-downstream standby servers.
-.TP
-\fB\-X
-Display I/O activity per process. This depends on whether the platform pg_top
-is run on supports getting I/O statistics per process, or whether the database
-system that pg_proctab is installed on supports getting I/O statistics when
-pg_top attempts to get operating system statistics remotely.
.PP
Both
.I COUNT
@@ -236,8 +236,6 @@ Display re-determined execution plan (EXPLAIN) of the SQL statement by a
backend process (prompt for process id.)
.TP
.B i
-(or
-.BR I )
Toggle the display of idle processes.
.TP
.B L
@@ -330,6 +328,34 @@ Number of locks granted to this process.
.TP
.B COMMAND
Name of the command that the process is currently running.
+.SH I/O DISPLAY (Linux only)
+.TP
+.B PID
+The process id.
+.TP
+.B RCHAR
+Number of bytes read from cache or storage.
+.TP
+.B WCHAR
+Number of bytes written to cache or storage.
+.TP
+.B SYSCR
+Count the number of read I/O operations.
+.TP
+.B SYSCW
+Count the number of write I/O operations.
+.TP
+.B READS
+Number of bytes read from storage.
+.TP
+.B WRITES
+Number of bytes wriiten to storage.
+.TP
+.B CWRITES
+The number of bytes which this process caused to not happen.
+.TP
+.B COMMAND
+Name of the command that the process is currently running.
.SH REPLICATION DISPLAY
.TP
.B PID