Author: Scott M. Dier Description: Fixup indentation of POD documentation. Date: Tue, 1 Jun 2004 13:42:50 -0500 Bug-Debian: https://bugs.debian.org/213810 Forwarded: https://rt.cpan.org/Public/Bug/Display.html?id=133848 --- a/Tail.pm.debug +++ b/Tail.pm.debug @@ -647,12 +647,11 @@ File::Tail - Perl extension for reading OR, you could use tie (additional parameters can be passed with the name, or can be set using $ref): - use File::Tail; - my $ref=tie *FH,"File::Tail",(name=>$name); - while () { - print "$_"; - } - + use File::Tail; + my $ref=tie *FH,"File::Tail",(name=>$name); + while () { + print "$_"; + } Note that the above script will never exit. If there is nothing being written to the file, it will simply block. @@ -763,36 +762,35 @@ If you want to read tails from multiple =item ignore_nonexistant - Do not complain if the file doesn't exist when it is first +Do not complain if the file doesn't exist when it is first opened or when it is to be reopened. (File may be reopened after resetafter seconds have passed since last data was found.) =item tail - When first started, read and return C lines from the file. +When first started, read and return C lines from the file. If C is zero, start at the end of file. If C is negative, return the whole file. - Default is C<0>. +Default is C<0>. =item reset_tail - Same as tail, but applies after reset. (i.e. after the +Same as tail, but applies after reset. (i.e. after the file has been automaticaly closed and reopened). Defaults to C<-1>, i.e. does not skip any information present in the file when it first checks it. - Why would you want it otherwise? I've seen files which +Why would you want it otherwise? I've seen files which have been cycled like this: - grep -v lastmonth log >newlog - mv log archive/lastmonth - mv newlog log - kill -HUP logger - + grep -v lastmonth log >newlog + mv log archive/lastmonth + mv newlog log + kill -HUP logger Obviously, if this happens and you have reset_tail set to -c<-1>, you will suddenly get a whole bunch of lines - lines +C<-1>, you will suddenly get a whole bunch of lines - lines you already saw. So in this case, reset_tail should probably be set to a small positive number or even C<0>. @@ -820,9 +818,9 @@ is called with the error string as a par reference as the first parameter and other parameters to be passed to handler subroutine, or one of the words: -return - ignore any error (just put error message in errmsg). -warn - output the error message but continue -die - display error message and exit + return - ignore any error (just put error message in errmsg). + warn - output the error message but continue + die - display error message and exit Default is die. --- a/Tail.pm +++ b/Tail.pm @@ -613,12 +613,11 @@ File::Tail - Perl extension for reading OR, you could use tie (additional parameters can be passed with the name, or can be set using $ref): - use File::Tail; - my $ref=tie *FH,"File::Tail",(name=>$name); - while () { - print "$_"; - } - + use File::Tail; + my $ref=tie *FH,"File::Tail",(name=>$name); + while () { + print "$_"; + } Note that the above script will never exit. If there is nothing being written to the file, it will simply block. @@ -729,36 +728,35 @@ If you want to read tails from multiple =item ignore_nonexistant - Do not complain if the file doesn't exist when it is first +Do not complain if the file doesn't exist when it is first opened or when it is to be reopened. (File may be reopened after resetafter seconds have passed since last data was found.) =item tail - When first started, read and return C lines from the file. +When first started, read and return C lines from the file. If C is zero, start at the end of file. If C is negative, return the whole file. - Default is C<0>. +Default is C<0>. =item reset_tail - Same as tail, but applies after reset. (i.e. after the +Same as tail, but applies after reset. (i.e. after the file has been automaticaly closed and reopened). Defaults to C<-1>, i.e. does not skip any information present in the file when it first checks it. - Why would you want it otherwise? I've seen files which +Why would you want it otherwise? I've seen files which have been cycled like this: - grep -v lastmonth log >newlog - mv log archive/lastmonth - mv newlog log - kill -HUP logger - + grep -v lastmonth log >newlog + mv log archive/lastmonth + mv newlog log + kill -HUP logger Obviously, if this happens and you have reset_tail set to -c<-1>, you will suddenly get a whole bunch of lines - lines +C<-1>, you will suddenly get a whole bunch of lines - lines you already saw. So in this case, reset_tail should probably be set to a small positive number or even C<0>. @@ -786,9 +784,9 @@ is called with the error string as a par reference as the first parameter and other parameters to be passed to handler subroutine, or one of the words: -return - ignore any error (just put error message in errmsg). -warn - output the error message but continue -die - display error message and exit + return - ignore any error (just put error message in errmsg). + warn - output the error message but continue + die - display error message and exit Default is die.