Debian Codegraph @

upstream/opensuse-tumbleweed/man3/FileCache.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 "FileCache 3pm"
61 .TH FileCache 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 FileCache \- keep more files open than the system permits
68 .SH SYNOPSIS
69 .IX Header "SYNOPSIS"
70 .Vb 1
71 \& no strict \*(Aqrefs\*(Aq;
72 \&
73 \& use FileCache;
74 \& # or
75 \& use FileCache maxopen => 16;
76 \&
77 \& cacheout $mode, $path;
78 \& # or
79 \& cacheout $path;
80 \& print $path @data;
81 \&
82 \& $fh = cacheout $mode, $path;
83 \& # or
84 \& $fh = cacheout $path;
85 \& print $fh @data;
86 .Ve
87 .SH DESCRIPTION
88 .IX Header "DESCRIPTION"
89 The \f(CW\*(C`cacheout\*(C'\fR function will make sure that there\*(Aqs a filehandle open
90 for reading or writing available as the pathname you give it. It
91 automatically closes and re\-opens files if you exceed your system\*(Aqs
92 maximum number of file descriptors, or the suggested maximum \fImaxopen\fR.
93 .IP "cacheout EXPR" 4
94 .IX Item "cacheout EXPR"
95 The 1\-argument form of cacheout will open a file for writing (\f(CW\*(Aq>\*(Aq\fR)
96 on it\*(Aqs first use, and appending (\f(CW\*(Aq>>\*(Aq\fR) thereafter.
97 .Sp
98 Returns EXPR on success for convenience. You may neglect the
99 return value and manipulate EXPR as the filehandle directly if you prefer.
100 .IP "cacheout MODE, EXPR" 4
101 .IX Item "cacheout MODE, EXPR"
102 The 2\-argument form of cacheout will use the supplied mode for the initial
103 and subsequent openings. Most valid modes for 3\-argument \f(CW\*(C`open\*(C'\fR are supported
104 namely; \f(CW\*(Aq>\*(Aq\fR, \f(CW\*(Aq+>\*(Aq\fR, \f(CW\*(Aq<\*(Aq\fR, \f(CW\*(Aq<+\*(Aq\fR, \f(CW\*(Aq>>\*(Aq\fR,
105 \&\f(CW \*(Aq|\-\*(Aq \fR and \f(CW \*(Aq\-|\*(Aq \fR
106 .Sp
107 To pass supplemental arguments to a program opened with \f(CW \*(Aq|\-\*(Aq \fR or \f(CW \*(Aq\-|\*(Aq \fR
108 append them to the command string as you would system EXPR.
109 .Sp
110 Returns EXPR on success for convenience. You may neglect the
111 return value and manipulate EXPR as the filehandle directly if you prefer.
112 .SH CAVEATS
113 .IX Header "CAVEATS"
114 While it is permissible to \f(CW\*(C`close\*(C'\fR a FileCache managed file,
115 do not do so if you are calling \f(CW\*(C`FileCache::cacheout\*(C'\fR from a package other
116 than which it was imported, or with another module which overrides \f(CW\*(C`close\*(C'\fR.
117 If you must, use \f(CW\*(C`FileCache::cacheout_close\*(C'\fR.
118 .PP
119 Although FileCache can be used with piped opens (\*(Aq\-|\*(Aq or \*(Aq|\-\*(Aq) doing so is
120 strongly discouraged. If FileCache finds it necessary to close and then reopen
121 a pipe, the command at the far end of the pipe will be reexecuted \- the results
122 of performing IO on FileCache\*(Aqd pipes is unlikely to be what you expect. The
123 ability to use FileCache on pipes may be removed in a future release.
124 .PP
125 FileCache does not store the current file offset if it finds it necessary to
126 close a file. When the file is reopened, the offset will be as specified by the
127 original \f(CW\*(C`open\*(C'\fR file mode. This could be construed to be a bug.
128 .PP
129 The module functionality relies on symbolic references, so things will break
130 under \*(Aquse strict\*(Aq unless \*(Aqno strict "refs"\*(Aq is also specified.
131 .SH BUGS
132 .IX Header "BUGS"
133 \&\fIsys/param.h\fR lies with its \f(CW\*(C`NOFILE\*(C'\fR define on some systems,
134 so you may have to set \fImaxopen\fR yourself.