FM / pod

/usr/share/perl5/pod

Name	Size	Mode	Actions
perl.pod	16667	0644	edit dl rm
perl56delta.pod	107201	0644	edit dl rm
perl58delta.pod	115165	0644	edit dl rm
perl561delta.pod	124713	0644	edit dl rm
perl581delta.pod	38060	0644	edit dl rm
perl582delta.pod	4470	0644	edit dl rm
perl583delta.pod	6335	0644	edit dl rm
perl584delta.pod	7363	0644	edit dl rm
perl585delta.pod	5889	0644	edit dl rm
perl586delta.pod	4651	0644	edit dl rm
perl587delta.pod	8357	0644	edit dl rm
perl588delta.pod	25281	0644	edit dl rm
perl589delta.pod	53904	0644	edit dl rm
perl5004delta.pod	56240	0644	edit dl rm
perl5005delta.pod	34283	0644	edit dl rm
perl5100delta.pod	55533	0644	edit dl rm
perl5101delta.pod	43888	0644	edit dl rm
perl5120delta.pod	89271	0644	edit dl rm
perl5121delta.pod	10141	0644	edit dl rm
perl5122delta.pod	9603	0644	edit dl rm
perl5123delta.pod	4100	0644	edit dl rm
perl5124delta.pod	3672	0644	edit dl rm
perl5125delta.pod	7683	0644	edit dl rm
perl5140delta.pod	144325	0644	edit dl rm
perl5141delta.pod	7966	0644	edit dl rm
perl5142delta.pod	6892	0644	edit dl rm
perl5143delta.pod	7760	0644	edit dl rm
perl5144delta.pod	6327	0644	edit dl rm
perl5160delta.pod	133651	0644	edit dl rm
perl5161delta.pod	6142	0644	edit dl rm
perl5162delta.pod	3594	0644	edit dl rm
perl5163delta.pod	4085	0644	edit dl rm
perl5180delta.pod	119429	0644	edit dl rm
perl5181delta.pod	6597	0644	edit dl rm
perl5182delta.pod	5335	0644	edit dl rm
perl5184delta.pod	4642	0644	edit dl rm
perl5200delta.pod	115698	0644	edit dl rm
perl5201delta.pod	10899	0644	edit dl rm
perl5202delta.pod	12509	0644	edit dl rm
perl5203delta.pod	9392	0644	edit dl rm
perl5220delta.pod	130963	0644	edit dl rm
perl5221delta.pod	10767	0644	edit dl rm
perl5222delta.pod	12629	0644	edit dl rm
perl5223delta.pod	8456	0644	edit dl rm
perl5224delta.pod	4460	0644	edit dl rm
perl5240delta.pod	64923	0644	edit dl rm
perl5241delta.pod	8215	0644	edit dl rm
perl5242delta.pod	4113	0644	edit dl rm
perl5243delta.pod	11428	0644	edit dl rm
perl5244delta.pod	4510	0644	edit dl rm
perl5260delta.pod	101835	0644	edit dl rm
perl5261delta.pod	7927	0644	edit dl rm
perl5262delta.pod	7880	0644	edit dl rm
perl5263delta.pod	7067	0644	edit dl rm
perl5280delta.pod	72113	0644	edit dl rm
perl5281delta.pod	4639	0644	edit dl rm
perl5282delta.pod	6200	0644	edit dl rm
perl5283delta.pod	5111	0644	edit dl rm
perl5300delta.pod	41281	0644	edit dl rm
perl5301delta.pod	5730	0644	edit dl rm
perl5302delta.pod	4682	0644	edit dl rm
perl5303delta.pod	4980	0644	edit dl rm
perl5320delta.pod	54601	0644	edit dl rm
perl5321delta.pod	7003	0644	edit dl rm
perlaix.pod	20438	0644	edit dl rm
perlamiga.pod	5749	0644	edit dl rm
perlandroid.pod	8222	0644	edit dl rm
perlapi.pod	493106	0644	edit dl rm
perlapio.pod	21336	0644	edit dl rm
perlartistic.pod	7010	0644	edit dl rm
perlbook.pod	8386	0644	edit dl rm
perlboot.pod	294	0644	edit dl rm
perlbot.pod	304	0644	edit dl rm
perlbs2000.pod	7994	0644	edit dl rm
perlcall.pod	56738	0644	edit dl rm
perlcheat.pod	4480	0644	edit dl rm
perlclib.pod	9607	0644	edit dl rm
perlcn.pod	4763	0644	edit dl rm
perlcommunity.pod	6983	0644	edit dl rm
perlcygwin.pod	27202	0644	edit dl rm
perldata.pod	49782	0644	edit dl rm
perldbmfilter.pod	4981	0644	edit dl rm
perldebguts.pod	42331	0644	edit dl rm
perldebtut.pod	22152	0644	edit dl rm
perldebug.pod	39383	0644	edit dl rm
perldelta.pod	7003	0644	edit dl rm
perldeprecation.pod	20825	0644	edit dl rm
perldiag.pod	296986	0644	edit dl rm
perldos.pod	10522	0644	edit dl rm
perldsc.pod	25614	0644	edit dl rm
perldtrace.pod	7959	0644	edit dl rm
perlebcdic.pod	84345	0644	edit dl rm
perlembed.pod	37569	0644	edit dl rm
perlexperiment.pod	7234	0644	edit dl rm
perlfork.pod	13355	0644	edit dl rm
perlform.pod	16608	0644	edit dl rm
perlfreebsd.pod	1623	0644	edit dl rm
perlfunc.pod	403777	0644	edit dl rm
perlgit.pod	29591	0644	edit dl rm
perlgov.pod	14481	0644	edit dl rm
perlgpl.pod	13815	0644	edit dl rm
perlguts.pod	162103	0644	edit dl rm
perlhack.pod	43157	0644	edit dl rm
perlhacktips.pod	57692	0644	edit dl rm
perlhacktut.pod	6153	0644	edit dl rm
perlhaiku.pod	1508	0644	edit dl rm
perlhist.pod	56164	0644	edit dl rm
perlhpux.pod	30609	0644	edit dl rm
perlhurd.pod	1994	0644	edit dl rm
perlintern.pod	83565	0644	edit dl rm
perlinterp.pod	33715	0644	edit dl rm
perlintro.pod	22135	0644	edit dl rm
perliol.pod	34804	0644	edit dl rm
perlipc.pod	71529	0644	edit dl rm
perlirix.pod	4415	0644	edit dl rm
perljp.pod	8431	0644	edit dl rm
perlko.pod	12208	0644	edit dl rm
perllexwarn.pod	355	0644	edit dl rm
perllinux.pod	2007	0644	edit dl rm
perllocale.pod	74112	0644	edit dl rm
perllol.pod	9580	0644	edit dl rm
perlmacos.pod	998	0644	edit dl rm
perlmacosx.pod	12124	0644	edit dl rm
perlmod.pod	26197	0644	edit dl rm
perlmodinstall.pod	10261	0644	edit dl rm
perlmodlib.pod	76348	0644	edit dl rm
perlmodstyle.pod	22588	0644	edit dl rm
perlmroapi.pod	3280	0644	edit dl rm
perlnetware.pod	6648	0644	edit dl rm
perlnewmod.pod	11037	0644	edit dl rm
perlnumber.pod	8353	0644	edit dl rm
perlobj.pod	35717	0644	edit dl rm
perlootut.pod	26757	0644	edit dl rm
perlop.pod	148888	0644	edit dl rm
perlopenbsd.pod	1224	0644	edit dl rm
perlopentut.pod	15223	0644	edit dl rm
perlos2.pod	93348	0644	edit dl rm
perlos390.pod	16527	0644	edit dl rm
perlos400.pod	4765	0644	edit dl rm
perlpacktut.pod	51370	0644	edit dl rm
perlperf.pod	49881	0644	edit dl rm
perlplan9.pod	5125	0644	edit dl rm
perlpod.pod	23076	0644	edit dl rm
perlpodspec.pod	68628	0644	edit dl rm
perlpolicy.pod	26562	0644	edit dl rm
perlport.pod	88693	0644	edit dl rm
perlpragma.pod	5176	0644	edit dl rm
perlqnx.pod	6673	0644	edit dl rm
perlre.pod	130817	0644	edit dl rm
perlreapi.pod	30245	0644	edit dl rm
perlrebackslash.pod	32285	0644	edit dl rm
perlrecharclass.pod	49707	0644	edit dl rm
perlref.pod	35432	0644	edit dl rm
perlreftut.pod	18826	0644	edit dl rm
perlreguts.pod	39301	0644	edit dl rm
perlrepository.pod	509	0644	edit dl rm
perlrequick.pod	19141	0644	edit dl rm
perlreref.pod	15590	0644	edit dl rm
perlretut.pod	122527	0644	edit dl rm
perlriscos.pod	1529	0644	edit dl rm
perlrun.pod	55980	0644	edit dl rm
perlsec.pod	27601	0644	edit dl rm
perlsecpolicy.pod	19450	0644	edit dl rm
perlsolaris.pod	29843	0644	edit dl rm
perlsource.pod	7132	0644	edit dl rm
perlstyle.pod	8734	0644	edit dl rm
perlsub.pod	74405	0644	edit dl rm
perlsymbian.pod	15344	0644	edit dl rm
perlsyn.pod	45138	0644	edit dl rm
perlsynology.pod	7960	0644	edit dl rm
perlthrtut.pod	46522	0644	edit dl rm
perltie.pod	39314	0644	edit dl rm
perltoc.pod	701800	0644	edit dl rm
perltodo.pod	372	0644	edit dl rm
perltooc.pod	294	0644	edit dl rm
perltoot.pod	294	0644	edit dl rm
perltrap.pod	10623	0644	edit dl rm
perltru64.pod	8492	0644	edit dl rm
perltw.pod	4463	0644	edit dl rm
perlunicode.pod	91353	0644	edit dl rm
perlunicook.pod	25658	0644	edit dl rm
perlunifaq.pod	13644	0644	edit dl rm
perluniintro.pod	38647	0644	edit dl rm
perluniprops.pod	441614	0644	edit dl rm
perlunitut.pod	7951	0644	edit dl rm
perlutil.pod	7291	0644	edit dl rm
perlvar.pod	82577	0644	edit dl rm
perlvms.pod	50823	0644	edit dl rm
perlvos.pod	3843	0644	edit dl rm
perlwin32.pod	40317	0644	edit dl rm

Edit: /usr/share/perl5/pod/perlopentut.pod (15223B)

=encoding utf8

=head1 NAME

perlopentut - simple recipes for opening files and pipes in Perl

=head1 DESCRIPTION

Whenever you do I/O on a file in Perl, you do so through what in Perl is
called a B<filehandle>.  A filehandle is an internal name for an external
file.  It is the job of the C<open> function to make the association
between the internal name and the external name, and it is the job
of the C<close> function to break that association.

For your convenience, Perl sets up a few special filehandles that are
already open when you run.  These include C<STDIN>, C<STDOUT>, C<STDERR>,
and C<ARGV>.  Since those are pre-opened, you can use them right away
without having to go to the trouble of opening them yourself:

print STDERR "This is a debugging message.\n";

print STDOUT "Please enter something: ";
    $response = <STDIN> // die "how come no input?";
    print STDOUT "Thank you!\n";

while (<ARGV>) { ... }

As you see from those examples, C<STDOUT> and C<STDERR> are output
handles, and C<STDIN> and C<ARGV> are input handles.  They are
in all capital letters because they are reserved to Perl, much
like the C<@ARGV> array and the C<%ENV> hash are.  Their external
associations were set up by your shell.

You will need to open every other filehandle on your own. Although there
are many variants, the most common way to call Perl's open() function
is with three arguments and one return value:

C<    I<OK> = open(I<HANDLE>, I<MODE>, I<PATHNAME>)>

Where:

=over

=item I<OK>

will be some defined value if the open succeeds, but
C<undef> if it fails;

=item I<HANDLE>

should be an undefined scalar variable to be filled in by the
C<open> function if it succeeds;

=item I<MODE>

is the access mode and the encoding format to open the file with;

=item I<PATHNAME>

is the external name of the file you want opened.

=back

Most of the complexity of the C<open> function lies in the many
possible values that the I<MODE> parameter can take on.

One last thing before we show you how to open files: opening
files does not (usually) automatically lock them in Perl.  See
L<perlfaq5> for how to lock.

=head1 Opening Text Files

=head2 Opening Text Files for Reading

If you want to read from a text file, first open it in
read-only mode like this:

my $filename = "/some/path/to/a/textfile/goes/here";
    my $encoding = ":encoding(UTF-8)";
    my $handle   = undef;     # this will be filled in on success

open($handle, "< $encoding", $filename)
        || die "$0: can't open $filename for reading: $!";

As with the shell, in Perl the C<< "<" >> is used to open the file in
read-only mode.  If it succeeds, Perl allocates a brand new filehandle for
you and fills in your previously undefined C<$handle> argument with a
reference to that handle.

Now you may use functions like C<readline>, C<read>, C<getc>, and
C<sysread> on that handle.  Probably the most common input function
is the one that looks like an operator:

$line = readline($handle);
    $line = <$handle>;          # same thing

Because the C<readline> function returns C<undef> at end of file or
upon error, you will sometimes see it used this way:

$line = <$handle>;
    if (defined $line) {
        # do something with $line
    }
    else {
        # $line is not valid, so skip it
    }

You can also just quickly C<die> on an undefined value this way:

$line = <$handle> // die "no input found";

However, if hitting EOF is an expected and normal event, you do not want to
exit simply because you have run out of input.  Instead, you probably just want
to exit an input loop.  You can then test to see if an actual error has caused
the loop to terminate, and act accordingly:

while (<$handle>) {
        # do something with data in $_
    }
    if ($!) {
        die "unexpected error while reading from $filename: $!";
    }

B<A Note on Encodings>: Having to specify the text encoding every time
might seem a bit of a bother.  To set up a default encoding for C<open> so
that you don't have to supply it each time, you can use the C<open> pragma:

use open qw< :encoding(UTF-8) >;

Once you've done that, you can safely omit the encoding part of the
open mode:

open($handle, "<", $filename)
        || die "$0: can't open $filename for reading: $!";

But never use the bare C<< "<" >> without having set up a default encoding
first.  Otherwise, Perl cannot know which of the many, many, many possible
flavors of text file you have, and Perl will have no idea how to correctly
map the data in your file into actual characters it can work with.  Other
common encoding formats including C<"ASCII">, C<"ISO-8859-1">,
C<"ISO-8859-15">, C<"Windows-1252">, C<"MacRoman">, and even C<"UTF-16LE">.
See L<perlunitut> for more about encodings.

=head2 Opening Text Files for Writing

When you want to write to a file, you first have to decide what to do about
any existing contents of that file.  You have two basic choices here: to
preserve or to clobber.

If you want to preserve any existing contents, then you want to open the file
in append mode.  As in the shell, in Perl you use C<<< ">>" >>> to open an
existing file in append mode.  C<<< ">>" >>> creates the file if it does not
already exist.

my $handle   = undef;
    my $filename = "/some/path/to/a/textfile/goes/here";
    my $encoding = ":encoding(UTF-8)";

open($handle, ">> $encoding", $filename)
        || die "$0: can't open $filename for appending: $!";

Now you can write to that filehandle using any of C<print>, C<printf>,
C<say>, C<write>, or C<syswrite>.

As noted above, if the file does not already exist, then the append-mode open
will create it for you.  But if the file does already exist, its contents are
safe from harm because you will be adding your new text past the end of the
old text.

On the other hand, sometimes you want to clobber whatever might already be
there.  To empty out a file before you start writing to it, you can open it
in write-only mode:

my $handle   = undef;
    my $filename = "/some/path/to/a/textfile/goes/here";
    my $encoding = ":encoding(UTF-8)";

open($handle, "> $encoding", $filename)
        || die "$0: can't open $filename in write-open mode: $!";

Here again Perl works just like the shell in that the C<< ">" >> clobbers
an existing file.

As with the append mode, when you open a file in write-only mode,
you can now write to that filehandle using any of C<print>, C<printf>,
C<say>, C<write>, or C<syswrite>.

What about read-write mode?  You should probably pretend it doesn't exist,
because opening text files in read-write mode is unlikely to do what you
would like.  See L<perlfaq5> for details.

=head1 Opening Binary Files

If the file to be opened contains binary data instead of text characters,
then the C<MODE> argument to C<open> is a little different.  Instead of
specifying the encoding, you tell Perl that your data are in raw bytes.

my $filename = "/some/path/to/a/binary/file/goes/here";
    my $encoding = ":raw :bytes"
    my $handle   = undef;     # this will be filled in on success

And then open as before, choosing C<<< "<" >>>, C<<< ">>" >>>, or
C<<< ">" >>> as needed:

open($handle, "< $encoding", $filename)
        || die "$0: can't open $filename for reading: $!";

open($handle, ">> $encoding", $filename)
        || die "$0: can't open $filename for appending: $!";

open($handle, "> $encoding", $filename)
        || die "$0: can't open $filename in write-open mode: $!";

Alternately, you can change to binary mode on an existing handle this way:

binmode($handle)    || die "cannot binmode handle";

This is especially handy for the handles that Perl has already opened for you.

binmode(STDIN)      || die "cannot binmode STDIN";
    binmode(STDOUT)     || die "cannot binmode STDOUT";

You can also pass C<binmode> an explicit encoding to change it on the fly.
This isn't exactly "binary" mode, but we still use C<binmode> to do it:

binmode(STDIN,  ":encoding(MacRoman)") || die "cannot binmode STDIN";
  binmode(STDOUT, ":encoding(UTF-8)")    || die "cannot binmode STDOUT";

Once you have your binary file properly opened in the right mode, you can
use all the same Perl I/O functions as you used on text files.  However,
you may wish to use the fixed-size C<read> instead of the variable-sized
C<readline> for your input.

Here's an example of how to copy a binary file:

my $BUFSIZ   = 64 * (2 ** 10);
    my $name_in  = "/some/input/file";
    my $name_out = "/some/output/flie";

my($in_fh, $out_fh, $buffer);

open($in_fh,  "<", $name_in)
        || die "$0: cannot open $name_in for reading: $!";
    open($out_fh, ">", $name_out)
        || die "$0: cannot open $name_out for writing: $!";

for my $fh ($in_fh, $out_fh)  {
        binmode($fh)               || die "binmode failed";
    }

while (read($in_fh, $buffer, $BUFSIZ)) {
        unless (print $out_fh $buffer) {
            die "couldn't write to $name_out: $!";
        }
    }

close($in_fh)       || die "couldn't close $name_in: $!";
    close($out_fh)      || die "couldn't close $name_out: $!";

=head1 Opening Pipes

Perl also lets you open a filehandle into an external program or shell
command rather than into a file. You can do this in order to pass data
from your Perl program to an external command for further processing, or
to receive data from another program for your own Perl program to
process.

Filehandles into commands are also known as I<pipes>, since they work on
similar inter-process communication principles as Unix pipelines. Such a
filehandle has an active program instead of a static file on its
external end, but in every other sense it works just like a more typical
file-based filehandle, with all the techniques discussed earlier in this
article just as applicable.

As such, you open a pipe using the same C<open> call that you use for
opening files, setting the second (C<MODE>) argument to special
characters that indicate either an input or an output pipe. Use C<"-|"> for a
filehandle that will let your Perl program read data from an external
program, and C<"|-"> for a filehandle that will send data to that
program instead.

=head2 Opening a pipe for reading

Let's say you'd like your Perl program to process data stored in a nearby
directory called C<unsorted>, which contains a number of textfiles.
You'd also like your program to sort all the contents from these files
into a single, alphabetically sorted list of unique lines before it
starts processing them.

You could do this through opening an ordinary filehandle into each of
those files, gradually building up an in-memory array of all the file
contents you load this way, and finally sorting and filtering that array
when you've run out of files to load. I<Or>, you could offload all that
merging and sorting into your operating system's own C<sort> command by
opening a pipe directly into its output, and get to work that much
faster.

Here's how that might look:

open(my $sort_fh, '-|', 'sort -u unsorted/*.txt')
        or die "Couldn't open a pipe into sort: $!";

# And right away, we can start reading sorted lines:
    while (my $line = <$sort_fh>) {
        #
        # ... Do something interesting with each $line here ...
        #
    }

The second argument to C<open>, C<"-|">, makes it a read-pipe into a
separate program, rather than an ordinary filehandle into a file.

Note that the third argument to C<open> is a string containing the
program name (C<sort>) plus all its arguments: in this case, C<-u> to
specify unqiue sort, and then a fileglob specifying the files to sort.
The resulting filehandle C<$sort_fh> works just like a read-only (C<<
"<" >>) filehandle, and your program can subsequently read data
from it as if it were opened onto an ordinary, single file.

=head2 Opening a pipe for writing

Continuing the previous example, let's say that your program has
completed its processing, and the results sit in an array called
C<@processed>. You want to print these lines to a file called
C<numbered.txt> with a neatly formatted column of line-numbers.

Certainly you could write your own code to do this — or, once again,
you could kick that work over to another program. In this case, C<cat>,
running with its own C<-n> option to activate line numbering, should do
the trick:

open(my $cat_fh, '|-', 'cat -n > numbered.txt')
        or die "Couldn't open a pipe into cat: $!";

for my $line (@processed) {
        print $cat_fh $line;
    }

Here, we use a second C<open> argument of C<"|-">, signifying that the
filehandle assigned to C<$cat_fh> should be a write-pipe. We can then
use it just as we would a write-only ordinary filehandle, including the
basic function of C<print>-ing data to it.

Note that the third argument, specifying the command that we wish to
pipe to, sets up C<cat> to redirect its output via that C<< ">" >>
symbol into the file C<numbered.txt>. This can start to look a little
tricky, because that same symbol would have meant something
entirely different had it showed it in the second argument to C<open>!
But here in the third argument, it's simply part of the shell command that
Perl will open the pipe into, and Perl itself doesn't invest any special
meaning to it.

=head2 Expressing the command as a list

For opening pipes, Perl offers the option to call C<open> with a list
comprising the desired command and all its own arguments as separate
elements, rather than combining them into a single string as in the
examples above. For instance, we could have phrased the C<open> call in
the first example like this:

open(my $sort_fh, '-|', 'sort', '-u', glob('unsorted/*.txt'))
        or die "Couldn't open a pipe into sort: $!";

When you call C<open> this way, Perl invokes the given command directly,
bypassing the shell. As such, the shell won't try to interpret any
special characters within the command's argument list, which might
overwise have unwanted effects. This can make for safer, less
error-prone C<open> calls, useful in cases such as passing in variables
as arguments, or even just referring to filenames with spaces in them.

However, when you I<do> want to pass a meaningful metacharacter to the
shell, such with the C<"*"> inside that final C<unsorted/*.txt> argument
here, you can't use this alternate syntax. In this case, we have worked
around it via Perl's handy C<glob> built-in function, which evaluates
its argument into a list of filenames — and we can safely pass that
resulting list right into C<open>, as shown above.

Note also that representing piped-command arguments in list form like
this doesn't work on every platform. It will work on any Unix-based OS
that provides a real C<fork> function (e.g. macOS or Linux), as well as
on Windows when running Perl 5.22 or later.

=head1 SEE ALSO

The full documentation for L<C<open>|perlfunc/open FILEHANDLE,MODE,EXPR>
provides a thorough reference to this function, beyond the best-practice
basics covered here.

=head1 AUTHOR and COPYRIGHT

This documentation is free; you can redistribute it and/or modify it under
the same terms as Perl itself.

cmd: