Increment version number to 1.3.0 and documentation updates.

dalibo · Nov 26, 2015 · 5562470 · 5562470
1 parent 93be692
commit 5562470
Show file tree

Hide file tree

Showing 5 changed files with 89 additions and 44 deletions.
diff --git a/docs/man/build-man.sh b/docs/man/build-man.sh
@@ -1,3 +1,3 @@
 #!/bin/bash
 
-pod2man -r "pg_activity 1.3.0 dev" -d `date +%Y-%m-%d` -c "PostgreSQL server activity monitoring tool" pg_activity.pod > pg_activity.1;
+pod2man -r "pg_activity 1.3.0" -d `date +%Y-%m-%d` -c "Command line tool for PostgreSQL server activity monitoring." pg_activity.pod > pg_activity.1;
diff --git a/docs/man/pg_activity.1 b/docs/man/pg_activity.1
@@ -1,4 +1,4 @@
-.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16)
+.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28)
 .\"
 .\" Standard preamble:
 .\" ========================================================================
@@ -38,6 +38,8 @@
 .    ds PI \(*p
 .    ds L" ``
 .    ds R" ''
+.    ds C`
+.    ds C'
 'br\}
 .\"
 .\" Escape single quotes in literal strings from groff's Unicode transform.
@@ -48,17 +50,24 @@
 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
 .\" entries marked with X<> in POD.  Of course, you'll have to process the
 .\" output yourself in some meaningful fashion.
-.ie \nF \{\
-.    de IX
-.    tm Index:\\$1\t\\n%\t"\\$2"
+.\"
+.\" Avoid warning from groff about undefined register 'F'.
+.de IX
 ..
-.    nr % 0
-.    rr F
-.\}
-.el \{\
-.    de IX
+.nr rF 0
+.if \n(.g .if rF .nr rF 1
+.if (\n(rF:(\n(.g==0)) \{
+.    if \nF \{
+.        de IX
+.        tm Index:\\$1\t\\n%\t"\\$2"
 ..
+.        if !\nF==2 \{
+.            nr % 0
+.            nr F 2
+.        \}
+.    \}
 .\}
+.rr rF
 .\"
 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
@@ -124,19 +133,19 @@
 .\" ========================================================================
 .\"
 .IX Title "PG_ACTIVITY 1"
-.TH PG_ACTIVITY 1 "2014-06-18" "pg_activity 1.2.0" "PostgreSQL server activity monitoring tool"
+.TH PG_ACTIVITY 1 "2015-11-26" "pg_activity 1.3.0" "Command line tool for PostgreSQL server activity monitoring."
 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 .\" way too many mistakes in technical documents.
 .if n .ad l
 .nh
 .SH "NAME"
-pg_activity \- Realtime PostgreSQL database server monitoring tool
+pg_activity
 .SH "SYNOPSIS"
 .IX Header "SYNOPSIS"
-\&\fBpg_activity\fR [\-UphdC]
+\&\fBpg_activity\fR [option..]
 .SH "DESCRIPTION"
 .IX Header "DESCRIPTION"
-pg_activity is a htop like application for PostgreSQL server activity monitoring.
+Command line tool for PostgreSQL server activity monitoring.
 .SH "COMMAND-LINE OPTIONS"
 .IX Header "COMMAND-LINE OPTIONS"
 .IP "\fB\-U \s-1USERNAME\s0\fR, \fB\-\-username=USERNAME\fR" 2
@@ -169,6 +178,11 @@ pg_activity is a htop like application for PostgreSQL server activity monitoring
 .Vb 1
 \&        Filesystem blocksize (default: 4096).
 .Ve
+.IP "\fB\-\-rds\fR" 2
+.IX Item "--rds"
+.Vb 1
+\&        Enable support for AWS RDS.
+.Ve
 .IP "\fB\-\-help\fR" 2
 .IX Item "--help"
 .Vb 1
@@ -184,7 +198,22 @@ pg_activity is a htop like application for PostgreSQL server activity monitoring
 .IP "\fB\s-1PGPASSWORD\s0\fR" 2
 .IX Item "PGPASSWORD"
 .Vb 1
-\&    PostgreSQL password
+\&    PostgreSQL password.
+.Ve
+.IP "\fB\s-1PGPORT\s0\fR" 2
+.IX Item "PGPORT"
+.Vb 1
+\&        Database server port.
+.Ve
+.IP "\fB\s-1PGUSER\s0\fR" 2
+.IX Item "PGUSER"
+.Vb 1
+\&        Database user name.
+.Ve
+.IP "\fB\s-1PGHOST\s0\fR" 2
+.IX Item "PGHOST"
+.Vb 1
+\&        Database server host or socket directory.
 .Ve
 .IP "\fB\s-1PGPASSFILE\s0\fR" 2
 .IX Item "PGPASSFILE"
@@ -241,59 +270,59 @@ pg_activity is a htop like application for PostgreSQL server activity monitoring
 .SH "INTERACTIVE COMMANDS"
 .IX Header "INTERACTIVE COMMANDS"
 .IP "\fBC\fR     Activate/deactivate colors." 2
-.IX Item "C     Activate/deactivate colors."
+.IX Item "C Activate/deactivate colors."
 .PD 0
 .IP "\fBr\fR     Sort by READ/s, descending." 2
-.IX Item "r     Sort by READ/s, descending."
+.IX Item "r Sort by READ/s, descending."
 .IP "\fBw\fR     Sort by WRITE/s, descending." 2
-.IX Item "w     Sort by WRITE/s, descending."
+.IX Item "w Sort by WRITE/s, descending."
 .IP "\fBc\fR     Sort by CPU%, descending." 2
-.IX Item "c     Sort by CPU%, descending."
+.IX Item "c Sort by CPU%, descending."
 .IP "\fBm\fR     Sort by MEM%, descending." 2
-.IX Item "m     Sort by MEM%, descending."
-.IP "\fBt\fR     Sort by \s-1TIME+\s0, descending." 2
-.IX Item "t     Sort by TIME+, descending."
+.IX Item "m Sort by MEM%, descending."
+.IP "\fBt\fR     Sort by \s-1TIME+,\s0 descending." 2
+.IX Item "t Sort by TIME+, descending."
 .IP "\fBSpace\fR Pause on/off." 2
 .IX Item "Space Pause on/off."
 .IP "\fBv\fR     Change queries display mode: full, truncated, indented" 2
-.IX Item "v     Change queries display mode: full, truncated, indented"
-.IP "\fB\s-1UP\s0 / \s-1DOWN\s0\fR Scroll process list." 2
+.IX Item "v Change queries display mode: full, truncated, indented"
+.IP "\fB\s-1UP / DOWN\s0\fR Scroll process list." 2
 .IX Item "UP / DOWN Scroll process list."
 .IP "\fBq\fR     Quit" 2
-.IX Item "q     Quit"
+.IX Item "q Quit"
 .IP "\fB+\fR     Increase refresh time. Maximum value : 3s" 2
-.IX Item "+     Increase refresh time. Maximum value : 3s"
+.IX Item "+ Increase refresh time. Maximum value : 3s"
 .IP "\fB\-\fR     Decrease refesh time. Minimum Value : 1s" 2
-.IX Item "-     Decrease refesh time. Minimum Value : 1s"
+.IX Item "- Decrease refesh time. Minimum Value : 1s"
 .IP "\fBF1/1\fR  Running queries monitoring." 2
-.IX Item "F1/1  Running queries monitoring."
+.IX Item "F1/1 Running queries monitoring."
 .IP "\fBF2/2\fR  Waiting queries monitoring." 2
-.IX Item "F2/2  Waiting queries monitoring."
+.IX Item "F2/2 Waiting queries monitoring."
 .IP "\fBF3/3\fR  Blocking queries monitoring." 2
-.IX Item "F3/3  Blocking queries monitoring."
+.IX Item "F3/3 Blocking queries monitoring."
 .IP "\fBh\fR     Help page." 2
-.IX Item "h     Help page."
+.IX Item "h Help page."
 .IP "\fBR\fR     Refresh." 2
-.IX Item "R     Refresh."
+.IX Item "R Refresh."
 .PD
 .SH "NAVIGATION MODE"
 .IX Header "NAVIGATION MODE"
 .IP "\fB\s-1UP\s0\fR    Move up the cursor." 2
-.IX Item "UP    Move up the cursor."
+.IX Item "UP Move up the cursor."
 .PD 0
 .IP "\fB\s-1DOWN\s0\fR  Move down the cursor." 2
-.IX Item "DOWN  Move down the cursor."
+.IX Item "DOWN Move down the cursor."
 .IP "\fBk\fR     Terminate the current backend/tagged backends." 2
-.IX Item "k     Terminate the current backend/tagged backends."
+.IX Item "k Terminate the current backend/tagged backends."
 .IP "\fBSpace\fR Tag or untag the process." 2
 .IX Item "Space Tag or untag the process."
 .IP "\fBq\fR     Quit." 2
-.IX Item "q     Quit."
+.IX Item "q Quit."
 .IP "\fBOther\fR Back to activity." 2
 .IX Item "Other Back to activity."
 .PD
 .SH "EXAMPLES"
 .IX Header "EXAMPLES"
-PGPASSWORD='mypassword' pg_activity \-U pgadmin \-h 127.0.0.1 \-\-no\-client \-C
+PGPASSWORD='mypassword' pg_activity \-U pgadmin \-h 127.0.0.1 \-\-no\-client
 .PP
 pg_activity \-h /tmp
diff --git a/docs/man/pg_activity.pod b/docs/man/pg_activity.pod
@@ -1,14 +1,14 @@
 =head1 NAME
 
-pg_activity - Realtime PostgreSQL database server monitoring tool
+pg_activity
 
 =head1 SYNOPSIS
 
-B<pg_activity> [-UphdC]
+B<pg_activity> [option..]
 
 =head1 DESCRIPTION
 
-pg_activity is a htop like application for PostgreSQL server activity monitoring.
+Command line tool for PostgreSQL server activity monitoring.
 
 =head1 COMMAND-LINE OPTIONS
 
@@ -38,6 +38,10 @@ pg_activity is a htop like application for PostgreSQL server activity monitoring
 
 	Filesystem blocksize (default: 4096).
 
+=item B<--rds>
+
+	Enable support for AWS RDS.
+
 =item B<--help>
 
 	Show this help message and exit.
@@ -54,7 +58,19 @@ pg_activity is a htop like application for PostgreSQL server activity monitoring
 
 =item B<PGPASSWORD>
 
-    PostgreSQL password
+    PostgreSQL password.
+
+=item B<PGPORT>
+
+	Database server port.
+
+=item B<PGUSER>
+
+	Database user name.
+
+=item B<PGHOST>
+
+	Database server host or socket directory.
 
 =item B<PGPASSFILE>
 
@@ -164,7 +180,7 @@ pg_activity is a htop like application for PostgreSQL server activity monitoring
 
 =head1 EXAMPLES
 
-PGPASSWORD='mypassword' pg_activity -U pgadmin -h 127.0.0.1 --no-client -C
+PGPASSWORD='mypassword' pg_activity -U pgadmin -h 127.0.0.1 --no-client
 
 pg_activity -h /tmp
 

diff --git a/pg_activity b/pg_activity
@@ -26,7 +26,7 @@ SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
 
 from __future__ import print_function
 
-PGTOP_VERSION = "1.3.0 dev"
+PGTOP_VERSION = "1.3.0"
 
 import os
 import sys

diff --git a/setup.py b/setup.py
@@ -20,7 +20,7 @@
     packages = ['pgactivity'],
     url = 'https://github.com/julmon/pg_activity',
     license = 'LICENSE.txt',
-    description = 'htop like utility for PostgreSQL activity monitoring.',
+    description = 'Command line tool for PostgreSQL server activity monitoring.',
     install_requires = [
         "psutil >= 0.4.1",
         "psycopg2 >= 2.2.1",