From 10492605bdec9f8515147d94cb649200e084a17f Mon Sep 17 00:00:00 2001
From: Evan Carroll <ecarroll@x60s.(none)>
Date: Wed, 5 Sep 2007 02:28:11 -0500
Subject: [PATCH] updated podz

---
 PSQL-Query/bin/psql-plus     | 37 ++++++++++++++++++++++++++++++++-----
 PSQL-Query/lib/PSQL/Query.pm |  4 ++++
 2 files changed, 36 insertions(+), 5 deletions(-)

diff --git a/PSQL-Query/bin/psql-plus b/PSQL-Query/bin/psql-plus
index 388d7c9..e5e44fb 100755
--- a/PSQL-Query/bin/psql-plus
+++ b/PSQL-Query/bin/psql-plus
@@ -136,14 +136,14 @@ psql-plus - Utility to enhance the functionality of psql
 
 =head1 SYNOPSIS
 
-	EXPLAIN SELECT * FROM <table> | psql -d <database> | psql-plus --printf "%n"
+	echo EXPLAIN SELECT * FROM <table> | psql -d <database> | psql-plus --printf "%n"
 
 	psql -d database
 	\o|psql-plus --printf "%n"
 	EXPLAIN SELECT * FROM <table>
 	EXPLAIN SELECT * FROM <other table>
 	^D
-	
+
 	psql-plus --dom-char x --printf "%d"
 
 =head1 DESCRIPTION
@@ -173,8 +173,7 @@ psql-plus - Utility to enhance the functionality of psql
 	%ar = Actual Rows
 	%al = Actual Loops
 
-* dom_level: If you run an explain this is the whitespace
-significant portion from the left-margin to the first \S.
+* dom_level: If you run an explain this is the whitespace significant portion from the left-margin to the first \S.
 
 =item --printf-info ( OperationInfo Row )
 
@@ -182,6 +181,34 @@ significant portion from the left-margin to the first \S.
 	%v = Info verbose (not currently further parsed)
 	%s = Source (unmodified)
 
+=back
+
+=head2 PSQL::Query
+
+This is currently just a script for the L<PSQL::Query> library. All of the voodoo happens there.
+
+=head2 Not-yet-implimented --lookforward-to
+
+Roadmap to .01:
+
+=over 5
+
+=item * automatic opt-in posting to pastbins (DWIM). syn: C<--pastbin [rafb|sial|pastbin]>
+
+=item * the ability to return a url only when posting to a pastbin. syn: C<--url-only>
+
+=item * XML exportation syn: C<--format=XML> / syntax highlighting (tentative)
+
+=back
+
+Roadmap to .02:
+
+=over 5
+
+=item * expansion of PSQL:: to encompass more postgres-specific functionality, the use of a new lib other than L<PSQL::Query>
+
+=back
+
 =head1 BUGS
 
 Email me they will get fixed in .05 seconds, or you can sue someone else.
@@ -198,7 +225,7 @@ Artistic or GPL, like 99.9% of CPAN-distributed stuff.
 
 CPAN
 
-http://repo.or.cz/w/Pqsl-Perl.git
+L<http://repo.or.cz/w/Pqsl-Perl.git>
 
 =head1 AUTHOR
 
diff --git a/PSQL-Query/lib/PSQL/Query.pm b/PSQL-Query/lib/PSQL/Query.pm
index 01b841f..b81e0d4 100644
--- a/PSQL-Query/lib/PSQL/Query.pm
+++ b/PSQL-Query/lib/PSQL/Query.pm
@@ -58,6 +58,10 @@ sub get_rows_by_dom_depth {
 
 PSQL::Query - A framework to parse pg-query plans via the output of Explain / Explain Analyze
 
+=head1 DESCRIPTION
+
+This module is currently a backend for L<psql-plus>, the release of .01 is largely dependant on it. The internals of this module are subject to change. Check the README for more information.
+
 =head1 AUTHOR
 
 Evan Carroll, C<< <me at evancarroll.com> >>
-- 
2.11.4.GIT