.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "IO::Pager::Unbuffered 3"
.TH IO::Pager::Unbuffered 3 2023-07-26 "perl v5.38.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
IO::Pager::Unbuffered \- Pipe output to PAGER if destination is a TTY
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 8
\&  use IO::Pager::Unbuffered;
\&  {
\&    local $STDOUT = IO::Pager::Unbuffered::open *STDOUT;
\&    print <<"  HEREDOC" ;
\&    ...
\&    A bunch of text later
\&    HEREDOC
\&  }
\&
\&  {
\&    # You can also use scalar filehandles...
\&    my $token = IO::Pager::Unbuffered::open($FH) or warn($!);
\&    print $FH "No globs or barewords for us thanks!\en" while 1;
\&  }
\&
\&  {
\&    # ...or an object interface
\&    my $token = new IO::Pager::Unbuffered;
\&
\&    $token\->print("OO shiny...\en") while 1;
\&  }
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
IO::Pager subclasses are designed to programmatically decide whether
or not to pipe a filehandle's output to a program specified in \fIPAGER\fR;
determined and set by IO::Pager at runtime if not yet defined.
.PP
See IO::Pager for method details.
.SH METHODS
.IX Header "METHODS"
All methods are inherited from IO::Pager; except for instantiation.
.SH CAVEATS
.IX Header "CAVEATS"
You probably want to do something with SIGPIPE eg;
.PP
.Vb 3
\&  eval {
\&    local $SIG{PIPE} = sub { die };
\&    local $STDOUT = IO::Pager::open(*STDOUT);
\&
\&    while (1) {
\&      # Do something
\&    }
\&  }
\&
\&  # Do something else
.Ve
.SH "SEE ALSO"
.IX Header "SEE ALSO"
IO::Pager, IO::Pager::Buffered, IO::Pager::Page,
.SH AUTHOR
.IX Header "AUTHOR"
Jerrad Pierce <jpierce@cpan.org>
.PP
Florent Angly <florent.angly@gmail.com>
.PP
This module was inspired by Monte Mitzelfelt's IO::Page 0.02
.PP
Significant proddage provided by Tye McQueen.
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
Copyright (C) 2003\-2018 Jerrad Pierce
.IP \(bu 4
Thou shalt not claim ownership of unmodified materials.
.IP \(bu 4
Thou shalt not claim whole ownership of modified materials.
.IP \(bu 4
Thou shalt grant the indemnity of the provider of materials.
.IP \(bu 4
Thou shalt use and dispense freely without other restrictions.
.PP
Or, if you prefer:
.PP
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself, either Perl version 5.0 or,
at your option, any later version of Perl 5 you may have available.