.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
.\" ========================================================================
.de Sh \" Subsection heading
.de Sp \" Vertical space (when we can't use .PP)
.de Vb \" Begin verbatim text
.de Ve \" End verbatim text
.\" 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. | will give a
.\" real vertical bar. \*(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<>.
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
. 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
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD. Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
. tm Index:\\$1\t\\n%\t"\\$2"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
. \" simple accents for nroff and troff
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
. \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
. \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
. \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
.\" ========================================================================
.TH PERLINTRO 1 "2006-01-07" "perl v5.8.8" "Perl Programmers Reference Guide"
perlintro \-\- a brief introduction and overview of Perl
This document is intended to give you a quick overview of the Perl
programming language, along with pointers to further documentation. It
is intended as a \*(L"bootstrap\*(R" guide for those who are new to the
language, and provides just enough information for you to be able to
read other peoples' Perl and understand roughly what it's doing, or
write your own simple scripts.
This introductory document does not aim to be complete. It does not
even aim to be entirely accurate. In some cases perfection has been
sacrificed in the goal of getting the general idea across. You are
\&\fIstrongly\fR advised to follow this introduction with more information
from the full Perl manual, the table of contents to which can be found
Throughout this document you'll see references to other parts of the
Perl documentation. You can read that documentation using the \f(CW\*(C`perldoc\*(C'\fR
command or whatever method you're using to read this document.
.IX Subsection "What is Perl?"
Perl is a general-purpose programming language originally developed for
text manipulation and now used for a wide range of tasks including
system administration, web development, network programming, \s-1GUI\s0
The language is intended to be practical (easy to use, efficient,
complete) rather than beautiful (tiny, elegant, minimal). Its major
features are that it's easy to use, supports both procedural and
object-oriented (\s-1OO\s0) programming, has powerful built-in support for text
processing, and has one of the world's most impressive collections of
Different definitions of Perl are given in perl, perlfaq1 and
no doubt other places. From this we can determine that Perl is different
things to different people, but that lots of people think it's at least
.Sh "Running Perl programs"
.IX Subsection "Running Perl programs"
To run a Perl program from the Unix command line:
Alternatively, put this as the first line of your script:
\&... and run the script as \f(CW\*(C`/path/to/script.pl\*(C'\fR. Of course, it'll need
to be executable first, so \f(CW\*(C`chmod 755 script.pl\*(C'\fR (under Unix).
For more information, including instructions for other platforms such as
Windows and Mac \s-1OS\s0, read perlrun.
.Sh "Basic syntax overview"
.IX Subsection "Basic syntax overview"
A Perl script or program consists of one or more statements. These
statements are simply written in the script in a straightforward
fashion. There is no need to have a \f(CW\*(C`main()\*(C'\fR function or anything of
Perl statements end in a semi\-colon:
Comments start with a hash symbol and run to the end of the line
Whitespace is irrelevant:
\&... except inside quoted strings:
\& # this would print with a linebreak in the middle
Double quotes or single quotes may be used around literal strings:
However, only double quotes \*(L"interpolate\*(R" variables and special
characters such as newlines (\f(CW\*(C`\en\*(C'\fR):
\& print "Hello, $name\en"; # works fine
\& print 'Hello, $name\en'; # prints $name\en literally
Numbers don't need quotes around them:
You can use parentheses for functions' arguments or omit them
according to your personal taste. They are only required
occasionally to clarify issues of precedence.
\& print("Hello, world\en");
\& print "Hello, world\en";
More detailed information about Perl syntax can be found in perlsyn.
.Sh "Perl variable types"
.IX Subsection "Perl variable types"
Perl has three main variable types: scalars, arrays, and hashes.
A scalar represents a single value:
Scalar values can be strings, integers or floating point numbers, and Perl
will automatically convert between them as required. There is no need
to pre-declare your variable types.
Scalar values can be used in various ways:
\& print "The animal is $animal\en";
\& print "The square of $answer is ", $answer * $answer, "\en";
There are a number of \*(L"magic\*(R" scalars with names that look like
punctuation or line noise. These special variables are used for all
kinds of purposes, and are documented in perlvar. The only one you
need to know about for now is \f(CW$_\fR which is the \*(L"default variable\*(R".
It's used as the default argument to a number of functions in Perl, and
it's set implicitly by certain looping constructs.
\& print; # prints contents of $_ by default
An array represents a list of values:
\& my @animals = ("camel", "llama", "owl");
\& my @numbers = (23, 42, 69);
\& my @mixed = ("camel", 42, 1.23);
Arrays are zero\-indexed. Here's how you get at elements in an array:
\& print $animals[0]; # prints "camel"
\& print $animals[1]; # prints "llama"
The special variable \f(CW$#array\fR tells you the index of the last element
\& print $mixed[$#mixed]; # last element, prints 1.23
You might be tempted to use \f(CW\*(C`$#array + 1\*(C'\fR to tell you how many items there
are in an array. Don't bother. As it happens, using \f(CW@array\fR where Perl
expects to find a scalar value (\*(L"in scalar context\*(R") will give you the number
of elements in the array:
\& if (@animals < 5) { ... }
The elements we're getting from the array start with a \f(CW\*(C`$\*(C'\fR because
we're getting just a single value out of the array \*(-- you ask for a scalar,
To get multiple values from an array:
\& @animals[0,1]; # gives ("camel", "llama");
\& @animals[0..2]; # gives ("camel", "llama", "owl");
\& @animals[1..$#animals]; # gives all except the first element
This is called an \*(L"array slice\*(R".
You can do various useful things to lists:
\& my @sorted = sort @animals;
\& my @backwards = reverse @numbers;
There are a couple of special arrays too, such as \f(CW@ARGV\fR (the command
line arguments to your script) and \f(CW@_\fR (the arguments passed to a
subroutine). These are documented in perlvar.
A hash represents a set of key/value pairs:
\& my %fruit_color = ("apple", "red", "banana", "yellow");
You can use whitespace and the \f(CW\*(C`=>\*(C'\fR operator to lay them out more
\& $fruit_color{"apple"}; # gives "red"
You can get at lists of keys and values with \f(CW\*(C`keys()\*(C'\fR and
\&\f(CW\*(C`values()\*(C'\fR.
\& my @fruits = keys %fruit_colors;
\& my @colors = values %fruit_colors;
Hashes have no particular internal order, though you can sort the keys
Just like special scalars and arrays, there are also special hashes.
The most well known of these is \f(CW%ENV\fR which contains environment
variables. Read all about it (and other special variables) in
Scalars, arrays and hashes are documented more fully in perldata.
More complex data types can be constructed using references, which allow
you to build lists and hashes within lists and hashes.
A reference is a scalar value and can refer to any other Perl data
type. So by storing a reference as the value of an array or hash
element, you can easily create lists and hashes within lists and
hashes. The following example shows a 2 level hash of hash
structure using anonymous hash references.
\& description => "single item",
\& description => "ordered list of items",
\& description => "key/value pairs",
\& print "Scalars begin with a $variables->{'scalar'}->{'sigil'}\en";
Exhaustive information on the topic of references can be found in
perlreftut, perllol, perlref and perldsc.
.IX Subsection "Variable scoping"
Throughout the previous section all the examples have used the syntax:
The \f(CW\*(C`my\*(C'\fR is actually not required; you could just use:
However, the above usage will create global variables throughout your
program, which is bad programming practice. \f(CW\*(C`my\*(C'\fR creates lexically
scoped variables instead. The variables are scoped to the block
(i.e. a bunch of statements surrounded by curly\-braces) in which they
\& if ($some_condition) {
\& print $a; # prints "foo"
\& print $b; # prints "bar"
\& print $a; # prints "foo"
\& print $b; # prints nothing; $b has fallen out of scope
Using \f(CW\*(C`my\*(C'\fR in combination with a \f(CW\*(C`use strict;\*(C'\fR at the top of
your Perl scripts means that the interpreter will pick up certain common
programming errors. For instance, in the example above, the final
\&\f(CW\*(C`print $b\*(C'\fR would cause a compile-time error and prevent you from
running the program. Using \f(CW\*(C`strict\*(C'\fR is highly recommended.
.Sh "Conditional and looping constructs"
.IX Subsection "Conditional and looping constructs"
Perl has most of the usual conditional and looping constructs except for
case/switch (but if you really want it, there is a Switch module in Perl
5.8 and newer, and on \s-1CPAN\s0. See the section on modules, below, for more
information about modules and \s-1CPAN\s0).
The conditions can be any Perl expression. See the list of operators in
the next section for information on comparison and boolean logic operators,
which are commonly used in conditional statements.
\& } elsif ( other condition ) {
There's also a negated version of it:
\& unless ( condition ) {
This is provided as a more readable version of \f(CW\*(C`if (!\f(CIcondition\f(CW)\*(C'\fR.
Note that the braces are required in Perl, even if you've only got one
line in the block. However, there is a clever way of making your one-line
conditional blocks more English like:
\& # the Perlish post-condition way
\& print "Yow!" if $zippy;
\& print "We have no bananas" unless $bananas;
There's also a negated version, for the same reason we have \f(CW\*(C`unless\*(C'\fR:
You can also use \f(CW\*(C`while\*(C'\fR in a post\-condition:
\& print "LA LA LA\en" while 1; # loops forever
\& for ($i=0; $i <= $max; $i++) {
The C style for loop is rarely needed in Perl since Perl provides
the more friendly list scanning \f(CW\*(C`foreach\*(C'\fR loop.
\& print "This element is $_\en";
\& # you don't have to use the default $_ either...
\& foreach my $key (keys %hash) {
\& print "The value of $key is $hash{$key}\en";
For more detail on looping constructs (and some that weren't mentioned in
this overview) see perlsyn.
.Sh "Builtin operators and functions"
.IX Subsection "Builtin operators and functions"
Perl comes with a wide selection of builtin functions. Some of the ones
we've already seen include \f(CW\*(C`print\*(C'\fR, \f(CW\*(C`sort\*(C'\fR and \f(CW\*(C`reverse\*(C'\fR. A list of
them is given at the start of perlfunc and you can easily read
about any given function by using \f(CW\*(C`perldoc \-f \f(CIfunctionname\f(CW\*(C'\fR.
Perl operators are documented in full in perlop, but here are a few
.IP "Numeric comparison" 4
.IX Item "Numeric comparison"
\& >= greater than or equal
.IP "String comparison" 4
.IX Item "String comparison"
\& ge greater than or equal
(Why do we have separate numeric and string comparisons? Because we don't
have special variable types, and Perl needs to know whether to sort
numerically (where 99 is less than 100) or alphabetically (where 100 comes
(\f(CW\*(C`and\*(C'\fR, \f(CW\*(C`or\*(C'\fR and \f(CW\*(C`not\*(C'\fR aren't just in the above table as descriptions
of the operators \*(-- they're also supported as operators in their own
right. They're more readable than the C\-style operators, but have
different precedence to \f(CW\*(C`&&\*(C'\fR and friends. Check perlop for more
\& . string concatenation
\& x string multiplication
\& .. range operator (creates a list of numbers)
Many operators can be combined with a \f(CW\*(C`=\*(C'\fR as follows:
\& $a += 1; # same as $a = $a + 1
\& $a -= 1; # same as $a = $a - 1
\& $a .= "\en"; # same as $a = $a . "\en";
.IX Subsection "Files and I/O"
You can open a file for input or output using the \f(CW\*(C`open()\*(C'\fR function.
It's documented in extravagant detail in perlfunc and perlopentut,
\& open(INFILE, "input.txt") or die "Can't open input.txt: $!";
\& open(OUTFILE, ">output.txt") or die "Can't open output.txt: $!";
\& open(LOGFILE, ">>my.log") or die "Can't open logfile: $!";
You can read from an open filehandle using the \f(CW\*(C`<>\*(C'\fR operator. In
scalar context it reads a single line from the filehandle, and in list
context it reads the whole file in, assigning each line to an element of
Reading in the whole file at one time is called slurping. It can
be useful but it may be a memory hog. Most text file processing
can be done a line at a time with Perl's looping constructs.
The \f(CW\*(C`<>\*(C'\fR operator is most often seen in a \f(CW\*(C`while\*(C'\fR loop:
\& while (<INFILE>) { # assigns each line in turn to $_
\& print "Just read in this line: $_";
We've already seen how to print to standard output using \f(CW\*(C`print()\*(C'\fR.
However, \f(CW\*(C`print()\*(C'\fR can also take an optional first argument specifying
which filehandle to print to:
\& print STDERR "This is your final warning.\en";
\& print OUTFILE $record;
\& print LOGFILE $logmessage;
When you're done with your filehandles, you should \f(CW\*(C`close()\*(C'\fR them
(though to be honest, Perl will clean up after you if you forget):
.Sh "Regular expressions"
.IX Subsection "Regular expressions"
Perl's regular expression support is both broad and deep, and is the
subject of lengthy documentation in perlrequick, perlretut, and
elsewhere. However, in short:
.IX Item "Simple matching"
\& if (/foo/) { ... } # true if $_ contains "foo"
\& if ($a =~ /foo/) { ... } # true if $a contains "foo"
The \f(CW\*(C`//\*(C'\fR matching operator is documented in perlop. It operates on
\&\f(CW$_\fR by default, or can be bound to another variable using the \f(CW\*(C`=~\*(C'\fR
binding operator (also documented in perlop).
.IP "Simple substitution" 4
.IX Item "Simple substitution"
\& s/foo/bar/; # replaces foo with bar in $_
\& $a =~ s/foo/bar/; # replaces foo with bar in $a
\& $a =~ s/foo/bar/g; # replaces ALL INSTANCES of foo with bar in $a
The \f(CW\*(C`s///\*(C'\fR substitution operator is documented in perlop.
.IP "More complex regular expressions" 4
.IX Item "More complex regular expressions"
You don't just have to match on fixed strings. In fact, you can match
on just about anything you could dream of by using more complex regular
expressions. These are documented at great length in perlre, but for
the meantime, here's a quick cheat sheet:
\& \es a whitespace character (space, tab, newline)
\& \eS non-whitespace character
\& \ew a word character (a-z, A-Z, 0-9, _)
\& \eW a non-word character
\& [aeiou] matches a single character in the given set
\& [^aeiou] matches a single character outside the given set
\& (foo|bar|baz) matches any of the alternatives specified
Quantifiers can be used to specify how many of the previous thing you
want to match on, where \*(L"thing\*(R" means either a literal character, one
of the metacharacters listed above, or a group of characters or
metacharacters in parentheses.
\& * zero or more of the previous thing
\& + one or more of the previous thing
\& ? zero or one of the previous thing
\& {3} matches exactly 3 of the previous thing
\& {3,6} matches between 3 and 6 of the previous thing
\& {3,} matches 3 or more of the previous thing
\& /^\ed+/ string starts with one or more digits
\& /^$/ nothing in the string (start and end are adjacent)
\& /(\ed\es){3}/ a three digits, each followed by a whitespace
\& character (eg "3 4 5 ")
\& /(a.)+/ matches a string in which every odd-numbered letter
\& # This loop reads from STDIN, and prints non-blank lines:
.IP "Parentheses for capturing" 4
.IX Item "Parentheses for capturing"
As well as grouping, parentheses serve a second purpose. They can be
used to capture the results of parts of the regexp match for later use.
The results end up in \f(CW$1\fR, \f(CW$2\fR and so on.
\& # a cheap and nasty way to break an email address up into parts
\& if ($email =~ /([^@]+)@(.+)/) {
\& print "Username is $1\en";
\& print "Hostname is $2\en";
.IP "Other regexp features" 4
.IX Item "Other regexp features"
Perl regexps also support backreferences, lookaheads, and all kinds of
other complex details. Read all about them in perlrequick,
.Sh "Writing subroutines"
.IX Subsection "Writing subroutines"
Writing subroutines is easy:
\& my $logmessage = shift;
\& print LOGFILE $logmessage;
What's that \f(CW\*(C`shift\*(C'\fR? Well, the arguments to a subroutine are available
to us as a special array called \f(CW@_\fR (see perlvar for more on that).
The default argument to the \f(CW\*(C`shift\*(C'\fR function just happens to be \f(CW@_\fR.
So \f(CW\*(C`my $logmessage = shift;\*(C'\fR shifts the first item off the list of
arguments and assigns it to \f(CW$logmessage\fR.
We can manipulate \f(CW@_\fR in other ways too:
\& my ($logmessage, $priority) = @_; # common
\& my $logmessage = $_[0]; # uncommon, and ugly
Subroutines can also return values:
\& my $result = $num * $num;
For more information on writing subroutines, see perlsub.
\&\s-1OO\s0 Perl is relatively simple and is implemented using references which
know what sort of object they are based on Perl's concept of packages.
However, \s-1OO\s0 Perl is largely beyond the scope of this document.
Read perlboot, perltoot, perltooc and perlobj.
As a beginning Perl programmer, your most common use of \s-1OO\s0 Perl will be
in using third-party modules, which are documented below.
.IX Subsection "Using Perl modules"
Perl modules provide a range of features to help you avoid reinventing
the wheel, and can be downloaded from \s-1CPAN\s0 ( http://www.cpan.org/ ). A
number of popular modules are included with the Perl distribution
Categories of modules range from text manipulation to network protocols
to database integration to graphics. A categorized list of modules is
also available from \s-1CPAN\s0.
To learn how to install modules you download from \s-1CPAN\s0, read
To learn how to use a particular module, use \f(CW\*(C`perldoc \f(CIModule::Name\f(CW\*(C'\fR.
Typically you will want to \f(CW\*(C`use \f(CIModule::Name\f(CW\*(C'\fR, which will then give
you access to exported functions or an \s-1OO\s0 interface to the module.
perlfaq contains questions and answers related to many common
tasks, and often provides suggestions for good \s-1CPAN\s0 modules to use.
perlmod describes Perl modules in general. perlmodlib lists the
modules which came with your Perl installation.
If you feel the urge to write Perl modules, perlnewmod will give you
Kirrily \*(L"Skud\*(R" Robert <skud@cpan.org>
projects / OpenSPARC-T2-SAM / blob