summaryrefslogtreecommitdiffstats
path: root/upstream/debian-unstable/man3/IO::File.3perl
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-15 19:43:11 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-15 19:43:11 +0000
commitfc22b3d6507c6745911b9dfcc68f1e665ae13dbc (patch)
treece1e3bce06471410239a6f41282e328770aa404a /upstream/debian-unstable/man3/IO::File.3perl
parentInitial commit. (diff)
downloadmanpages-l10n-fc22b3d6507c6745911b9dfcc68f1e665ae13dbc.tar.xz
manpages-l10n-fc22b3d6507c6745911b9dfcc68f1e665ae13dbc.zip
Adding upstream version 4.22.0.upstream/4.22.0
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'upstream/debian-unstable/man3/IO::File.3perl')
-rw-r--r--upstream/debian-unstable/man3/IO::File.3perl167
1 files changed, 167 insertions, 0 deletions
diff --git a/upstream/debian-unstable/man3/IO::File.3perl b/upstream/debian-unstable/man3/IO::File.3perl
new file mode 100644
index 00000000..1165c0b8
--- /dev/null
+++ b/upstream/debian-unstable/man3/IO::File.3perl
@@ -0,0 +1,167 @@
+.\" -*- mode: troff; coding: utf-8 -*-
+.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
+.\"
+.\" Standard preamble:
+.\" ========================================================================
+.de Sp \" Vertical space (when we can't use .PP)
+.if t .sp .5v
+.if n .sp
+..
+.de Vb \" Begin verbatim text
+.ft CW
+.nf
+.ne \\$1
+..
+.de Ve \" End verbatim text
+.ft R
+.fi
+..
+.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
+.ie n \{\
+. ds C` ""
+. ds C' ""
+'br\}
+.el\{\
+. ds C`
+. ds C'
+'br\}
+.\"
+.\" Escape single quotes in literal strings from groff's Unicode transform.
+.ie \n(.g .ds Aq \(aq
+.el .ds Aq '
+.\"
+.\" If the F register is >0, we'll generate index entries on stderr for
+.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
+.\" entries marked with X<> in POD. Of course, you'll have to process the
+.\" output yourself in some meaningful fashion.
+.\"
+.\" Avoid warning from groff about undefined register 'F'.
+.de IX
+..
+.nr rF 0
+.if \n(.g .if rF .nr rF 1
+.if (\n(rF:(\n(.g==0)) \{\
+. if \nF \{\
+. de IX
+. tm Index:\\$1\t\\n%\t"\\$2"
+..
+. if !\nF==2 \{\
+. nr % 0
+. nr F 2
+. \}
+. \}
+.\}
+.rr rF
+.\" ========================================================================
+.\"
+.IX Title "IO::File 3perl"
+.TH IO::File 3perl 2024-01-12 "perl v5.38.2" "Perl Programmers Reference Guide"
+.\" For nroff, turn off justification. Always turn off hyphenation; it makes
+.\" way too many mistakes in technical documents.
+.if n .ad l
+.nh
+.SH NAME
+IO::File \- supply object methods for filehandles
+.SH SYNOPSIS
+.IX Header "SYNOPSIS"
+.Vb 1
+\& use IO::File;
+\&
+\& my $fh = IO::File\->new();
+\& if ($fh\->open("< file")) {
+\& print <$fh>;
+\& $fh\->close;
+\& }
+\&
+\& my $fh = IO::File\->new("> file");
+\& if (defined $fh) {
+\& print $fh "bar\en";
+\& $fh\->close;
+\& }
+\&
+\& my $fh = IO::File\->new("file", "r");
+\& if (defined $fh) {
+\& print <$fh>;
+\& undef $fh; # automatically closes the file
+\& }
+\&
+\& my $fh = IO::File\->new("file", O_WRONLY|O_APPEND);
+\& if (defined $fh) {
+\& print $fh "corge\en";
+\&
+\& my $pos = $fh\->getpos;
+\& $fh\->setpos($pos);
+\&
+\& undef $fh; # automatically closes the file
+\& }
+\&
+\& autoflush STDOUT 1;
+.Ve
+.SH DESCRIPTION
+.IX Header "DESCRIPTION"
+\&\f(CW\*(C`IO::File\*(C'\fR inherits from \f(CW\*(C`IO::Handle\*(C'\fR and \f(CW\*(C`IO::Seekable\*(C'\fR. It extends
+these classes with methods that are specific to file handles.
+.SH CONSTRUCTOR
+.IX Header "CONSTRUCTOR"
+.IP "new ( FILENAME [,MODE [,PERMS]] )" 4
+.IX Item "new ( FILENAME [,MODE [,PERMS]] )"
+Creates an \f(CW\*(C`IO::File\*(C'\fR. If it receives any parameters, they are passed to
+the method \f(CW\*(C`open\*(C'\fR; if the open fails, the object is destroyed. Otherwise,
+it is returned to the caller.
+.IP new_tmpfile 4
+.IX Item "new_tmpfile"
+Creates an \f(CW\*(C`IO::File\*(C'\fR opened for read/write on a newly created temporary
+file. On systems where this is possible, the temporary file is anonymous
+(i.e. it is unlinked after creation, but held open). If the temporary
+file cannot be created or opened, the \f(CW\*(C`IO::File\*(C'\fR object is destroyed.
+Otherwise, it is returned to the caller.
+.SH METHODS
+.IX Header "METHODS"
+.IP "open( FILENAME [,MODE [,PERMS]] )" 4
+.IX Item "open( FILENAME [,MODE [,PERMS]] )"
+.PD 0
+.IP "open( FILENAME, IOLAYERS )" 4
+.IX Item "open( FILENAME, IOLAYERS )"
+.PD
+\&\f(CW\*(C`open\*(C'\fR accepts one, two or three parameters. With one parameter,
+it is just a front end for the built-in \f(CW\*(C`open\*(C'\fR function. With two or three
+parameters, the first parameter is a filename that may include
+whitespace or other special characters, and the second parameter is
+the open mode, optionally followed by a file permission value.
+.Sp
+If \f(CW\*(C`IO::File::open\*(C'\fR receives a Perl mode string (">", "+<", etc.)
+or an ANSI C \fBfopen()\fR mode string ("w", "r+", etc.), it uses the basic
+Perl \f(CW\*(C`open\*(C'\fR operator (but protects any special characters).
+.Sp
+If \f(CW\*(C`IO::File::open\*(C'\fR is given a numeric mode, it passes that mode
+and the optional permissions value to the Perl \f(CW\*(C`sysopen\*(C'\fR operator.
+The permissions default to 0666.
+.Sp
+If \f(CW\*(C`IO::File::open\*(C'\fR is given a mode that includes the \f(CW\*(C`:\*(C'\fR character,
+it passes all the three arguments to the three-argument \f(CW\*(C`open\*(C'\fR operator.
+.Sp
+For convenience, \f(CW\*(C`IO::File\*(C'\fR exports the O_XXX constants from the
+Fcntl module, if this module is available.
+.IP "binmode( [LAYER] )" 4
+.IX Item "binmode( [LAYER] )"
+\&\f(CW\*(C`binmode\*(C'\fR sets \f(CW\*(C`binmode\*(C'\fR on the underlying \f(CW\*(C`IO\*(C'\fR object, as documented
+in \f(CW\*(C`perldoc \-f binmode\*(C'\fR.
+.Sp
+\&\f(CW\*(C`binmode\*(C'\fR accepts one optional parameter, which is the layer to be
+passed on to the \f(CW\*(C`binmode\*(C'\fR call.
+.SH NOTE
+.IX Header "NOTE"
+Some operating systems may perform \f(CWIO::File::new()\fR or \f(CWIO::File::open()\fR
+on a directory without errors. This behavior is not portable and not
+suggested for use. Using \f(CWopendir()\fR and \f(CWreaddir()\fR or \f(CW\*(C`IO::Dir\*(C'\fR are
+suggested instead.
+.SH "SEE ALSO"
+.IX Header "SEE ALSO"
+perlfunc,
+"I/O Operators" in perlop,
+IO::Handle,
+IO::Seekable,
+IO::Dir
+.SH HISTORY
+.IX Header "HISTORY"
+Derived from FileHandle.pm by Graham Barr <\fIgbarr@pobox.com\fR>.