.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
.\"
.\" 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
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    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 "read 3pm"
.TH read 3pm "2022-03-24" "perl v5.34.0" "User Contributed Perl Documentation"
.\" 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"
OpaL::read \- Perl extension for reading files and commands.
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\&  use OpaL::read qw(functions);
.Ve
.PP
No functions or variables are exported automaticly so you have to specify
them here.
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
OpaL::read is used for reading files and commands.
.PP
All functions are autoloaded so they will not be loaded into memory if you
have not used them before.
.SH "FUNCTIONS"
.IX Header "FUNCTIONS"
.IP "\fBreadfile\fR" 4
.IX Item "readfile"
Reads the content of the specified file and returns a list with the all lines.
.Sp
\&\s-1USAGE:\s0
    \f(CW@foo\fR = \f(CW\*(C`readfile\*(C'\fR($filename);
.IP "\fBreadfileline\fR" 4
.IX Item "readfileline"
Reads the first line of the specified file and returns a scalar with that line.
.Sp
\&\s-1USAGE:\s0
    \f(CW$foo\fR = \f(CW\*(C`readfileline\*(C'\fR($filename);
.IP "\fBreadscalarfile\fR" 4
.IX Item "readscalarfile"
Reads the content of the specified file and returns a scalar with the entire content.
.Sp
\&\s-1USAGE:\s0
    \f(CW$foo\fR = \f(CW\*(C`readscalarfile\*(C'\fR(\*(L"filename\*(R");
.IP "\fBreadcommand\fR" 4
.IX Item "readcommand"
Reads the content from the output of the specified command and returns a list with the all lines.
.Sp
\&\s-1USAGE:\s0
    \f(CW@foo\fR = \f(CW\*(C`readcommand\*(C'\fR(\*(L"command\*(R");
.IP "\fBreadcommandline\fR" 4
.IX Item "readcommandline"
Reads the first line from output of the specified command and returns a scalar with that line.
.Sp
\&\s-1USAGE:\s0
    \f(CW$foo\fR = \f(CW\*(C`readcommandline\*(C'\fR(\*(L"command)\*(R";
.IP "\fBreadscalarfile\fR" 4
.IX Item "readscalarfile"
Reads the content for the output of the specified file and returns a scalar with the entire content.
.Sp
\&\s-1USAGE:\s0
    \f(CW$foo\fR = \f(CW\*(C`readscalarcommand\*(C'\fR($command);
.SH "AUTHOR"
.IX Header "AUTHOR"
Ola Lundqvist <ola@inguza.com>
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBperl\fR\|(1).