.\" -*- 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 "Perl 3pm"
.TH Perl 3pm 2024-03-07 "perl v5.38.2" "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
Term::Size::Perl \- Perl extension for retrieving terminal size (Perl version)
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&    use Term::Size::Perl;
\&
\&    ($columns, $rows) = Term::Size::Perl::chars *STDOUT{IO};
\&    ($x, $y) = Term::Size::Perl::pixels;
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
Yet another implementation of \f(CW\*(C`Term::Size\*(C'\fR. Now
in pure Perl, with the exception of a C probe run
on build time.
.SS FUNCTIONS
.IX Subsection "FUNCTIONS"
.IP \fBchars\fR 4
.IX Item "chars"
.Vb 2
\&    ($columns, $rows) = chars($h);
\&    $columns = chars($h);
.Ve
.Sp
\&\f(CW\*(C`chars\*(C'\fR returns the terminal size in units of characters
corresponding to the given filehandle \f(CW$h\fR.
If the argument is omitted, \f(CW*STDIN{IO}\fR is used.
In scalar context, it returns the terminal width.
.IP \fBpixels\fR 4
.IX Item "pixels"
.Vb 2
\&    ($x, $y) = pixels($h);
\&    $x = pixels($h);
.Ve
.Sp
\&\f(CW\*(C`pixels\*(C'\fR returns the terminal size in units of pixels
corresponding to the given filehandle \f(CW$h\fR.
If the argument is omitted, \f(CW*STDIN{IO}\fR is used.
In scalar context, it returns the terminal width.
.Sp
Many systems with character-only terminals will return \f(CW\*(C`(0, 0)\*(C'\fR.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
It all began with Term::Size by Tim Goodwin. You may want to
have a look at:
.PP
Term::Size
.PP
Term::Size::Win32
.PP
Term::Size::ReadKey
.PP
Please reports bugs via GitHub,
<https://github.com/aferreira/cpan\-Term\-Size\-Perl/issues>.
When reporting bugs, it may be helpful to attach the \fIParams.pm\fR generated by
the probe at build time.
.SH AUTHOR
.IX Header "AUTHOR"
Adirano Ferreira, <ferreira@cpan.org>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
Copyright (C) 2006\-2007, 2017\-2018 by Adriano Ferreira
.PP
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.