Debian Codegraph @

upstream/mageia-cauldron/man3pm/SelectSaver.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 "SelectSaver 3pm"
61 .TH SelectSaver 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 SelectSaver \- save and restore selected file handle
68 .SH SYNOPSIS
69 .IX Header "SYNOPSIS"
70 .Vb 1
71 \& use SelectSaver;
72 \&
73 \& {
74 \& my $saver = SelectSaver\->new(FILEHANDLE);
75 \& # FILEHANDLE is selected
76 \& }
77 \& # previous handle is selected
78 \&
79 \& {
80 \& my $saver = SelectSaver\->new;
81 \& # new handle may be selected, or not
82 \& }
83 \& # previous handle is selected
84 .Ve
85 .SH DESCRIPTION
86 .IX Header "DESCRIPTION"
87 A \f(CW\*(C`SelectSaver\*(C'\fR object contains a reference to the file handle that
88 was selected when it was created. If its \f(CW\*(C`new\*(C'\fR method gets an extra
89 parameter, then that parameter is selected; otherwise, the selected
90 file handle remains unchanged.
91 .PP
92 When a \f(CW\*(C`SelectSaver\*(C'\fR is destroyed, it re\-selects the file handle
93 that was selected when it was created.