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     perlsecpolicy       Perl security report handling policy
 133
 134     perlmod             Perl modules: how they work
 135     perlmodlib          Perl modules: how to write and use
 136     perlmodstyle        Perl modules: how to write modules with style
 137     perlmodinstall      Perl modules: how to install from CPAN
 138     perlnewmod          Perl modules: preparing a new module for distribution
 139     perlpragma          Perl modules: writing a user pragma
 140
 141     perlutil            utilities packaged with the Perl distribution
 142
 143     perlfilter          Perl source filters
 144
 145     perldtrace          Perl's support for DTrace
 146
 147     perlglossary        Perl Glossary
 148
 149 =head2 Internals and C Language Interface
 150
 151     perlembed           Perl ways to embed perl in your C or C++ application
 152     perldebguts         Perl debugging guts and tips
 153     perlxstut           Perl XS tutorial
 154     perlxs              Perl XS application programming interface
 155     perlxstypemap       Perl XS C/Perl type conversion tools
 156     perlclib            Internal replacements for standard C library functions
 157     perlguts            Perl internal functions for those doing extensions
 158     perlcall            Perl calling conventions from C
 159     perlmroapi          Perl method resolution plugin interface
 160     perlreapi           Perl regular expression plugin interface
 161     perlreguts          Perl regular expression engine internals
 162
 163     perlapi             Perl API listing (autogenerated)
 164     perlintern          Perl internal functions (autogenerated)
 165     perliol             C API for Perl's implementation of IO in Layers
 166     perlapio            Perl internal IO abstraction interface
 167
 168     perlhack            Perl hackers guide
 169     perlsource          Guide to the Perl source tree
 170     perlinterp          Overview of the Perl interpreter source and how it works
 171     perlhacktut         Walk through the creation of a simple C code patch
 172     perlhacktips        Tips for Perl core C code hacking
 173     perlpolicy          Perl development policies
 174     perlgit             Using git with the Perl repository
 175
 176 =head2 Miscellaneous
 177
 178     perlbook            Perl book information
 179     perlcommunity       Perl community information
 180
 181     perldoc             Look up Perl documentation in Pod format
 182
 183     perlhist            Perl history records
 184     perldelta           Perl changes since previous version
 185     perl5333delta       Perl changes in version 5.33.3
 186     perl5332delta       Perl changes in version 5.33.2
 187     perl5331delta       Perl changes in version 5.33.1
 188     perl5330delta       Perl changes in version 5.33.0
 189     perl5320delta       Perl changes in version 5.32.0
 190     perl5303delta       Perl changes in version 5.30.3
 191     perl5302delta       Perl changes in version 5.30.2
 192     perl5301delta       Perl changes in version 5.30.1
 193     perl5300delta       Perl changes in version 5.30.0
 194     perl5283delta       Perl changes in version 5.28.3
 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 UTF-8)
 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     perlsynology        Perl notes for Synology
 292     perltru64           Perl notes for Tru64
 293     perlvms             Perl notes for VMS
 294     perlvos             Perl notes for Stratus VOS
 295     perlwin32           Perl notes for Windows
 296
 297 =for buildtoc flag -r
 298
 299 =head2 Stubs for Deleted Documents
 300
 301     perlboot
 302     perlbot
 303     perlrepository
 304     perltodo
 305     perltooc
 306     perltoot
 307
 308 =for buildtoc __END__
 309
 310 On a Unix-like system, these documentation files will usually also be
 311 available as manpages for use with the F<man> program.
 312
 313 Some documentation is not available as man pages, so if a
 314 cross-reference is not found by man, try it with L<perldoc>.  Perldoc can
 315 also take you directly to documentation for functions (with the B<-f>
 316 switch). See C<perldoc --help> (or C<perldoc perldoc> or C<man perldoc>)
 317 for other helpful options L<perldoc> has to offer.
 318
 319 In general, if something strange has gone wrong with your program and you're
 320 not sure where you should look for help, try making your code comply with
 321 B<use strict> and B<use warnings>.  These will often point out exactly
 322 where the trouble is.
 323
 324 =head1 DESCRIPTION
 325
 326 Perl officially stands for Practical Extraction and Report Language,
 327 except when it doesn't.
 328
 329 Perl was originally a language optimized for scanning arbitrary
 330 text files, extracting information from those text files, and printing
 331 reports based on that information.  It quickly became a good language
 332 for many system management tasks. Over the years, Perl has grown into
 333 a general-purpose programming language. It's widely used for everything
 334 from quick "one-liners" to full-scale application development.
 335
 336 The language is intended to be practical (easy to use, efficient,
 337 complete) rather than beautiful (tiny, elegant, minimal).  It combines
 338 (in the author's opinion, anyway) some of the best features of B<sed>,
 339 B<awk>, and B<sh>, making it familiar and easy to use for Unix users to
 340 whip up quick solutions to annoying problems.  Its general-purpose
 341 programming facilities support procedural, functional, and
 342 object-oriented programming paradigms, making Perl a comfortable
 343 language for the long haul on major projects, whatever your bent.
 344
 345 Perl's roots in text processing haven't been forgotten over the years.
 346 It still boasts some of the most powerful regular expressions to be
 347 found anywhere, and its support for Unicode text is world-class.  It
 348 handles all kinds of structured text, too, through an extensive
 349 collection of extensions.  Those libraries, collected in the CPAN,
 350 provide ready-made solutions to an astounding array of problems.  When
 351 they haven't set the standard themselves, they steal from the best
 352 -- just like Perl itself.
 353
 354 =head1 AVAILABILITY
 355
 356 Perl is available for most operating systems, including virtually
 357 all Unix-like platforms.  See L<perlport/"Supported Platforms">
 358 for a listing.
 359
 360 =head1 ENVIRONMENT
 361
 362 See L<perlrun/ENVIRONMENT>.
 363
 364 =head1 AUTHOR
 365
 366 Larry Wall <larry@wall.org>, with the help of oodles of other folks.
 367
 368 If your Perl success stories and testimonials may be of help to others
 369 who wish to advocate the use of Perl in their applications,
 370 or if you wish to simply express your gratitude to Larry and the
 371 Perl developers, please write to perl-thanks@perl.org .
 372
 373 =head1 FILES
 374
 375  "@INC"                 locations of perl libraries
 376
 377 "@INC" above is a reference to the built-in variable of the same name;
 378 see L<perlvar> for more information.
 379
 380 =head1 SEE ALSO
 381
 382  https://www.perl.org/       the Perl homepage
 383  https://www.perl.com/       Perl articles
 384  https://www.cpan.org/       the Comprehensive Perl Archive
 385  https://www.pm.org/         the Perl Mongers
 386
 387 =head1 DIAGNOSTICS
 388
 389 Using the C<use strict> pragma ensures that all variables are properly
 390 declared and prevents other misuses of legacy Perl features.
 391
 392 The C<use warnings> pragma produces some lovely diagnostics. One can
 393 also use the B<-w> flag, but its use is normally discouraged, because
 394 it gets applied to all executed Perl code, including that not under
 395 your control.
 396
 397 See L<perldiag> for explanations of all Perl's diagnostics.  The C<use
 398 diagnostics> pragma automatically turns Perl's normally terse warnings
 399 and errors into these longer forms.
 400
 401 Compilation errors will tell you the line number of the error, with an
 402 indication of the next token or token type that was to be examined.
 403 (In a script passed to Perl via B<-e> switches, each
 404 B<-e> is counted as one line.)
 405
 406 Setuid scripts have additional constraints that can produce error
 407 messages such as "Insecure dependency".  See L<perlsec>.
 408
 409 Did we mention that you should definitely consider using the B<use warnings>
 410 pragma?
 411
 412 =head1 BUGS
 413
 414 The behavior implied by the B<use warnings> pragma is not mandatory.
 415
 416 Perl is at the mercy of your machine's definitions of various
 417 operations such as type casting, atof(), and floating-point
 418 output with sprintf().
 419
 420 If your stdio requires a seek or eof between reads and writes on a
 421 particular stream, so does Perl.  (This doesn't apply to sysread()
 422 and syswrite().)
 423
 424 While none of the built-in data types have any arbitrary size limits
 425 (apart from memory size), there are still a few arbitrary limits:  a
 426 given variable name may not be longer than 251 characters.  Line numbers
 427 displayed by diagnostics are internally stored as short integers,
 428 so they are limited to a maximum of 65535 (higher numbers usually being
 429 affected by wraparound).
 430
 431 You may submit your bug reports (be sure to include full configuration
 432 information as output by the myconfig program in the perl source
 433 tree, or by C<perl -V>) to L<https://github.com/Perl/perl5/issues>.
 434
 435 Perl actually stands for Pathologically Eclectic Rubbish Lister, but
 436 don't tell anyone I said that.
 437
 438 =head1 NOTES
 439
 440 The Perl motto is "There's more than one way to do it."  Divining
 441 how many more is left as an exercise to the reader.
 442
 443 The three principal virtues of a programmer are Laziness,
 444 Impatience, and Hubris.  See the Camel Book for why.
 445