_EOB_ The following functions are currently undocumented. If you use one of them, you may wish to consider creating and submitting documentation for it.

      _EOB_ for my $missing (sort @$missing) { print $fh "=item $missing\n\n\n"; } print $fh "=back\n\n"; } print $fh $footer, "=cut\n";


      foreach (@{(setup_embed())[0]}) { next if @$_ < 2; my ($flags, $retval, $func, @args) = @$_; s/\b(?:NN|NULLOK)\b\s+//g for @args;

          $funcflags{$func} = {
                               flags => $flags,
                               retval => $retval,
                               args => \@args,

      # glob() picks up docs from extra .c or .h files that may be in unclean # development trees. open my $fh, '<', 'MANIFEST' or die "Can't open MANIFEST: $!"; while (my $line = <$fh>) { next unless my ($file) = $line =~ /^(\S+\.[ch])\t/;

          open F, '<', $file or die "Cannot open $file for docs: $!\n";
          $curheader = "Functions in file $file\n";
          close F or die "Error closing $file: $!\n";
      close $fh or die "Error whilst reading MANIFEST: $!";

      for (sort keys %funcflags) { next unless $funcflags{$_}{flags} =~ /d/; warn "no docs for $_\n" }

      foreach (sort keys %missing) { next if $macro{$_}; # Heuristics for known not-a-function macros: next if /^[A-Z]/; next if /^dj?[A-Z]/;

          warn "Function '$_', documented in $missing{$_}, not listed in embed.fnc";

      # walk table providing an array of components in each line to # subroutine, printing the result

      # List of funcs in the public API that aren't also marked as experimental nor # deprecated. my @missing_api = grep $funcflags{$_}{flags} =~ /A/ && $funcflags{$_}{flags} !~ /[MD]/ && !$docs{api}{$_}, keys %funcflags; output('perlapi', <<'_EOB_', $docs{api}, \@missing_api, <<'_EOE_'); =encoding UTF-8


perlapi - autogenerated documentation for the perl public API


This file contains the documentation of the perl public API generated by embed.pl, specifically a listing of functions, macros, flags, and variables that may be used by extension writers. At the end is a list of functions which have yet to be documented. The interfaces of those are subject to change without notice. Anything not listed here is not part of the public API, and should not be used by extension writers at all. For these reasons, blindly using functions listed in proto.h is to be avoided when writing extensions.

In Perl, unlike C, a string of characters may generally contain embedded NUL characters. Sometimes in the documentation a Perl string is referred to as a "buffer" to distinguish it from a C string, but sometimes they are both just referred to as strings.

Note that all Perl API global variables must be referenced with the PL_ prefix. Again, those not listed here are not to be used by extension writers, and can be changed or removed without notice; same with macros. Some macros are provided for compatibility with the older, unadorned names, but this support may be disabled in a future release.

Perl was originally written to handle US-ASCII only (that is characters whose ordinal numbers are in the range 0 - 127). And documentation and comments may still use the term ASCII, when sometimes in fact the entire range from 0 - 255 is meant.

The non-ASCII characters below 256 can have various meanings, depending on various things. (See, most notably, perllocale.) But usually the whole range can be referred to as ISO-8859-1. Often, the term "Latin-1" (or "Latin1") is used as an equivalent for ISO-8859-1. But some people treat "Latin1" as referring just to the characters in the range 128 through 255, or somethimes from 160 through 255. This documentation uses "Latin1" and "Latin-1" to refer to all 256 characters.

Note that Perl can be compiled and run under either ASCII or EBCDIC (See perlebcdic). Most of the documentation (and even comments in the code) ignore the EBCDIC possibility. For almost all purposes the differences are transparent. As an example, under EBCDIC, instead of UTF-8, UTF-EBCDIC is used to encode Unicode strings, and so whenever this documentation refers to utf8 (and variants of that name, including in function names), it also (essentially transparently) means UTF-EBCDIC. But the ordinals of characters differ between ASCII, EBCDIC, and the UTF- encodings, and a string encoded in UTF-EBCDIC may occupy a different number of bytes than in UTF-8.

The listing below is alphabetical, case insensitive.



Until May 1997, this document was maintained by Jeff Okamoto <okamoto@corp.hp.com>. It is now maintained as part of Perl itself.

With lots of help and suggestions from Dean Roehrich, Malcolm Beattie, Andreas Koenig, Paul Hudson, Ilya Zakharevich, Paul Marquess, Neil Bowers, Matthew Green, Tim Bunce, Spider Boardman, Ulrich Pfeifer, Stephen McCamant, and Gurusamy Sarathy.

API Listing originally by Dean Roehrich <roehrich@cray.com>.

Updated to be autogenerated from comments in the source by Benjamin Stuhl.


perlguts, perlxs, perlxstut, perlintern


# List of non-static internal functions my @missing_guts = grep $funcflags{$_}{flags} !~ /[As]/ && !$docs{guts}{$_}, keys %funcflags;

output('perlintern', <<'END', $docs{guts}, \@missing_guts, <<'END'); =head1 NAME

perlintern - autogenerated documentation of purely internal Perl functions


This file is the autogenerated documentation of functions in the Perl interpreter that are documented using Perl's internal documentation format but are not marked as part of the Perl API. In other words, they are not for use in extensions!



The autodocumentation system was originally added to the Perl core by Benjamin Stuhl. Documentation is by whoever was kind enough to document their functions.


perlguts, perlapi


1 POD Error

The following errors were encountered while parsing the POD:

Around line 388:

You forgot a '=back' before '=head1'

You forgot a '=back' before '=head1'