develooper Front page | perl.perl5.porters | Postings from February 2013

Re: [perl #116963] Add documentation on the advantages of perldocfor man users to perl.pod

Thread Previous | Thread Next
From:
H.Merijn Brand
Date:
February 27, 2013 14:01
Subject:
Re: [perl #116963] Add documentation on the advantages of perldocfor man users to perl.pod
Message ID:
20130227150115.07e94539@pc09.procura.nl
On Wed, 27 Feb 2013 05:48:46 -0800, "rrt@sc3d.org (via RT)"
<perlbug-followup@perl.org> wrote:

> This patch, against current git, aims to make the perl documentation a
> little more accessible to users used to man rather than perldoc, and
> in particular to avoid misunderstandings such as that outlined in
> issue #62136, out of which this patch arose.
> 
> diff --git a/pod/perl.pod b/pod/perl.pod
> index d3f9c05..dd777e1 100644
> --- a/pod/perl.pod
> +++ b/pod/perl.pod
> @@ -280,6 +280,12 @@ aux a2p c2ph h2ph h2xs perlbug pl2pm pod2html pod2man s2p splain xsubpp
>  On a Unix-like system, these documentation files will usually also be
>  available as manpages for use with the F<man> program.
>  
> +Some documentation is not available as man pages, so if a
> +cross-reference is not found by man, try it with perldoc.  Perldoc can
> +also take you directly to documentation for functions (with the B<-f>
> +switch) and FAQ entries (with the B<-Q> switch).  For these reasons,
                                       -q

there is no -Q option

> +you may prefer to use perldoc instead of man.
> +
>  In general, if something strange has gone wrong with your program and you're
>  not sure where you should look for help, try making your code comply with
>  B<use strict> and B<use warnings>.  These will often point out exactly


-- 
H.Merijn Brand  http://tux.nl   Perl Monger  http://amsterdam.pm.org/
using perl5.00307 .. 5.17   porting perl5 on HP-UX, AIX, and openSUSE
http://mirrors.develooper.com/hpux/        http://www.test-smoke.org/
http://qa.perl.org   http://www.goldmark.org/jeff/stupid-disclaimers/

Thread Previous | Thread Next


nntp.perl.org: Perl Programming lists via nntp and http.
Comments to Ask Bjørn Hansen at ask@perl.org | Group listing | About