This document is a Mac OS X manual page. Manual pages are a command-line technology for providing documentation. You can view these manual pages locally using the man(1) command. These manual pages come from many different sources, and thus, have a variety of writing styles.

For more information about the manual page format, see the manual page for manpages(5).

IO::Pager::Unbuffered(3)             User Contributed Perl Documentation            IO::Pager::Unbuffered(3)



NAME
       IO::Pager::Unbuffered - Pipe output to a pager if output is to a TTY

SYNOPSIS
         use IO::Pager::Unbuffered;
         {
           #local $STDOUT =     IO::Pager::Unbuffered::open *STDOUT;
           local  $STDOUT = new IO::Pager::Unbuffered       *STDOUT;
           print <<"  HEREDOC" ;
           ...
           A bunch of text later
           HEREDOC
         }

DESCRIPTION
       IO::Pager is designed to programmaticly decide whether or not to point the STDOUT file handle into a
       pipe to program specified in $ENV{PAGER} or one of a standard list of pagers.

       new( [FILEHANDLE] )

       Instantiate a new IO::Pager to paginate FILEHANDLE if necessary.  Assign the return value to a scoped
       variable.

       FILEHANDLE
           Defaults to currently select()-ed FILEHANDLE.

       open( [FILEHANDLE] )

       An alias for new.

       close( FILEHANDLE )

       Explicitly close the filehandle, if a pager was deemed necessary this will kill it. Normally you'd
       just wait for the user to exit the pager and the object to pass out of scope.

       This does not default to the current filehandle.

CAVEATS
       You probably want to do something with SIGPIPE eg;

         eval{
           $SIG{PIPE} = sub{ die };
           local $STDOUT = IO::Pager::open(*STDOUT);

           while(1){
             #Do something
           }
         }

         #Do something else

SEE ALSO
       IO::Pager, IO::Pager::Buffered, IO::Pager::Page

AUTHOR
       Jerrad Pierce <jpierce@cpan.org>

       This module is forked from IO::Page 0.02 by Monte Mitzelfelt

       Significant proddage provided by Tye McQueen.

LICENSE
          Thou shalt not claim ownership of unmodified materials.

          Thou shalt not claim whole ownership of modified materials.

          Thou shalt grant the indemnity of the provider of materials.

          Thou shalt use and dispense freely without other restrictions.



perl v5.8.8                                      2004-11-17                         IO::Pager::Unbuffered(3)