File: //proc/2/root/usr/local/share/man/man1/cpangraph.1
.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings. \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote. | will give a
.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to
.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C'
.\" expand to `' in nroff, nothing in troff, for use with C<>.
.tr \(*W-|\(bv\*(Tr
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
. ds -- \(*W-
. ds PI pi
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
. ds L" ""
. ds R" ""
. ds C` ""
. ds C' ""
'br\}
.el\{\
. ds -- \|\(em\|
. ds PI \(*p
. ds L" ``
. ds R" ''
'br\}
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD. Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.if \nF \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. nr % 0
. rr F
.\}
.\"
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.hy 0
.if n .na
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff
.if n \{\
. ds #H 0
. ds #V .8m
. ds #F .3m
. ds #[ \f1
. ds #] \fP
.\}
.if t \{\
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
. ds #V .6m
. ds #F 0
. ds #[ \&
. ds #] \&
.\}
. \" simple accents for nroff and troff
.if n \{\
. ds ' \&
. ds ` \&
. ds ^ \&
. ds , \&
. ds ~ ~
. ds /
.\}
.if t \{\
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
. \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
. \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
. \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
. ds : e
. ds 8 ss
. ds o a
. ds d- d\h'-1'\(ga
. ds D- D\h'-1'\(hy
. ds th \o'bp'
. ds Th \o'LP'
. ds ae ae
. ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "CPANGRAPH 1"
.TH CPANGRAPH 1 "2011-11-25" "perl v5.8.8" "User Contributed Perl Documentation"
.SH "NAME"
cpangraph \- Generate dependency chain graphs for CPAN modules
.SH "VERSION"
.IX Header "VERSION"
Version 0.12
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\& cpangraph [options] <file>
.Ve
.PP
.Vb 7
\& Options:
\& --help display a brief help message
\& --perl=VERSION filter those available in Perl core
\& --phase=PHASE filter those needed for a phase (e.g., build)
\& --rankdir controls the GraphViz 'rankdir' variable
\& --reverse graph reverse dependencies (dependents)
\& --verbose display additional debugging information
.Ve
.SH "OPTIONS"
.IX Header "OPTIONS"
.IP "\fB\-\-help\fR" 4
.IX Item "--help"
Prints a brief help message to the standard output and exits.
.IP "\fB\-\-perl\fR=VERSION" 4
.IX Item "--perl=VERSION"
This displays dependencies which have been available in Perl core since
the given \s-1VERSION\s0. It does not currently know if a module has been removed
from core, but this is an unlikely occurrence. Specify Perl versions in
the form:
.Sp
.Vb 2
\& 5.008008 # for versions >= 5.8.8
\& 5.010 # for versions >= 5.10
.Ve
.IP "\fB\-\-phase\fR=PHASE" 4
.IX Item "--phase=PHASE"
This displays dependencies which are needed for a given module's install
or runtime \s-1PHASE\s0. Available phases are:
.RS 4
.IP "* runtime: required whenever the module is used" 4
.IX Item "runtime: required whenever the module is used"
.PD 0
.IP "* build: required to build the module" 4
.IX Item "build: required to build the module"
.IP "* configure: these are required while preparing the module for build" 4
.IX Item "configure: these are required while preparing the module for build"
.RE
.RS 4
.RE
.IP "\fB\-\-rankdir\fR" 4
.IX Item "--rankdir"
.PD
In GraphViz, the 'rankdir' attribute controls the direction that the nodes
are linked together. If set, the graph will use left \-> right linking of
nodes rather than the default up-down linking.
.IP "\fB\-\-reverse\fR" 4
.IX Item "--reverse"
Create a graph of the reverse dependencies of a package (the packages which
depend on it, or dependent packages).
.IP "\fB\-\-verbose\fR" 4
.IX Item "--verbose"
Display extra output useful during debugging.
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\fBThis script\fR will use the \s-1CPAN\s0 Database to build a graph of a package's
dependencies or reverse dependencies (dependent packages).
.SH "AUTHOR"
.IX Header "AUTHOR"
Adam Kennedy <adamk@cpan.org>
.SH "SUPPORT"
.IX Header "SUPPORT"
For support details, please look at \f(CW\*(C`perldoc CPANDB\*(C'\fR and use the
corresponding support methods.
.SH "LICENSE"
.IX Header "LICENSE"
This has the same copyright and licensing terms as \s-1CPANDB\s0.