Convert README to Markdown
authorChristoph Berg <[email protected]>
Tue, 7 Jun 2016 13:39:39 +0000 (15:39 +0200)
committerChristoph Berg <[email protected]>
Tue, 7 Jun 2016 13:42:12 +0000 (15:42 +0200)
README.md [moved from README with 78% similarity]

similarity index 78%
rename from README
rename to README.md
index 9063c8ddcc1b0a7a695bf9d86b12c506d3932ea4..ef7a0811f4e14c1144c90d429008102458292bcd 100644 (file)
--- a/README
+++ b/README.md
@@ -1,58 +1,62 @@
-check_postgres is Copyright (C) 2007-2015, Greg Sabino Mullane
+check_postgres
+==============
 
 This is check_postgres, a monitoring tool for Postgres.
 
 The most complete and up to date information about this script can be found at:
 
-http://bucardo.org/check_postgres/
+https://bucardo.org/wiki/Check_postgres
 
 You should go check there right now to make sure you are installing 
 the latest version!
 
 This document will cover how to install the script.
 
-* Quick method:
+Quick method
+------------
 
 For the impatient Nagios admin, just copy the "check_postgres.pl" file 
 to your Nagios scripts directory, and perhaps symlink entries to that 
 file by:
 
-cd <the directory you just copied the file to>
-mkdir postgres
-cd postgres
-perl ../check_postgres.pl --symlinks
+    cd <the directory you just copied the file to>
+    mkdir postgres
+    cd postgres
+    perl ../check_postgres.pl --symlinks
 
 Then join the announce mailing list (see below)
 
 
-* Complete method:
+Complete method
+---------------
 
 The better way to install this script is via the standard Perl process:
 
-perl Makefile.PL
-make
-make test
-make install
+    perl Makefile.PL
+    make
+    make test
+    make install
 
 The last step usually needs to be done as the root user. You may want to 
 copy the script to a place that makes more sense for Nagios, if using it 
 for that purpose. See the "Quick" instructions above.
 
-For 'make test', please report any failing tests to [email protected]
+For `make test`, please report any failing tests to [email protected]
 The tests need to have some standard Postgres binaries available, such as 
-'initdb', 'psql', and 'pg_ctl'. If these are not in your path, or you want to 
-use specific ones, please set the environment variable PGBINDIR first.
+`initdb`, `psql`, and `pg_ctl`. If these are not in your path, or you want to 
+use specific ones, please set the environment variable `PGBINDIR` first.
 
-Once 'make install' has been done, you should have access to the complete 
+Once `make install` has been done, you should have access to the complete 
 documentation by typing:
 
-man check_postgres
+    man check_postgres
 
 The HTML version of the documentation is also available at:
 
-http://bucardo.org/check_postgres/check_postgres.pl.html
+https://bucardo.org/check_postgres/check_postgres.pl.html
 
-* Mailing lists
+Mailing lists
+-------------
 
 The final step should be to subscribe to the low volume check_postgres-announce 
 mailing list, so you learn of new versions and important changes. Information 
@@ -67,20 +71,20 @@ https://mail.endcrypt.com/mailman/listinfo/check_postgres
 
 Development happens via git. You can check out the repository by doing:
 
-git clone git://bucardo.org/check_postgres.git
+    git clone git://bucardo.org/check_postgres.git
 
 All changes are sent to the commit list:
 
 https://mail.endcrypt.com/mailman/listinfo/check_postgres-commit
 
-COPYRIGHT:
-----------
+COPYRIGHT
+---------
 
   Copyright (c) 2007-2015 Greg Sabino Mullane
 
 
-LICENSE INFORMATION:
---------------------
+LICENSE INFORMATION
+-------------------
 
 Redistribution and use in source and binary forms, with or without 
 modification, are permitted provided that the following conditions are met: