Debian Codegraph @

upstream/opensuse-tumbleweed/man3/Term::Table::Util.3pm

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man v6.0.2 (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 .\" Required to disable full justification in groff 1.23.0.
57 .if n .ds AD l
58 .\" ========================================================================
59 .\"
60 .IX Title "Term::Table::Util 3pm"
61 .TH Term::Table::Util 3pm 2026-03-09 "perl v5.42.1" "Perl Programmers Reference Guide"
62 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
63 .\" way too many mistakes in technical documents.
64 .if n .ad l
65 .nh
66 .SH NAME
67 Term::Table::Util \- Utilities for Term::Table.
68 .SH DESCRIPTION
69 .IX Header "DESCRIPTION"
70 This package exports some tools used by Term::Table.
71 .SH EXPORTS
72 .IX Header "EXPORTS"
73 .SS CONSTANTS
74 .IX Subsection "CONSTANTS"
75 .ie n .IP "$bool = USE_GCS" 4
76 .el .IP "\f(CW$bool\fR = USE_GCS" 4
77 .IX Item "$bool = USE_GCS"
78 True if Unicode::GCString is installed.
79 .ie n .IP "$bool = USE_TERM_READKEY" 4
80 .el .IP "\f(CW$bool\fR = USE_TERM_READKEY" 4
81 .IX Item "$bool = USE_TERM_READKEY"
82 True if Term::ReadKey is installed.
83 .SS UTILITIES
84 .IX Subsection "UTILITIES"
85 .ie n .IP "$width = \fBterm_size()\fR" 4
86 .el .IP "\f(CW$width\fR = \fBterm_size()\fR" 4
87 .IX Item "$width = term_size()"
88 Get the width of the terminal.
89 .Sp
90 If the \f(CW$TABLE_TERM_SIZE\fR environment variable is set then that value will be
91 returned.
92 .Sp
93 This will default to 80 if there is no good way to get the size, or if the size
94 is unreasonably small.
95 .Sp
96 If Term::ReadKey is installed it will be used.
97 .ie n .IP "$width = uni_length($string)" 4
98 .el .IP "\f(CW$width\fR = uni_length($string)" 4
99 .IX Item "$width = uni_length($string)"
100 Get the width (in columns) of the specified string. When Unicode::GCString
101 is installed this will work on unicode strings, otherwise it will just use
102 \&\f(CWlength($string)\fR.
103 .SH SOURCE
104 .IX Header "SOURCE"
105 The source code repository for Term\-Table can be found at
106 \&\fIhttp://github.com/exodist/Term\-Table/\fR.
107 .SH MAINTAINERS
108 .IX Header "MAINTAINERS"
109 .IP "Chad Granum <[email protected]>" 4
110 .IX Item "Chad Granum <[email protected]>"
111 .SH AUTHORS
112 .IX Header "AUTHORS"
113 .IP "Chad Granum <[email protected]>" 4
114 .IX Item "Chad Granum <[email protected]>"
115 .SH COPYRIGHT
116 .IX Header "COPYRIGHT"
117 Copyright 2016 Chad Granum <[email protected]>.
118 .PP
119 This program is free software; you can redistribute it and/or
120 modify it under the same terms as Perl itself.
121 .PP
122 See \fIhttp://dev.perl.org/licenses/\fR