File: README

package info (click to toggle)
libterm-size-any-perl 0.002-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, bullseye, buster, sid
  • size: 96 kB
  • sloc: perl: 24; makefile: 2
file content (78 lines) | stat: -rw-r--r-- 2,480 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
NAME
    Term::Size::Any - Retrieve terminal size

SYNOPSIS
        # the traditional way
        use Term::Size::Any qw( chars pixels );

        ($columns, $rows) = chars *STDOUT{IO};
        ($x, $y) = pixels;

DESCRIPTION
    This is a unified interface to retrieve terminal size. It loads one
    module of a list of known alternatives, each implementing some way to
    get the desired terminal information. This loaded module will actually
    do the job on behalf of `Term::Size::Any'.

    Thus, `Term::Size::Any' depends on the availability of one of these
    modules:

        Term::Size           (soon to be supported)
        Term::Size::Perl
        Term::Size::ReadKey  (soon to be supported)
        Term::Size::Win32

    This release fallbacks to Term::Size::Win32 if running in Windows 32
    systems. For other platforms, it uses the first of Term::Size::Perl,
    Term::Size or Term::Size::ReadKey which loads successfully. (To be
    honest, I disabled the fallback to Term::Size and Term::Size::ReadKey
    which are buggy by now.)

  FUNCTIONS

    The traditional interface is by importing functions `chars' and `pixels'
    into the caller's space.

    chars
            ($columns, $rows) = chars($h);
            $columns = chars($h);

        `chars' returns the terminal size in units of characters
        corresponding to the given filehandle `$h'. If the argument is
        ommitted, `*STDIN{IO}' is used. In scalar context, it returns the
        terminal width.

    pixels
            ($x, $y) = pixels($h);
            $x = pixels($h);

        `pixels' returns the terminal size in units of pixels corresponding
        to the given filehandle `$h'. If the argument is ommitted,
        `*STDIN{IO}' is used. In scalar context, it returns the terminal
        width.

        Many systems with character-only terminals will return `(0, 0)'.

SEE ALSO
    It all began with Term::Size by Tim Goodwin. You may want to have a look
    at:

        Term::Size
        Term::Size::Perl
        Term::Size::Win32
        Term::Size::ReadKey

BUGS
    Please reports bugs via CPAN RT, via web
    http://rt.cpan.org/NoAuth/Bugs.html?Dist=Term-Size-Any or e-mail to
    bug-Term-Size-Any@rt.cpan.org.

AUTHOR
    Adriano R. Ferreira, <ferreira@cpan.org>

COPYRIGHT AND LICENSE
    Copyright (C) 2008-2012 by Adriano R. Ferreira

    This library is free software; you can redistribute it and/or modify it
    under the same terms as Perl itself.