Debian Codegraph @

upstream/debian-unstable/man3/Term::Table::Util.3perl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "Term::Table::Util 3perl"
58 .TH Term::Table::Util 3perl 2025-11-16 "perl v5.40.1" "Perl Programmers Reference Guide"
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 Term::Table::Util \- Utilities for Term::Table.
65 .SH DESCRIPTION
66 .IX Header "DESCRIPTION"
67 This package exports some tools used by Term::Table.
68 .SH EXPORTS
69 .IX Header "EXPORTS"
70 .SS CONSTANTS
71 .IX Subsection "CONSTANTS"
72 .ie n .IP "$bool = USE_GCS" 4
73 .el .IP "\f(CW$bool\fR = USE_GCS" 4
74 .IX Item "$bool = USE_GCS"
75 True if Unicode::GCString is installed.
76 .ie n .IP "$bool = USE_TERM_READKEY" 4
77 .el .IP "\f(CW$bool\fR = USE_TERM_READKEY" 4
78 .IX Item "$bool = USE_TERM_READKEY"
79 True if Term::ReadKey is installed.
80 .SS UTILITIES
81 .IX Subsection "UTILITIES"
82 .ie n .IP "$width = \fBterm_size()\fR" 4
83 .el .IP "\f(CW$width\fR = \fBterm_size()\fR" 4
84 .IX Item "$width = term_size()"
85 Get the width of the terminal.
86 .Sp
87 If the \f(CW$TABLE_TERM_SIZE\fR environment variable is set then that value will be
88 returned.
89 .Sp
90 This will default to 80 if there is no good way to get the size, or if the size
91 is unreasonably small.
92 .Sp
93 If Term::ReadKey is installed it will be used.
94 .ie n .IP "$width = uni_length($string)" 4
95 .el .IP "\f(CW$width\fR = uni_length($string)" 4
96 .IX Item "$width = uni_length($string)"
97 Get the width (in columns) of the specified string. When Unicode::GCString
98 is installed this will work on unicode strings, otherwise it will just use
99 \&\f(CWlength($string)\fR.
100 .SH SOURCE
101 .IX Header "SOURCE"
102 The source code repository for Term-Table can be found at
103 \&\fIhttp://github.com/exodist/Term\-Table/\fR.
104 .SH MAINTAINERS
105 .IX Header "MAINTAINERS"
106 .IP "Chad Granum <[email protected]>" 4
107 .IX Item "Chad Granum <[email protected]>"
108 .SH AUTHORS
109 .IX Header "AUTHORS"
110 .PD 0
111 .IP "Chad Granum <[email protected]>" 4
112 .IX Item "Chad Granum <[email protected]>"
113 .PD
114 .SH COPYRIGHT
115 .IX Header "COPYRIGHT"
116 Copyright 2016 Chad Granum <[email protected]>.
117 .PP
118 This program is free software; you can redistribute it and/or
119 modify it under the same terms as Perl itself.
120 .PP
121 See \fIhttp://dev.perl.org/licenses/\fR