Debian Codegraph @

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