everything done for the initial release

git-svn-id: svn://127.0.0.1/Perl/Proc-ProcessTable-Colorizer/trunk@972 0c1c3402-1be1-de11-8092-0022686faf23

Proc-ProcessTable-Colorizer/Changes

@@ -1,5 +1,5 @@
 Revision history for Proc-ProcessTable-Colorizer
 
-0.01    Date/time
-        First version, released on an unsuspecting world.
+0.0.0	 2017-11-06/00:00
+		 -Initial release.
 

Proc-ProcessTable-Colorizer/README

@@ -1,16 +1,21 @@
 Proc-ProcessTable-Colorizer
 
-The README is used to introduce the module and provide instructions on
-how to install the module, any machine dependencies it may have (for
-example C compilers and installed libraries) and any other information
-that should be provided before the module is installed.
+This colorizes the output from Proc::ProcessTable.
 
-A README file is required for CPAN modules since CPAN extracts the README
-file from a module distribution so that people browsing the archive
-can use it to get an idea of the module's uses. It is usually a good idea
-to provide version information here so that people can decide whether
-fixes for the module are worth downloading.
+This is largely meant to be used from the command line instead of
+as a module via the included bin script.
 
+Among other fun things, it allows searching of the process table.
+
+Searching is currently possible against the folowing criteria.
+
+    zombie
+	swapped out
+	regex command line matching
+	CPU seconds used by a process
+	percent of memory usage
+	percent of CPU usage
+	wait channel in use
 
 INSTALLATION
 

Proc-ProcessTable-Colorizer/bin/cps

@@ -48,7 +48,7 @@ sub main::HELP_MESSAGE {
 		"\n".
 		"foo     Checks if it matches foo.\n".
 		"!foo    Checks if it does not match foo.\n".
-		"foo,bar Checks if it matches foo or bar.\n.".
+		"foo,bar Checks if it matches foo or bar.\n".
 		"\n".
 		"\n".
 		"Numeric Search:\n".
@@ -97,3 +97,72 @@ if ( defined( $opts{m} ) ){
 
 
 print $cps->colorize;
+
+=head1 NAME
+
+cps - A colorized version of ps with various extra useful options.
+
+=head1 SYNOPSIS
+
+cps [B<-z>] [B<-s>] [B<-p> <regex>] [B<-u> <users>] [B<-t> <time>] [B<-m> <pctmem>] [B<-c> <pctcpu>]  [B<-w> <wait channels>]
+
+=head1 USAGE
+
+By default this prints out all processes, minus the idle process.
+
+This may be changed via setting various switches to limit the procs shown. If more than one is specified,
+only the processes matching all of them are shown.
+
+=head1 SWITCHES
+
+=head2 B<-z>
+
+Only show zombie processes.
+
+=head2 B<-s>
+
+Show only swapped out processes.
+
+=head2 B<-p> <regex>
+
+The command line of the processes is matched against the provided regex.
+
+=head2 B<-u> <users>
+
+A string search for users.
+
+=head2 B<-t> <time>
+
+A numeric search based on the total amount of CPU seconds used by the processes.
+
+=head2 B<-m> <pctmem>
+
+A numeric search based on the percent of memory processes are using.
+
+=head2 B<-c> <pctcpu>
+
+A numeric search based on the percent of CPU usage a process is using.
+
+=head2 B<-w> <wait channels>
+
+A string search based on the wait channel a processes are using.
+
+=head1 STRING SEARCHES
+
+This is a comma seperated list of strings to search for.
+
+Any items starting with ! will be inverted.
+
+    foo      Checks if it matches foo.
+    !foo     Checks if it does not match foo.
+    foo,bar  Checks if it matches foo or bar.
+
+=head1 NUMERIC SEARCHES
+
+This is a comma seperated list of values to search for.
+
+Each item must start with a equality.
+
+<, <=, >=, > are all recognized.
+
+=cut

Proc-ProcessTable-Colorizer/lib/Proc/ProcessTable/Colorizer.pm

@@ -15,7 +15,7 @@ if ( $^O =~ /bsd/ ){
 
 =head1 NAME
 
-Proc::ProcessTable::Colorizer - Like ps, but with colored columns and enhnaced functions.
+Proc::ProcessTable::Colorizer - Like ps, but with colored columns and enhnaced functions for searching.
 
 =head1 VERSION
 
@@ -35,6 +35,11 @@ our $VERSION = '0.0.0';
 
 This module uses L<Error::Helper> for error reporting.
 
+As of right now this module is not really user friend and will likely be going through lots of changes as it grows.
+
+Linux is also not as well supported given the limitations of Proc::ProcessTable and there is nothig similar to
+L<BSD::Process> for Linux.
+
 =head1 METHODS
 
 =head2 new