Adding spacing documentation

README.pod

@@ -8,6 +8,47 @@
 
 Library for tailing files with plugins to enhance the output of the tail
 
+=head1 SYNOPSIS
+
+   tailt [option] file1 [ file2 ...]
+   tailt --help | --man | --VERSION
+
+ OPTIONS:
+  file             This can be a local file or a remote file specified by an
+                   ssh URI eg ssh://user@example.com:22//var/log/error.log
+  -r --restart     Turn on menu, which allows chnaging of options/files/plugin
+                   configuration on the fly. To see the menu type any thing
+                   other than q and press enter, typing q & enter quit.
+  -n --lines=int   The number of lines form the end of a file to start tailing
+                   The default is 10.
+  -c --config=str  Use the str config option from previously save config
+     --no_inotify  Inotify works wonderfully usually but if a file is on a network
+                   networked drive it sometimes doesn't fire when a tailed file
+                   changes, this option turns off inotify and uses the polling
+                   option
+  -d --disable=file
+                   Add the file to the list of files but don't automatically
+                   start tailing it. This can be specified more than once for
+                   multiple disabled files or comma/semi-comma seperated
+
+  -v --verbose       Show more detailed option
+     --VERSION       Prints the version information
+     --help          Prints this help information
+     --man           Prints the full documentation for tailt
+
+ PLUGIN OPTIONS:
+  -h --highlight   Sets up the hightlight plugin options
+  -m --match       Sets up the match plugin option to only show lines that natch
+                   the regexp.
+  -i --ignore      Sets up the ignore plugin options to hide all lines that
+                   match the regexp.
+  -r --replace     Sets op the replace plugin option which chnages match values.
+     --spacing key=value
+
+=head1 DESCRIPTION
+
+L<Tail::Tool> allows you to
+
 =head1 INSTALLATION
 
 To install this module, run the following commands:

bin/tailt

@@ -854,36 +854,41 @@ This documentation refers to tailt version 0.4.4.
    tailt --help | --man | --VERSION
 
  OPTIONS:
-  file             This can be a local file or a remote file specified by an
-                   ssh URI eg ssh://user@example.com:22//var/log/error.log
-  -r --restart     Turn on menu, which allows chnaging of options/files/plugin
-                   configuration on the fly. To see the menu type any thing
-                   other than q and press enter, typing q & enter quit.
-  -n --lines=int   The number of lines form the end of a file to start tailing
-                   The default is 10.
-  -c --config=str  Use the str config option from previously save config
-     --no_inotify  Inotify works wonderfully usually but if a file is on a network
-                   networked drive it sometimes doesn't fire when a tailed file
-                   changes, this option turns off inotify and uses the polling
-                   option
+  file              This can be a local file or a remote file specified by an
+                    ssh URI eg ssh://user@example.com:22//var/log/error.log
+  -r --restart      Turn on menu, which allows chnaging of options/files/plugin
+                    configuration on the fly. To see the menu type any thing
+                    other than q and press enter, typing q & enter quit.
+  -n --lines=int    The number of lines form the end of a file to start tailing
+                    The default is 10.
+  -c --config=str   Use the str config option from previously save config
+     --no_inotify   Inotify works wonderfully usually but if a file is on a network
+                    networked drive it sometimes doesn't fire when a tailed file
+                    changes, this option turns off inotify and uses the polling
+                    option
   -d --disable=file
-                   Add the file to the list of files but don't automatically
-                   start tailing it. This can be specified more than once for
-                   multiple disabled files or comma/semi-comma seperated
+                    Add the file to the list of files but don't automatically
+                    start tailing it. This can be specified more than once for
+                    multiple disabled files or comma/semi-comma seperated
 
-  -v --verbose       Show more detailed option
-     --VERSION       Prints the version information
-     --help          Prints this help information
-     --man           Prints the full documentation for tailt
+  -v --verbose      Show more detailed option
+     --VERSION      Prints the version information
+     --help         Prints this help information
+     --man          Prints the full documentation for tailt
 
  PLUGIN OPTIONS:
-  -h --highlight   Sets up the hightlight plugin options
-  -m --match       Sets up the match plugin option to only show lines that natch
-                   the regexp.
-  -i --ignore      Sets up the ignore plugin options to hide all lines that
-                   match the regexp.
-  -r --replace     Sets op the replace plugin option which chnages match values.
+  -h --highlight    Sets up the hightlight plugin options
+  -m --match        Sets up the match plugin option to only show lines that natch
+                    the regexp.
+  -i --ignore       Sets up the ignore plugin options to hide all lines that
+                    match the regexp.
+  -r --replace      Sets op the replace plugin option which chnages match values.
      --spacing key=value
+                    Add spacing when no new lines have occured for a period
+                    of time
+            Keys:
+                times      The time in seconds since last seen output (comma separated list of times)
+                lines      The number of lines to show for the matching time (also comma separated list)
 
 =head1 DESCRIPTION