.\" 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 "Apache::Status 3"
.TH Apache::Status 3 "2007-03-30" "perl v5.8.8" "User Contributed Perl Documentation"
.SH "NAME"
Apache::Status \- Embedded interpreter status information
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 4
\&
\& SetHandler perl-script
\& PerlHandler Apache::Status
\&
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
The \fBApache::Status\fR module provides some information
about the status of the Perl interpreter embedded in the server.
.PP
Configure like so:
.PP
.Vb 4
\&
\& SetHandler perl-script
\& PerlHandler Apache::Status
\&
.Ve
.PP
Other modules can \*(L"plugin\*(R" a menu item like so:
.PP
.Vb 9
\& Apache::Status->menu_item(
\& 'DBI' => "DBI connections", #item for Apache::DBI module
\& sub {
\& my($r,$q) = @_; #request and CGI objects
\& my(@strings);
\& push @strings, "blobs of html";
\& return \e@strings; #return an array ref
\& }
\& ) if Apache->module("Apache::Status"); #only if Apache::Status is loaded
.Ve
.PP
\&\fB\s-1WARNING\s0\fR: Apache::Status must be loaded before these modules via the
PerlModule or PerlRequire directives.
.SH "OPTIONS"
.IX Header "OPTIONS"
.IP "StatusOptionsAll" 4
.IX Item "StatusOptionsAll"
This single directive will enable all of the options described below.
.Sp
.Vb 1
\& PerlSetVar StatusOptionsAll On
.Ve
.IP "StatusDumper" 4
.IX Item "StatusDumper"
When browsing symbol tables, the values of arrays, hashes ans calars
can be viewed via \fBData::Dumper\fR if this configuration variable is set
to On:
.Sp
.Vb 1
\& PerlSetVar StatusDumper On
.Ve
.IP "StatusPeek" 4
.IX Item "StatusPeek"
With this option On and the \fBApache::Peek\fR module installed,
functions and variables can be viewed ala \fBDevel::Peek\fR style:
.Sp
.Vb 1
\& PerlSetVar StatusPeek On
.Ve
.IP "StatusLexInfo" 4
.IX Item "StatusLexInfo"
With this option On and the \fBB::LexInfo\fR module installed,
subroutine lexical variable information can be viewed.
.Sp
.Vb 1
\& PerlSetVar StatusLexInfo On
.Ve
.IP "StatusDeparse" 4
.IX Item "StatusDeparse"
With this option On and \fBB::Deparse\fR version 0.59 or higher
(included in Perl 5.005_59+), subroutines can be \*(L"deparsed\*(R".
.Sp
.Vb 1
\& PerlSetVar StatusDeparse On
.Ve
.Sp
Options can be passed to B::Deparse::new like so:
.Sp
.Vb 1
\& PerlSetVar StatusDeparseOptions "-p -sC"
.Ve
.Sp
See the \fBB::Deparse\fR manpage for details.
.IP "StatusTerse" 4
.IX Item "StatusTerse"
With this option On, text-based op tree graphs of subroutines can be
displayed, thanks to \fBB::Terse\fR.
.Sp
.Vb 1
\& PerlSetVar StatusTerse On
.Ve
.IP "StatusTerseSize" 4
.IX Item "StatusTerseSize"
With this option On and the \fBB::TerseSize\fR module installed,
text-based op tree graphs of subroutines and their size can be
displayed. See the \fBB::TerseSize\fR docs for more info.
.Sp
.Vb 1
\& PerlSetVar StatusTerseSize On
.Ve
.IP "StatusTerseSizeMainSummary" 4
.IX Item "StatusTerseSizeMainSummary"
With this option On and the \fBB::TerseSize\fR module installed, a
\&\*(L"Memory Usage\*(R" will be added to the Apache::Status main menu. This
option is disabled by default, as it can be rather cpu intensive to
summarize memory usage for the entire server. It is strongly
suggested that this option only be used with a development server
running in \fB\-X\fR mode, as the results will be cached.
.Sp
.Vb 1
\& PerlSetVar StatusTerseSizeMainSummary On
.Ve
.IP "StatusGraph" 4
.IX Item "StatusGraph"
When \fBStatusDumper\fR is enabled, another link \*(L"\s-1OP\s0 Tree Graph\*(R" will be
present with the dump if this configuration variable is set to On:
.Sp
.Vb 1
\& PerlSetVar StatusGraph
.Ve
.Sp
This requires the B module (part of the Perl compiler kit) and
B::Graph (version 0.03 or higher) module to be installed along with
the \fBdot\fR program.
.Sp
Dot is part of the graph visualization toolkit from \s-1AT&T:\s0
\&\f(CW\*(C`http://www.research.att.com/sw/tools/graphviz/\*(C'\fR).
.Sp
\&\fB\s-1WARNING\s0\fR: Some graphs may produce very large images, some graphs may
produce no image if B::Graph's output is incorrect.
.IP "Dot" 4
.IX Item "Dot"
Location of the dot program for StatusGraph,
if other than /usr/bin or /usr/local/bin
.IP "GraphDir" 4
.IX Item "GraphDir"
Directory where StatusGraph should write it's temporary image files.
Default is \f(CW$ServerRoot\fR/logs/b_graphs
.SH "PREREQUISITES"
.IX Header "PREREQUISITES"
The \fIDevel::Symdump\fR module, version \fB2.00\fR or higher.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fIperl\fR\|(1), \fIApache\fR\|(3), \fIDevel::Symdump\fR\|(3), \fIData::Dumper\fR\|(3), B(3), \fIB::Graph\fR\|(3)
.SH "AUTHOR"
.IX Header "AUTHOR"
Doug MacEachern