Convert various text files to rst

7 files changed, 140 insertions, 135 deletions

diff --git a/CMakeLists.txt b/CMakeLists.txt
index 56f306e..03cc472 100644
--- a/CMakeLists.txt
+++ b/CMakeLists.txt
@@ -297,7 +297,7 @@ include(InstallRequiredSystemLibraries)
 set(CPACK_CMAKE_GENERATOR "Unix Makefiles")
 set(CPACK_PACKAGE_DESCRIPTION_SUMMARY "pg_top is 'top' for PostgreSQL")
 set(CPACK_PACKAGE_VENDOR "pg_top")
-set(CPACK_PACKAGE_DESCRIPTION_FILE "${CMAKE_SOURCE_DIR}/README")
+set(CPACK_PACKAGE_DESCRIPTION_FILE "${CMAKE_SOURCE_DIR}/README.rst")
 set(CPACK_RESOURCE_FILE_LICENSE "${CMAKE_SOURCE_DIR}/LICENSE")
 set(CPACK_PACKAGE_VERSION_MAJOR "${PROJECT_VERSION_MAJOR}")
 set(CPACK_PACKAGE_VERSION_MINOR "${PROJECT_VERSION_MINOR}")
diff --git a/HISTORY b/HISTORY
deleted file mode 100644
index d59f06e..0000000
--- a/HISTORY
+++ /dev/null
@@ -1,76 +0,0 @@
-Release Notes
-
-Release 4.0.0
-
-     * Replace autoconf with cmake
-     * Remove table stats monitoring, use pgstat instead
-     * Remove index stats monitoring, use pgstat instead
-     * Remove kill and renice command, and stop displaying nice priority
-     * Show backend state instead of operating system state
-     * Show database username instead of operating system username
-     * Make connections with password persistent and clear connection memory in
-       these scenarios
-     * Fix sorting when specified from the command line and in interactive mode
-     * Add display for top replication processes using 'R' command line
-       argument or 'R' command
-     * Add 'a' command to switch to top 'activity' processes, the default,
-       while removing the 'I' for the top I/O display as a toggle
-     * Show swapping activity
-     * Simplify top I/O display
-     * Remove toggle for display raw I/O statistics
-     * Fix bug for specifing number of displays to show on the command line
-       without -x flag
-
-Release 3.7.0
-
-     * Added support for monitoring databases on remote systems.
-     * Added support for monitoring i/o statistics on Linux.
-     * Updated for changed introduced in PostgreSQL 9.2.
-     * Updated for OpenBSD 5.2.
-     * Updated for FreeBSD 9.1.
-     * Updated for OS X Mountain Lion (10.8).
-     * Add monitoring for database activity
-     * Add monitoring for disk activity
-     * Add monitoring for disk space
-     * Add long options
-
-Release 3.6.2
-
-Changes
-
-     * Add 'A' command to re-run SQL statement and show actual execution plan
-       (EXPLAIN ANALYZE) of a running query.
-     * Fixed 'E' command (EXPLAIN) to be UPDATE and INSERT safe.
-     * Updated the automake file so other targets like 'make dist' and
-       'make distdir' work.
-     * Fixed a bug so user table statistics can be sorted.
-     * Added a 't' command so that user table and index statistics can
-       display either cumulative or differential statistics.
-     * Fixed support for OS X, tested on v10.4.x, v10.5.x.
-     * Added support for OpenBSD, tested on v4.2.
-     * Rename 'ptop' to 'pg_top' to fit PostgreSQL naming conventions and
-       avoid naming conflict with free pascal's source formatter 'ptop'.
-     * Recognize PGDATABASE, PGHOST, PGUSER, and PGPORT environment variables.
-
-Release 3.6.1
-
-Changes
-     * Add -h command line option to specify a socket file when connected to
-       the database..
-     * Use the same -p PORT, -U USER, and -d DBNAME options as other PostgreSQL
-       programs.
-     * Change unixtop's original -d to -x, and -U to -z.
-     * Add 'X' command to view user index statistics.
-     * Add 'R' command to view user table statistics.
-     * Add support for Solaris 10.
-     * Add support for FreeBSD.
-     * Add 'E' command to re-determine and show execution plan of a running
-       SQL statement.
-     * Add parameters to specify database connection information.
-     * Add 'L' command to show locks held by a process.
-     * Add 'Q' command to show current query of a process.
-     * Rename 'top' to 'ptop'.
-     * Add support for Linux.
-     * Configure support for PostgreSQL libpq client libraries.
-     * Remove old_modules directory.
-     * Update RES calculation for Linux 2.6.x.
diff --git a/HISTORY.rst b/HISTORY.rst
new file mode 100644
index 0000000..c956635
--- /dev/null
+++ b/HISTORY.rst
@@ -0,0 +1,78 @@
+Release Notes
+=============
+
+YYYY-MM-DD v4.0.0
+-----------------
+
+* Replace autoconf with cmake
+* Remove table stats monitoring, use pgstat instead
+* Remove index stats monitoring, use pgstat instead
+* Remove kill and renice command, and stop displaying nice priority
+* Show backend state instead of operating system state
+* Show database username instead of operating system username
+* Make connections with password persistent and clear connection memory in
+  these scenarios
+* Fix sorting when specified from the command line and in interactive mode
+* Add display for top replication processes using 'R' command line argument or
+  'R' command
+* Add 'a' command to switch to top 'activity' processes, the default, while
+  removing the 'I' for the top I/O display as a toggle
+* Show swapping activity
+* Simplify top I/O display
+* Remove toggle for display raw I/O statistics
+* Fix bug for specifing number of displays to show on the command line without
+  -x flag
+
+2013-07-31 v3.7.0
+-----------------
+
+* Added support for monitoring databases on remote systems.
+* Added support for monitoring i/o statistics on Linux.
+* Updated for changed introduced in PostgreSQL 9.2.
+* Updated for OpenBSD 5.2.
+* Updated for FreeBSD 9.1.
+* Updated for OS X Mountain Lion (10.8).
+* Add monitoring for database activity
+* Add monitoring for disk activity
+* Add monitoring for disk space
+* Add long options
+
+2008-05-03 v3.6.2
+-----------------
+
+* Add 'A' command to re-run SQL statement and show actual execution plan
+  (EXPLAIN ANALYZE) of a running query.
+* Fixed 'E' command (EXPLAIN) to be UPDATE and INSERT safe.
+* Updated the automake file so other targets like 'make dist' and 'make
+  distdir' work.
+* Fixed a bug so user table statistics can be sorted.
+* Added a 't' command so that user table and index statistics can display
+  either cumulative or differential statistics.
+* Fixed support for OS X, tested on v10.4.x, v10.5.x.
+* Added support for OpenBSD, tested on v4.2.
+* Rename 'ptop' to 'pg_top' to fit PostgreSQL naming conventions and avoid
+  naming conflict with free pascal's source formatter 'ptop'.
+* Recognize PGDATABASE, PGHOST, PGUSER, and PGPORT environment variables.
+
+2008-03-05 v3.6.1
+-----------------
+
+* Add -h command line option to specify a socket file when connected to the
+  database..
+* Use the same -p PORT, -U USER, and -d DBNAME options as other PostgreSQL
+  programs.
+* Change unixtop's original -d to -x, and -U to -z.
+* Add 'X' command to view user index statistics.
+* Add 'R' command to view user table statistics.
+* Add support for Solaris 10.
+* Add support for FreeBSD.
+* Add 'E' command to re-determine and show execution plan of a running SQL
+  statement.
+* Add parameters to specify database connection information.
+* Add 'L' command to show locks held by a process.
+* Add 'Q' command to show current query of a process.
+* Rename 'top' to 'ptop'.
+* Add support for Linux.
+* Configure support for PostgreSQL libpq client libraries.
+* Remove old_modules directory.
+* Update RES calculation for Linux 2.6.x.
diff --git a/INSTALL b/INSTALL
deleted file mode 100644
index 918acb8..0000000
--- a/INSTALL
+++ /dev/null
@@ -1,30 +0,0 @@
-								  pg_top
-
-							  INSTALLATION
-
-Configuring
------------
-
-cmake [options] CMakeLists.txt
-
-options:
-
-    -DCMAKE_INSTALL_PREFIX=PREFIX
-
-    Install files in PREFIX.  Default is '/usr/local'.
-
-    -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
-----------
-
-make install
-
-Uninstalling
-------------
-
-xargs rm < install_manifest.txt
diff --git a/INSTALL.rst b/INSTALL.rst
new file mode 100644
index 0000000..95f06c6
--- /dev/null
+++ b/INSTALL.rst
@@ -0,0 +1,36 @@
+pg_top
+======
+
+Installation
+------------
+
+Configuring
+~~~~~~~~~~~
+
+::
+
+  cmake [options] CMakeLists.txt
+
+options:
+
+-DCMAKE_INSTALL_PREFIX=PREFIX   Install files in PREFIX.  Default is
+                                '/usr/local'.
+-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
+~~~~~~~~~~
+
+::
+
+  make install
+
+Uninstalling
+~~~~~~~~~~~~
+
+::
+
+  xargs rm < install_manifest.txt
diff --git a/README.appimage b/README.appimage.rst
index fe519e8..9da3ce1 100644
--- a/README.appimage
+++ b/README.appimage.rst
@@ -1,16 +1,14 @@
 AppImages are only for Linux based systems:
 
-    https://appimage.org/
+  https://appimage.org/
 
 The AppImageKit AppImage can be downloaded from:
 
-    https://github.com/AppImage/AppImageKit/releases
-
+  https://github.com/AppImage/AppImageKit/releases
 
 It is recommended to build AppImages on older distributions:
 
-    https://docs.appimage.org/introduction/concepts.html#build-on-old-systems-run-on-newer-systems
-
+  https://docs.appimage.org/introduction/concepts.html#build-on-old-systems-run-on-newer-systems
 
 At the time of this document, CentOS 6 is the one of the oldest supported Linux
 distributions with the oldest libc version.
@@ -25,10 +23,9 @@ multiple potential unixsock directories if no PGHOST is defined in the user's
 environment.
 
 At the time of this document, PostgreSQL 10 was configured with the following
-options:
-
-    ./configure --without-ldap --without-readline --without-zlib --without-gssapi
+options::
 
+  ./configure --without-ldap --without-readline --without-zlib --without-gssapi
 
-Don't forget you may have to both PATH and LD_LIBRARY_PATH appropriately
+Don't forget you may have to set both PATH and LD_LIBRARY_PATH appropriately
 depending on where the custom build of PostgreSQL is installed.
diff --git a/README b/README.rst
index 664d1d7..d1bfb9f 100644
--- a/README
+++ b/README.rst
@@ -1,55 +1,55 @@
-                                  pg_top
+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.
+* View currently running SQL statement of a process.
+* View query plan of a currently running SELECT statement.
+* View locks held by a process.
 
-To compile and install "pg_top", read the file "INSTALL" and follow the
+To compile and install "pg_top", read the file "INSTALL.rst" and follow the
 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 submit the change to the pg_top issue tracker:
 
-    https://gitlab.com/pg_top/pg_top/issues
-
+  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_proctab here:
 
-    https://gitlab.com/pg_top/pg_proctab
-
+  https://gitlab.com/pg_top/pg_proctab
 
-AVAILABILITY
+Availability
+------------
 
 Project home page:
 
-    https://pg_top.gitlab.io/
-
+  https://pg_top.gitlab.io/
 
-If you have git, you can download the source code:
 
-    git clone git@gitlab.com:pg_top/pg_top.git
+If you have git, you can download the source code::
 
+  git clone git@gitlab.com:pg_top/pg_top.git
 
-LOGO
+Logo
+----
 
 The logo is just a pipe (|) and a capital V using the free Ampad Brush true
 type font.
 
-
-GRATITUDE
+Gratitude
+---------
 
 Selena Deckelmann & Gabrielle Roth, and the beer & free wi-fi at County Cork
 pub in Portland, OR, USA.
 
-
-LICENSE
+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"