add help text for watchdbg and grepdbg

[spider.git] / perl / grepdbg

diff --git a/perl/grepdbg b/perl/grepdbg
index 80a4b9dec6fce147d5e799f26e1eaea412ff4741..8fa76857e7203b18ff7eb7ee97d243645c563a7d 100755 (executable)
--- a/perl/grepdbg
+++ b/perl/grepdbg
@@ -8,8 +8,9 @@
 # nn - is the day you what to look at: 1 is yesterday, 0 is today
 # and is optional if there is only one argument
 #
 # nn - is the day you what to look at: 1 is yesterday, 0 is today
 # and is optional if there is only one argument
 #

-# -mmm - print the mmm lines before the match. So -10 will print
-# ten lines including the line matching the regular expression. 
+# -mmm - print the mmm lines before the match. So -3 will print
+# 4 lines altogether, the 3 lines before the line matching
+# the regular expression. 

 #
 # <regexp> is the regular expression you are searching for, 
 # a caseless search is done. There can be more than one <regexp>
 #
 # <regexp> is the regular expression you are searching for, 
 # a caseless search is done. There can be more than one <regexp>


@@ -60,7 +61,7 @@ foreach my $arg (@ARGV) {
                        usage();
                        exit(0);
                }
                        usage();
                        exit(0);
                }

-               $nolines = $arg if $arg =~ /^\d+$/;
+               $nolines += $arg if $arg =~ /^\d+$/;

        } elsif ($arg =~ /^\d+$/) {
                push @days, $arg;
        } elsif ($arg =~ /\.pm$/) {
        } elsif ($arg =~ /^\d+$/) {
                push @days, $arg;
        } elsif ($arg =~ /\.pm$/) {


@@ -136,17 +137,27 @@ sub usage
 {
        print << "XXX";
 
 {
        print << "XXX";
 

- usage: grepdbg [nn days before] [-nnn lines before] [<perl file name>] [<regexp>|!<regexp>]...
+ usage: grepdbg [nn days before] [-nnn lines before] [<perl filter module>] [<regexp>|!<regexp>]...

 
 

-        grepdbg with no argumants will simply list the current debug log with the timestamp
+        You can have more than one <regexp> with an implicit 'and' between them. All 
+        <regexes> are caseless. It's recommended to put 'not' (!<regex>) first in any list.
+        Don't forget that you are doing this in a shell and you may need to quote your
+        <regex>s.
+
+        grepdbg with no arguments will simply list the current debug log with the timestamp

         for each line decoded into a human readable form. 
 
           grepdbg | less
 
         is a handy way of scrolling through the debug log.
 
         for each line decoded into a human readable form. 
 
           grepdbg | less
 
         is a handy way of scrolling through the debug log.
 

+          grepdbg -2 progress
+
+        will display any line containing 'progress' and also the two lines before that.
+

         You can install your own content and display arrangement (useful for filtering data 
         in some complicated way). You call it like this (assuming it is called 'filter.pm').
         You can install your own content and display arrangement (useful for filtering data 
         in some complicated way). You call it like this (assuming it is called 'filter.pm').

+        This is what is meant by <perl filter module>.

 
         grepdbg filter.pm
 
 
         grepdbg filter.pm
 


@@ -169,8 +180,11 @@ sub usage
         You can also add a 'sub total {...}' which executes after the last line is 
         printed and grepdbg exits.
 
         You can also add a 'sub total {...}' which executes after the last line is 
         printed and grepdbg exits.
 

-        Read the code of this program and copy'n'paste the 'sub process' code and its name
-        to 'sub handle'. Modify it to your requirements... 
+        Read the code of this program and copy'n'paste the 'sub
+        process' code into a new file. Then change 'sub process'
+        to 'sub handle'. Add the line 'package main;' at the beginning
+        of the file and a line '1;' at the end and then modify it to
+        your requirements...

 
 XXX
 }
 
 XXX
 }