ActivePerl Documentation
Table of Contents
Getting Started
Welcome To ActivePerl Release Notes Readme ActivePerl Change Log Install Notes Linux Solaris Windows ActivePerl Components Overview PPM Windows Specifics OLE Browser PerlScript Perl for ISAPI PerlEZ ActivePerl FAQ Introduction Availability & Install Using PPM Docs & Support Windows Specifics Perl for ISAPI Windows 9X/NT/2000 Quirks Web Server Config Web programming Programming Modules & Samples Embedding & Extending Using OLE with Perl Windows Scripting Active Server Pages Windows Script Host Windows Script ComponentsCore Perl Documentation
perl perlfaq perltoc perlbook perlsyn perldata perlop perlreftut perldsc perllol perllexwarn perldebug perlrun perlfunc perlopentut perlvar perlsub perlmod perlpod perlstyle perlmodlib perlmodinstall perltrap perlport perlsec perlref perlre perlform perllocale perlunicode perlboot perltoot perltootc perlobj perlbot perltie perlipc perlnumber perlfork perlthrtut perldiag perlfaq1 perlfaq2 perlfaq3 perlfaq4 perlfaq5 perlfaq6 perlfaq7 perlfaq8 perlfaq9 perlcompile perlembed perlxstut perlxs perlguts perlcall perlfilter perldbmfilter perlapi perlintern perlapio perltodo perlhack perlhist perldelta perl5005delta perl5004delta perlamiga perlcygwin perldos perlhpux perlmachten perlos2 perlos390 perlvms perlwin32Pragmas
attributes attrs autouse base blib bytes charnames constant diagnostics fields filetest integer less lib locale lwpcook open ops overload perllocal re sigtrap strict subs utf8 vars warningsLibraries
ActivePerl DocTools TOC RDF AnyDBM_File Archive Tar AutoLoader AutoSplit B Asmdata Assembler Bblock Bytecode C CC Debug Deparse Disassembler Lint Showlex Stackobj Terse Xref Benchmark Bundle LWP ByteLoader Carp Heavy CGI Apache Carp Cookie Fast Pretty Push Switch Class Struct Compress Zlib Config CPAN FirstTime Nox Cwd Data Dumper DB Devel DProf Peek SelfStubber Digest HMAC HMAC_MD5 HMAC_SHA1 MD2 MD5 SHA1 DirHandle Dumpvalue DynaLoader English Env Errno Exporter Heavy ExtUtils Command Embed Install Installed Liblist MakeMaker Manifest Miniperl Mkbootstrap Mksymlists MM_Cygwin MM_OS2 MM_Unix MM_VMS MM_Win32 Packlist testlib Fatal Fcntl File Basename CheckTree Compare Copy CounterFile DosGlob Find Glob Listing Path Spec Functions Mac OS2 Unix VMS Win32 stat FileCache FileHandle FindBin Font AFM Getopt Long Std HTML AsSubs Element Entities Filter Form FormatPS Formatter FormatText HeadParser LinkExtor Parse Parser TokeParser TreeBuilder HTTP Cookies Daemon Date Headers Util Message Negotiate Request Common Response Status I18N Collate IO Dir File Handle Pipe Poll Seekable Select Socket INET UNIX IPC Msg Open2 Open3 Semaphore SysV LWP Debug MediaTypes MemberMixin Protocol RobotUA Simple UserAgent Math BigFloat BigInt Complex Trig MD5 MIME Base64 QuotedPrint NDBM_File Net Cmd Config Domain DummyInetd FTP hostent libnetFAQ netent Netrc NNTP PH Ping POP3 protoent servent SMTP SNPP Time O ODBM_File Opcode Pod Checker Find Html InputObjects Man Parser ParseUtils Plainer Select Text Color Termcap Usage POSIX PPM SOAPClient SOAPServer Safe SDBM_File Search Dict SelectSaver SelfLoader SHA Shell SOAP Defs Envelope EnvelopeMaker GenericHashSerializer GenericInputStream GenericScalarSerializer Lite OutputStream Packager Parser Transport HTTP Apache CGI Client Server LOCAL MAILTO POP3 TCP TypeMapper Socket Symbol Sys Hostname Syslog Term ANSIColor Cap Complete ReadLine Test Harness Text Abbrev ParseWords Soundex Tabs Wrap Thread Queue Semaphore Signal Specific Tie Array Handle Hash RefHash Scalar SubstrHash Time gmtime Local localtime tm UDDI Lite UNIVERSAL URI data Escape file Heuristic ldap URL WithBase User grent pwent Win32 AuthenticateUser ChangeNotify Clipboard Console Event EventLog File FileSecurity Internet IPC Mutex NetAdmin NetResource ODBC OLE Const Enum NEWS NLS TPJ Variant PerfLib Pipe Process Registry Semaphore Service Sound TieRegistry Win32API File Net Registry WWW RobotRules AnyDBM_File XML Element Parser Expat PPD PPMConfig ValidatingElement XSLoader|
B::Xref - Generates cross reference reports for Perl programs |
NAME
B::Xref - Generates cross reference reports for Perl programs
SUPPORTED PLATFORMS
- Linux
- Solaris
- Windows
SYNOPSIS
perl -MO=Xref[,OPTIONS] foo.pl
DESCRIPTION
The B::Xref module is used to generate a cross reference listing of all definitions and uses of variables, subroutines and formats in a Perl program. It is implemented as a backend for the Perl compiler.
The report generated is in the following format:
File filename1
Subroutine subname1
Package package1
object1 C<line numbers>
object2 C<line numbers>
...
Package package2
...
Each File section reports on a single file. Each Subroutine section reports on a single subroutine apart from the special cases ``(definitions)'' and ``(main)''. These report, respectively, on subroutine definitions found by the initial symbol table walk and on the main part of the program or module external to all subroutines.
The report is then grouped by the Package of each variable,
subroutine or format with the special case ``(lexicals)'' meaning
lexical variables. Each object name (implicitly qualified by its
containing Package) includes its type character(s) at the beginning
where possible. Lexical variables are easier to track and even
included dereferencing information where possible.
The line numbers are a comma separated list of line numbers (some
preceded by code letters) where that object is used in some way.
Simple uses aren't preceded by a code letter. Introductions (such as
where a lexical is first defined with my) are indicated with the
letter ``i''. Subroutine and method calls are indicated by the character
``&''. Subroutine definitions are indicated by ``s'' and format
definitions by ``f''.
OPTIONS
Option words are separated by commas (not whitespace) and follow the usual conventions of compiler backend options.
-oFILENAME
-
Directs output to
FILENAMEinstead of standard output. -r
- Raw output. Instead of producing a human-readable report, outputs a line in machine-readable form for each definition/use of a variable/sub/format.
-D[tO]
-
(Internal) debug options, probably only useful if
-rincluded. Thetoption prints the object on the top of the stack as it's being tracked. TheOoption prints each operator as it's being processed in the execution order of the program.
BUGS
Non-lexical variables are quite difficult to track through a program. Sometimes the type of a non-lexical variable's use is impossible to determine. Introductions of non-lexical non-scalars don't seem to be reported properly.
AUTHOR
Malcolm Beattie, mbeattie@sable.ox.ac.uk.
|
B::Xref - Generates cross reference reports for Perl programs |