Front page | perl.perl5.porters |
Postings from February 2013
[perl #116963] Add documentation on the advantages of perldoc for man users to perl.pod
Thread Next
From:
rrt @ sc3d . org
Date:
February 27, 2013 13:49
Subject:
[perl #116963] Add documentation on the advantages of perldoc for man users to perl.pod
Message ID:
rt-3.6.HEAD-31961-1361972926-471.116963-75-0@perl.org
# New Ticket Created by rrt@sc3d.org
# Please include the string: [perl #116963]
# in the subject line of all future correspondence about this issue.
# <URL: https://rt.perl.org:443/rt3/Ticket/Display.html?id=116963 >
This is a bug report for perl from rrt@sc3d.org,
generated with the help of perlbug 1.39 running under perl 5.14.2.
-----------------------------------------------------------------
[Please describe your issue here]
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,
+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
--
1.7.10.4
[Please do not change anything below this line]
-----------------------------------------------------------------
---
Flags:
category=docs
severity=low
---
Site configuration information for perl 5.14.2:
Configured by Debian Project at Tue Nov 27 00:50:56 UTC 2012.
Summary of my perl5 (revision 5 version 14 subversion 2) configuration:
Platform:
osname=linux, osvers=3.2.0-23-generic, archname=x86_64-linux-gnu-thread-multi
uname='linux komainu 3.2.0-23-generic #36-ubuntu smp tue apr 10 20:39:51 utc 2012 x86_64 x86_64 x86_64 gnulinux '
config_args='-Dusethreads -Duselargefiles -Dccflags=-DDEBIAN -D_FORTIFY_SOURCE=2 -g -O2 -fstack-protector --param=ssp-buffer-size=4 -Wformat -Werror=format-security -Dldflags= -Wl,-Bsymbolic-functions -Wl,-z,relro -Dlddlflags=-shared -Wl,-Bsymbolic-functions -Wl,-z,relro -Dcccdlflags=-fPIC -Darchname=x86_64-linux-gnu -Dprefix=/usr -Dprivlib=/usr/share/perl/5.14 -Darchlib=/usr/lib/perl/5.14 -Dvendorprefix=/usr -Dvendorlib=/usr/share/perl5 -Dvendorarch=/usr/lib/perl5 -Dsiteprefix=/usr/local -Dsitelib=/usr/local/share/perl/5.14.2 -Dsitearch=/usr/local/lib/perl/5.14.2 -Dman1dir=/usr/share/man/man1 -Dman3dir=/usr/share/man/man3 -Dsiteman1dir=/usr/local/man/man1 -Dsiteman3dir=/usr/local/man/man3 -Duse64bitint -Dman1ext=1 -Dman3ext=3perl -Dpager=/usr/bin/sensible-pager -Uafs -Ud_csh -Ud_ualarm -Uusesfio -Uusenm -Ui_libutil -DDEBUGGING=-g -Doptimize=-O2 -Duseshrplib -Dlibperl=libperl.so.5.14.2 -des'
hint=recommended, useposix=true, d_sigaction=define
useithreads=define, usemultiplicity=define
useperlio=define, d_sfio=undef, uselargefiles=define, usesocks=undef
use64bitint=define, use64bitall=define, uselongdouble=undef
usemymalloc=n, bincompat5005=undef
Compiler:
cc='cc', ccflags ='-D_REENTRANT -D_GNU_SOURCE -DDEBIAN -fstack-protector -fno-strict-aliasing -pipe -I/usr/local/include -D_LARGEFILE_SOURCE -D_FILE_OFFSET_BITS=64',
optimize='-O2 -g',
cppflags='-D_REENTRANT -D_GNU_SOURCE -DDEBIAN -fstack-protector -fno-strict-aliasing -pipe -I/usr/local/include'
ccversion='', gccversion='4.7.2', gccosandvers=''
intsize=4, longsize=8, ptrsize=8, doublesize=8, byteorder=12345678
d_longlong=define, longlongsize=8, d_longdbl=define, longdblsize=16
ivtype='long', ivsize=8, nvtype='double', nvsize=8, Off_t='off_t', lseeksize=8
alignbytes=8, prototype=define
Linker and Libraries:
ld='cc', ldflags =' -fstack-protector -L/usr/local/lib'
libpth=/usr/local/lib /lib/x86_64-linux-gnu /lib/../lib /usr/lib/x86_64-linux-gnu /usr/lib/../lib /lib /usr/lib
libs=-lgdbm -lgdbm_compat -ldb -ldl -lm -lpthread -lc -lcrypt
perllibs=-ldl -lm -lpthread -lc -lcrypt
libc=, so=so, useshrplib=true, libperl=libperl.so.5.14.2
gnulibc_version='2.15'
Dynamic Linking:
dlsrc=dl_dlopen.xs, dlext=so, d_dlsymun=undef, ccdlflags='-Wl,-E'
cccdlflags='-fPIC', lddlflags='-shared -L/usr/local/lib -fstack-protector'
Locally applied patches:
---
@INC for perl 5.14.2:
/home/rrt/local/x86_64-linux-gnu-thread-multi/lib/perl/5.14.2
/home/rrt/local/share/perl/5.14.2
/home/rrt/local/share/perl
/etc/perl
/usr/local/lib/perl/5.14.2
/usr/local/share/perl/5.14.2
/usr/lib/perl5
/usr/share/perl5
/usr/lib/perl/5.14
/usr/share/perl/5.14
/usr/local/lib/site_perl
.
---
Environment for perl 5.14.2:
HOME=/home/rrt
LANG=en_GB.UTF-8
LANGUAGE=en_GB:en
LC_ADDRESS=en_GB.UTF-8
LC_IDENTIFICATION=en_GB.UTF-8
LC_MEASUREMENT=en_GB.UTF-8
LC_MONETARY=en_GB.UTF-8
LC_NAME=en_GB.UTF-8
LC_NUMERIC=en_GB.UTF-8
LC_PAPER=en_GB.UTF-8
LC_TELEPHONE=en_GB.UTF-8
LC_TIME=en_GB.UTF-8
LD_LIBRARY_PATH=/home/rrt/local/lib/x86_64-linux-gnu
LOGDIR (unset)
PATH=/home/rrt/local/libexec/x86_64-linux-gnu/cw:/home/rrt/bin:/home/rrt/.local/bin:/home/rrt/.cabal/bin:/home/rrt/.gem/ruby/1.9.1/bin:/home/rrt/local/bin/x86_64-linux-gnu:/home/rrt/local/bin:/usr/lib/ccache:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/usr/games:/usr/local/games:/home/rrt/local/lib/go/bin:/home/rrt/Work/Adsensus/git-svn/adsensus/trunk
PERL5LIB=/home/rrt/local/x86_64-linux-gnu-thread-multi/lib/perl/5.14.2:/home/rrt/local/share/perl
PERL_BADLANG (unset)
SHELL=/bin/bash
Thread Next
-
[perl #116963] Add documentation on the advantages of perldoc for man users to perl.pod
by rrt @ sc3d . org