pod/perl.pod

   1 =head1 NAME
   2
   3 perl - The Perl 5 language interpreter
   4
   5 =head1 SYNOPSIS
   6
   7 B<perl> S<[ B<-sTtuUWX> ]>
   8         S<[ B<-hv> ] [ B<-V>[:I<configvar>] ]>
   9         S<[ B<-cw> ] [ B<-d>[B<t>][:I<debugger>] ] [ B<-D>[I<number/list>] ]>
  10         S<[ B<-pna> ] [ B<-F>I<pattern> ] [ B<-l>[I<octal>] ] [ B<-0>[I<octal/hexadecimal>] ]>
  11         S<[ B<-I>I<dir> ] [ B<-m>[B<->]I<module> ] [ B<-M>[B<->]I<'module...'> ] [ B<-f> ]>
  12         S<[ B<-C [I<number/list>] >]>
  13         S<[ B<-S> ]>
  14         S<[ B<-x>[I<dir>] ]>
  15         S<[ B<-i>[I<extension>] ]>
  16         S<[ [B<-e>|B<-E>] I<'command'> ] [ B<--> ] [ I<programfile> ] [ I<argument> ]...>
  17
  18 For more information on these options, you can run C<perldoc perlrun>.
  19
  20 =head1 GETTING HELP
  21
  22 The F<perldoc> program gives you access to all the documentation that comes
  23 with Perl.  You can get more documentation, tutorials and community support
  24 online at L<https://www.perl.org/>.
  25
  26 If you're new to Perl, you should start by running C<perldoc perlintro>,
  27 which is a general intro for beginners and provides some background to help
  28 you navigate the rest of Perl's extensive documentation.  Run C<perldoc
  29 perldoc> to learn more things you can do with F<perldoc>.
  30
  31 For ease of access, the Perl manual has been split up into several sections.
  32
  33 =begin buildtoc
  34
  35 # This section is parsed by Porting/pod_lib.pl for use by pod/buildtoc etc
  36
  37 flag =g  perluniprops perlmodlib perlapi perlintern
  38 flag =go perltoc
  39 flag =ro perlcn perljp perlko perltw
  40 flag =   perlvms
  41
  42 path perlfaq.*               cpan/perlfaq/lib/
  43 path perlglossary            cpan/perlfaq/lib/
  44 path perlxs(?:tut|typemap)?  dist/ExtUtils-ParseXS/lib/
  45 path perldoc                 cpan/Pod-Perldoc/
  46
  47 aux h2ph h2xs perlbug pl2pm pod2html pod2man splain xsubpp
  48
  49 =end buildtoc
  50
  51 =head2 Overview
  52
  53     perl                Perl overview (this section)
  54     perlintro           Perl introduction for beginners
  55     perlrun             Perl execution and options
  56     perltoc             Perl documentation table of contents
  57
  58 =head2 Tutorials
  59
  60     perlreftut          Perl references short introduction
  61     perldsc             Perl data structures intro
  62     perllol             Perl data structures: arrays of arrays
  63
  64     perlrequick         Perl regular expressions quick start
  65     perlretut           Perl regular expressions tutorial
  66
  67     perlootut           Perl OO tutorial for beginners
  68
  69     perlperf            Perl Performance and Optimization Techniques
  70
  71     perlstyle           Perl style guide
  72
  73     perlcheat           Perl cheat sheet
  74     perltrap            Perl traps for the unwary
  75     perldebtut          Perl debugging tutorial
  76
  77     perlfaq             Perl frequently asked questions
  78       perlfaq1          General Questions About Perl
  79       perlfaq2          Obtaining and Learning about Perl
  80       perlfaq3          Programming Tools
  81       perlfaq4          Data Manipulation
  82       perlfaq5          Files and Formats
  83       perlfaq6          Regexes
  84       perlfaq7          Perl Language Issues
  85       perlfaq8          System Interaction
  86       perlfaq9          Networking
  87
  88 =head2 Reference Manual
  89
  90     perlsyn             Perl syntax
  91     perldata            Perl data structures
  92     perlop              Perl operators and precedence
  93     perlsub             Perl subroutines
  94     perlfunc            Perl built-in functions
  95       perlopentut       Perl open() tutorial
  96       perlpacktut       Perl pack() and unpack() tutorial
  97     perlpod             Perl plain old documentation
  98     perlpodspec         Perl plain old documentation format specification
  99     perlpodstyle        Perl POD style guide
 100     perldiag            Perl diagnostic messages
 101     perldeprecation     Perl deprecations
 102     perllexwarn         Perl warnings and their control
 103     perldebug           Perl debugging
 104     perlvar             Perl predefined variables
 105     perlre              Perl regular expressions, the rest of the story
 106     perlrebackslash     Perl regular expression backslash sequences
 107     perlrecharclass     Perl regular expression character classes
 108     perlreref           Perl regular expressions quick reference
 109     perlref             Perl references, the rest of the story
 110     perlform            Perl formats
 111     perlobj             Perl objects
 112     perltie             Perl objects hidden behind simple variables
 113       perldbmfilter     Perl DBM filters
 114
 115     perlipc             Perl interprocess communication
 116     perlfork            Perl fork() information
 117     perlnumber          Perl number semantics
 118
 119     perlthrtut          Perl threads tutorial
 120
 121     perlport            Perl portability guide
 122     perllocale          Perl locale support
 123     perluniintro        Perl Unicode introduction
 124     perlunicode         Perl Unicode support
 125     perlunicook         Perl Unicode cookbook
 126     perlunifaq          Perl Unicode FAQ
 127     perluniprops        Index of Unicode properties in Perl
 128     perlunitut          Perl Unicode tutorial
 129     perlebcdic          Considerations for running Perl on EBCDIC platforms
 130
 131     perlsec             Perl security
 132
 133     perlmod             Perl modules: how they work
 134     perlmodlib          Perl modules: how to write and use
 135     perlmodstyle        Perl modules: how to write modules with style
 136     perlmodinstall      Perl modules: how to install from CPAN
 137     perlnewmod          Perl modules: preparing a new module for distribution
 138     perlpragma          Perl modules: writing a user pragma
 139
 140     perlutil            utilities packaged with the Perl distribution
 141
 142     perlfilter          Perl source filters
 143
 144     perldtrace          Perl's support for DTrace
 145
 146     perlglossary        Perl Glossary
 147
 148 =head2 Internals and C Language Interface
 149
 150     perlembed           Perl ways to embed perl in your C or C++ application
 151     perldebguts         Perl debugging guts and tips
 152     perlxstut           Perl XS tutorial
 153     perlxs              Perl XS application programming interface
 154     perlxstypemap       Perl XS C/Perl type conversion tools
 155     perlclib            Internal replacements for standard C library functions
 156     perlguts            Perl internal functions for those doing extensions
 157     perlcall            Perl calling conventions from C
 158     perlmroapi          Perl method resolution plugin interface
 159     perlreapi           Perl regular expression plugin interface
 160     perlreguts          Perl regular expression engine internals
 161
 162     perlapi             Perl API listing (autogenerated)
 163     perlintern          Perl internal functions (autogenerated)
 164     perliol             C API for Perl's implementation of IO in Layers
 165     perlapio            Perl internal IO abstraction interface
 166
 167     perlhack            Perl hackers guide
 168     perlsource          Guide to the Perl source tree
 169     perlinterp          Overview of the Perl interpreter source and how it works
 170     perlhacktut         Walk through the creation of a simple C code patch
 171     perlhacktips        Tips for Perl core C code hacking
 172     perlpolicy          Perl development policies
 173     perlgit             Using git with the Perl repository
 174
 175 =head2 Miscellaneous
 176
 177     perlbook            Perl book information
 178     perlcommunity       Perl community information
 179
 180     perldoc             Look up Perl documentation in Pod format
 181
 182     perlhist            Perl history records
 183     perldelta           Perl changes since previous version
 184     perl5318delta       Perl changes in version 5.31.8
 185     perl5317delta       Perl changes in version 5.31.7
 186     perl5316delta       Perl changes in version 5.31.6
 187     perl5315delta       Perl changes in version 5.31.5
 188     perl5314delta       Perl changes in version 5.31.4
 189     perl5313delta       Perl changes in version 5.31.3
 190     perl5312delta       Perl changes in version 5.31.2
 191     perl5311delta       Perl changes in version 5.31.1
 192     perl5310delta       Perl changes in version 5.31.0
 193     perl5301delta       Perl changes in version 5.30.1
 194     perl5300delta       Perl changes in version 5.30.0
 195     perl5282delta       Perl changes in version 5.28.2
 196     perl5281delta       Perl changes in version 5.28.1
 197     perl5280delta       Perl changes in version 5.28.0
 198     perl5263delta       Perl changes in version 5.26.3
 199     perl5262delta       Perl changes in version 5.26.2
 200     perl5261delta       Perl changes in version 5.26.1
 201     perl5260delta       Perl changes in version 5.26.0
 202     perl5244delta       Perl changes in version 5.24.4
 203     perl5243delta       Perl changes in version 5.24.3
 204     perl5242delta       Perl changes in version 5.24.2
 205     perl5241delta       Perl changes in version 5.24.1
 206     perl5240delta       Perl changes in version 5.24.0
 207     perl5224delta       Perl changes in version 5.22.4
 208     perl5223delta       Perl changes in version 5.22.3
 209     perl5222delta       Perl changes in version 5.22.2
 210     perl5221delta       Perl changes in version 5.22.1
 211     perl5220delta       Perl changes in version 5.22.0
 212     perl5203delta       Perl changes in version 5.20.3
 213     perl5202delta       Perl changes in version 5.20.2
 214     perl5201delta       Perl changes in version 5.20.1
 215     perl5200delta       Perl changes in version 5.20.0
 216     perl5184delta       Perl changes in version 5.18.4
 217     perl5182delta       Perl changes in version 5.18.2
 218     perl5181delta       Perl changes in version 5.18.1
 219     perl5180delta       Perl changes in version 5.18.0
 220     perl5163delta       Perl changes in version 5.16.3
 221     perl5162delta       Perl changes in version 5.16.2
 222     perl5161delta       Perl changes in version 5.16.1
 223     perl5160delta       Perl changes in version 5.16.0
 224     perl5144delta       Perl changes in version 5.14.4
 225     perl5143delta       Perl changes in version 5.14.3
 226     perl5142delta       Perl changes in version 5.14.2
 227     perl5141delta       Perl changes in version 5.14.1
 228     perl5140delta       Perl changes in version 5.14.0
 229     perl5125delta       Perl changes in version 5.12.5
 230     perl5124delta       Perl changes in version 5.12.4
 231     perl5123delta       Perl changes in version 5.12.3
 232     perl5122delta       Perl changes in version 5.12.2
 233     perl5121delta       Perl changes in version 5.12.1
 234     perl5120delta       Perl changes in version 5.12.0
 235     perl5101delta       Perl changes in version 5.10.1
 236     perl5100delta       Perl changes in version 5.10.0
 237     perl589delta        Perl changes in version 5.8.9
 238     perl588delta        Perl changes in version 5.8.8
 239     perl587delta        Perl changes in version 5.8.7
 240     perl586delta        Perl changes in version 5.8.6
 241     perl585delta        Perl changes in version 5.8.5
 242     perl584delta        Perl changes in version 5.8.4
 243     perl583delta        Perl changes in version 5.8.3
 244     perl582delta        Perl changes in version 5.8.2
 245     perl581delta        Perl changes in version 5.8.1
 246     perl58delta         Perl changes in version 5.8.0
 247     perl561delta        Perl changes in version 5.6.1
 248     perl56delta         Perl changes in version 5.6
 249     perl5005delta       Perl changes in version 5.005
 250     perl5004delta       Perl changes in version 5.004
 251
 252     perlexperiment      A listing of experimental features in Perl
 253
 254     perlartistic        Perl Artistic License
 255     perlgpl             GNU General Public License
 256
 257 =head2 Language-Specific
 258
 259 =for buildtoc flag +r
 260
 261     perlcn              Perl for Simplified Chinese (in EUC-CN)
 262     perljp              Perl for Japanese (in EUC-JP)
 263     perlko              Perl for Korean (in EUC-KR)
 264     perltw              Perl for Traditional Chinese (in Big5)
 265
 266 =head2 Platform-Specific
 267
 268     perlaix             Perl notes for AIX
 269     perlamiga           Perl notes for AmigaOS
 270     perlandroid         Perl notes for Android
 271     perlbs2000          Perl notes for POSIX-BC BS2000
 272     perlcygwin          Perl notes for Cygwin
 273     perldos             Perl notes for DOS
 274     perlfreebsd         Perl notes for FreeBSD
 275     perlhaiku           Perl notes for Haiku
 276     perlhpux            Perl notes for HP-UX
 277     perlhurd            Perl notes for Hurd
 278     perlirix            Perl notes for Irix
 279     perllinux           Perl notes for Linux
 280     perlmacos           Perl notes for Mac OS (Classic)
 281     perlmacosx          Perl notes for Mac OS X
 282     perlnetware         Perl notes for NetWare
 283     perlopenbsd         Perl notes for OpenBSD
 284     perlos2             Perl notes for OS/2
 285     perlos390           Perl notes for OS/390
 286     perlos400           Perl notes for OS/400
 287     perlplan9           Perl notes for Plan 9
 288     perlqnx             Perl notes for QNX
 289     perlriscos          Perl notes for RISC OS
 290     perlsolaris         Perl notes for Solaris
 291     perlsymbian         Perl notes for Symbian
 292     perlsynology        Perl notes for Synology
 293     perltru64           Perl notes for Tru64
 294     perlvms             Perl notes for VMS
 295     perlvos             Perl notes for Stratus VOS
 296     perlwin32           Perl notes for Windows
 297
 298 =for buildtoc flag -r
 299
 300 =head2 Stubs for Deleted Documents
 301
 302     perlboot
 303     perlbot
 304     perlrepository
 305     perltodo
 306     perltooc
 307     perltoot
 308
 309 =for buildtoc __END__
 310
 311 On a Unix-like system, these documentation files will usually also be
 312 available as manpages for use with the F<man> program.
 313
 314 Some documentation is not available as man pages, so if a
 315 cross-reference is not found by man, try it with L<perldoc>.  Perldoc can
 316 also take you directly to documentation for functions (with the B<-f>
 317 switch). See C<perldoc --help> (or C<perldoc perldoc> or C<man perldoc>)
 318 for other helpful options L<perldoc> has to offer.
 319
 320 In general, if something strange has gone wrong with your program and you're
 321 not sure where you should look for help, try making your code comply with
 322 B<use strict> and B<use warnings>.  These will often point out exactly
 323 where the trouble is.
 324
 325 =head1 DESCRIPTION
 326
 327 Perl officially stands for Practical Extraction and Report Language,
 328 except when it doesn't.
 329
 330 Perl was originally a language optimized for scanning arbitrary
 331 text files, extracting information from those text files, and printing
 332 reports based on that information.  It quickly became a good language
 333 for many system management tasks. Over the years, Perl has grown into
 334 a general-purpose programming language. It's widely used for everything
 335 from quick "one-liners" to full-scale application development.
 336
 337 The language is intended to be practical (easy to use, efficient,
 338 complete) rather than beautiful (tiny, elegant, minimal).  It combines
 339 (in the author's opinion, anyway) some of the best features of B<sed>,
 340 B<awk>, and B<sh>, making it familiar and easy to use for Unix users to
 341 whip up quick solutions to annoying problems.  Its general-purpose
 342 programming facilities support procedural, functional, and
 343 object-oriented programming paradigms, making Perl a comfortable
 344 language for the long haul on major projects, whatever your bent.
 345
 346 Perl's roots in text processing haven't been forgotten over the years.
 347 It still boasts some of the most powerful regular expressions to be
 348 found anywhere, and its support for Unicode text is world-class.  It
 349 handles all kinds of structured text, too, through an extensive
 350 collection of extensions.  Those libraries, collected in the CPAN,
 351 provide ready-made solutions to an astounding array of problems.  When
 352 they haven't set the standard themselves, they steal from the best
 353 -- just like Perl itself.
 354
 355 =head1 AVAILABILITY
 356
 357 Perl is available for most operating systems, including virtually
 358 all Unix-like platforms.  See L<perlport/"Supported Platforms">
 359 for a listing.
 360
 361 =head1 ENVIRONMENT
 362
 363 See L<perlrun>.
 364
 365 =head1 AUTHOR
 366
 367 Larry Wall <larry@wall.org>, with the help of oodles of other folks.
 368
 369 If your Perl success stories and testimonials may be of help to others
 370 who wish to advocate the use of Perl in their applications,
 371 or if you wish to simply express your gratitude to Larry and the
 372 Perl developers, please write to perl-thanks@perl.org .
 373
 374 =head1 FILES
 375
 376  "@INC"                 locations of perl libraries
 377
 378 "@INC" above is a reference to the built-in variable of the same name;
 379 see L<perlvar> for more information.
 380
 381 =head1 SEE ALSO
 382
 383  https://www.perl.org/       the Perl homepage
 384  https://www.perl.com/       Perl articles
 385  https://www.cpan.org/       the Comprehensive Perl Archive
 386  https://www.pm.org/         the Perl Mongers
 387
 388 =head1 DIAGNOSTICS
 389
 390 Using the C<use strict> pragma ensures that all variables are properly
 391 declared and prevents other misuses of legacy Perl features.
 392
 393 The C<use warnings> pragma produces some lovely diagnostics. One can
 394 also use the B<-w> flag, but its use is normally discouraged, because
 395 it gets applied to all executed Perl code, including that not under
 396 your control.
 397
 398 See L<perldiag> for explanations of all Perl's diagnostics.  The C<use
 399 diagnostics> pragma automatically turns Perl's normally terse warnings
 400 and errors into these longer forms.
 401
 402 Compilation errors will tell you the line number of the error, with an
 403 indication of the next token or token type that was to be examined.
 404 (In a script passed to Perl via B<-e> switches, each
 405 B<-e> is counted as one line.)
 406
 407 Setuid scripts have additional constraints that can produce error
 408 messages such as "Insecure dependency".  See L<perlsec>.
 409
 410 Did we mention that you should definitely consider using the B<use warnings>
 411 pragma?
 412
 413 =head1 BUGS
 414
 415 The behavior implied by the B<use warnings> pragma is not mandatory.
 416
 417 Perl is at the mercy of your machine's definitions of various
 418 operations such as type casting, atof(), and floating-point
 419 output with sprintf().
 420
 421 If your stdio requires a seek or eof between reads and writes on a
 422 particular stream, so does Perl.  (This doesn't apply to sysread()
 423 and syswrite().)
 424
 425 While none of the built-in data types have any arbitrary size limits
 426 (apart from memory size), there are still a few arbitrary limits:  a
 427 given variable name may not be longer than 251 characters.  Line numbers
 428 displayed by diagnostics are internally stored as short integers,
 429 so they are limited to a maximum of 65535 (higher numbers usually being
 430 affected by wraparound).
 431
 432 You may submit your bug reports (be sure to include full configuration
 433 information as output by the myconfig program in the perl source
 434 tree, or by C<perl -V>) to L<https://github.com/Perl/perl5/issues>.
 435
 436 Perl actually stands for Pathologically Eclectic Rubbish Lister, but
 437 don't tell anyone I said that.
 438
 439 =head1 NOTES
 440
 441 The Perl motto is "There's more than one way to do it."  Divining
 442 how many more is left as an exercise to the reader.
 443
 444 The three principal virtues of a programmer are Laziness,
 445 Impatience, and Hubris.  See the Camel Book for why.
 446