Debian Codegraph @

upstream/mageia-cauldron/man3pm/vars.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 "vars 3pm"
61 .TH vars 3pm 2023-12-22 "perl v5.42.0" "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 vars \- Perl pragma to predeclare global variable names
68 .SH SYNOPSIS
69 .IX Header "SYNOPSIS"
70 .Vb 1
71 \& use vars qw($frob @mung %seen);
72 .Ve
73 .SH DESCRIPTION
74 .IX Header "DESCRIPTION"
75 NOTE: For use with variables in the current package for a single scope, the
76 functionality provided by this pragma has been superseded by \f(CW\*(C`our\*(C'\fR
77 declarations, available in Perl v5.6.0 or later, and use of this pragma is
78 discouraged. See "our" in perlfunc.
79 .PP
80 This pragma will predeclare all the variables whose names are
81 in the list, allowing you to use them under \f(CW\*(C`use strict\*(C'\fR, and
82 disabling any typo warnings for them.
83 .PP
84 Unlike pragmas that affect the \f(CW$^H\fR hints variable, the \f(CW\*(C`use vars\*(C'\fR and
85 \&\f(CW\*(C`use subs\*(C'\fR declarations are not lexically scoped to the block they appear
86 in: they affect
87 the entire package in which they appear. It is not possible to rescind these
88 declarations with \f(CW\*(C`no vars\*(C'\fR or \f(CW\*(C`no subs\*(C'\fR.
89 .PP
90 Packages such as the \fBAutoLoader\fR and \fBSelfLoader\fR that delay
91 loading of subroutines within packages can create problems with
92 package lexicals defined using \f(CWmy()\fR. While the \fBvars\fR pragma
93 cannot duplicate the effect of package lexicals (total transparency
94 outside of the package), it can act as an acceptable substitute by
95 pre\-declaring global symbols, ensuring their availability to the
96 later\-loaded routines.
97 .PP
98 See "Pragmatic Modules" in perlmodlib.