diff options
author | Jarkko Hietaniemi <jhi@iki.fi> | 2000-02-08 20:58:02 +0000 |
---|---|---|
committer | Jarkko Hietaniemi <jhi@iki.fi> | 2000-02-08 20:58:02 +0000 |
commit | 1761cee512762c09b2a848d3c6cbd5a3b4232ffa (patch) | |
tree | 6e211068ee1368390669709334240812fd0a67de /pod/perldelta.pod | |
parent | 3dc6ede7f49a7b2b348c8780a45fe232aa5beb97 (diff) | |
download | perl-1761cee512762c09b2a848d3c6cbd5a3b4232ffa.tar.gz |
Integrate with Sarathy.
p4raw-id: //depot/cfgperl@5043
Diffstat (limited to 'pod/perldelta.pod')
-rw-r--r-- | pod/perldelta.pod | 118 |
1 files changed, 48 insertions, 70 deletions
diff --git a/pod/perldelta.pod b/pod/perldelta.pod index a22f75ba4f..33ab171746 100644 --- a/pod/perldelta.pod +++ b/pod/perldelta.pod @@ -477,6 +477,11 @@ C<require> and C<use> also support such literals: require v5.6.0; # croak if $^V lt v5.6.0 use v5.6.0; # same, but croaks at compile-time +C<sprintf> and C<printf> support the Perl-specific format type C<%v> +to print arbitrary strings as dotted tuples. + + printf "v%v", $^V; # prints current version, such as "v5.5.650" + =head2 Weak references WARNING: This is an experimental feature. @@ -1535,93 +1540,66 @@ act as mutators (accessor $z->Re(), mutator $z->Re(3)). A little bit of radial trigonometry (cylindrical and spherical), radial coordinate conversions, and the great circle distance were added. -=item Pod::Parser, Pod::InputObjects, Pod::ParseUtils, and Pod::Select +=item Pod::Parser, Pod::InputObjects -Pod::Parser is a new module that provides a base class for parsing and -selecting sections of POD documentation from an input stream. This -module takes care of identifying POD paragraphs and commands in the -input and hands off the parsed paragraphs and commands to user-defined -methods which are free to interpret or translate them as they see fit. +Pod::Parser is a base class for parsing and selecting sections of +pod documentation from an input stream. This module takes care of +identifying pod paragraphs and commands in the input and hands off the +parsed paragraphs and commands to user-defined methods which are free +to interpret or translate them as they see fit. Pod::InputObjects defines some input objects needed by Pod::Parser, and for advanced users of Pod::Parser that need more about a command besides -its name and text. Pod::ParseUtils provides several object-oriented -helpers for POD parsing and processing. Probably the most important is -Pod::Hyperlink for parsing and expanding POD hyperlinks. Pod::Select is -a subclass of Pod::Parser which provides a function named "podselect()" -to filter out user-specified sections of raw pod documentation from an -input stream. +its name and text. As of release 5.6 of Perl, Pod::Parser is now the officially sanctioned "base parser code" recommended for use by all pod2xxx translators. Pod::Text (pod2text) and Pod::Man (pod2man) have already been converted -to use Pod::Parser and efforts to convert Pod::Html (pod2html) are -already underway. For any questions or comments about POD parsing and -translating issues and utilities, please use the pod-people@perl.org -mailing list. - -For further information, please see L<Pod::Parser>, L<Pod::InputObjects>, -L<Pod::ParseUtils> and L<Pod::Select>. - -=item Pod::Usage - -Pod::Usage provides the function "pod2usage()" to print usage messages for -a Perl script based on its embedded pod documentation. The pod2usage() -function is generally useful to all script authors since it lets them -write and maintain a single source (the PODs) for documentation, thus -removing the need to create and maintain redundant usage message text -consisting of information already in the PODs. - -Script authors are encouraged to use Pod::Usage with their favorite Perl -option-parser to provide both terse and verbose formatted usage messages -for their users. Here is a simple example using Getopt::Long that prints -only a synopsis for syntax errors, a synopsis and description of arguments -when C<-help> is used, and the full manual page when C<-man> is used. - - use Getopt::Long; - use Pod::Usage; - my $man = 0; - my $help = 0; - GetOptions('help|?' => \$help, man => \$man) or pod2usage(2); - pod2usage(1) if $help; - pod2usage(-exitstatus => 0, -verbose => 2) if $man; - - __END__ - - =head1 NAME - - sample - Using GetOpt::Long and Pod::Usage +to use Pod::Parser and efforts to convert Pod::HTML (pod2html) are already +underway. For any questions or comments about pod parsing and translating +issues and utilities, please use the pod-people@perl.org mailing list. - =head1 SYNOPSIS +For further information, please see L<Pod::Parser> and L<Pod::InputObjects>. - sample [options] [file ...] +=item Pod::Checker, podchecker - Options: - -help brief help message - -man full documentation +This utility checks pod files for correct syntax, according to +L<perlpod>. Obvious errors are flagged as such, while warnings are +printed for mistakes that can be handled gracefully. The checklist is +not complete yet. See L<Pod::Checker>. - =head1 OPTIONS +=item Pod::ParseUtils, Pod::Find - =over 8 +These modules provide a set of gizmos that are useful mainly for pod +translators. L<Pod::Find|Pod::Find> traverses directory structures and +returns found pod files, along with their canonical names (like +C<File::Spec::Unix>). L<Pod::ParseUtils|Pod::ParseUtils> contains +B<Pod::List> (useful for storing pod list information), B<Pod::Hyperlink> +(for parsing the contents of C<LE<gt>E<lt>> sequences) and B<Pod::Cache> +(for caching information about pod files, e.g. link nodes). - =item B<-help> +=item Pod::Select, podselect - Print a brief help message and exits. +Pod::Select is a subclass of Pod::Parser which provides a function +named "podselect()" to filter out user-specified sections of raw pod +documentation from an input stream. podselect is a script that provides +access to Pod::Select from other scripts to be used as a filter. +See L<Pod::Select>. - =item B<-man> +=item Pod::Usage, pod2usage - Prints the manual page and exits. - - =back - - =head1 DESCRIPTION - - B<This program> will read the given input file(s) and do something - useful with the contents thereof. +Pod::Usage provides the function "pod2usage()" to print usage messages for +a Perl script based on its embedded pod documentation. The pod2usage() +function is generally useful to all script authors since it lets them +write and maintain a single source (the pods) for documentation, thus +removing the need to create and maintain redundant usage message text +consisting of information already in the pods. - =cut +There is also a pod2usage script which can be used from other kinds of +scripts to print usage messages from pods (even for non-Perl scripts +with pods embedded in comments). -For details, please see L<Pod::Usage>. +For details and examples, please see L<Pod::Usage>. =item Pod::Text and Pod::Man @@ -2294,8 +2272,8 @@ L<perlvms>) so that the environ array isn't the target of the change to =item Unknown open() mode '%s' (F) The second argument of 3-argument open() is not among the list -of valid modes: C<L<lt>>, C<L<gt>>, C<E<gt>E<gt>>, C<+L<lt>>, -C<+L<gt>>, C<+E<gt>E<gt>>, C<-|>, C<|->. +of valid modes: C<E<lt>>, C<E<gt>>, C<E<gt>E<gt>>, C<+E<lt>>, +C<+E<gt>>, C<+E<gt>E<gt>>, C<-|>, C<|E<45>>. =item Unknown process %x sent message to prime_env_iter: %s |