=head1 NAME

Apache::Status - Embedded interpreter status information

=head1 Synopsis

  <Location /perl-status>

    # disallow public access
    Order Deny, Allow
    Deny from all
    Allow from 127.0.0.1

    SetHandler  perl-script
    PerlHandler Apache::Status
  </Location>

=head1 Description

The C<Apache::Status> module provides some information about the
status of the Perl interpreter embedded in the server.

Configure like so:

  <Location /perl-status>

    # disallow public access
    Order Deny, Allow
    Deny from all
    Allow from 127.0.0.1

    SetHandler  perl-script
    PerlHandler Apache::Status
  </Location>

Other modules can "plugin" a menu item like so:

  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 \@strings;     #return an array ref
     }
  ) if Apache->module("Apache::Status"); #only if Apache::Status is loaded

B<WARNING>: C<Apache::Status> must be loaded before these modules via
the C<PerlModule> or C<PerlRequire> directives.

=head1 Options

=over 4

=item StatusOptionsAll

This single directive will enable all of the options described below.

  PerlSetVar StatusOptionsAll On

=item StatusDumper

When browsing symbol tables, the values of arrays, hashes and scalars
can be viewed via C<Data::Dumper> if this configuration variable is
set to On:

  PerlSetVar StatusDumper On

=item StatusPeek

With this option I<On> and the C<Apache::Peek> module installed,
functions and variables can be viewed ala C<Devel::Peek> style:

  PerlSetVar StatusPeek On

=item StatusLexInfo

With this option On and the C<B::LexInfo> module installed, subroutine
lexical variable information can be viewed.

  PerlSetVar StatusLexInfo On

=item StatusDeparse

With this option On and C<B::Deparse> version 0.59 or higher (included
in Perl 5.005_59+), subroutines can be "deparsed".

  PerlSetVar StatusDeparse On

Options can be passed to C<B::Deparse::new> like so:

  PerlSetVar StatusDeparseOptions "-p -sC"

See the C<B::Deparse> manpage for details.

=item StatusTerse

With this option I<On>, text-based op tree graphs of subroutines can
be displayed, thanks to C<B::Terse>.

  PerlSetVar StatusTerse On

=item StatusTerseSize

With this option On and the C<B::TerseSize> module installed,
text-based op tree graphs of subroutines and their size can be
displayed.  See the C<B::TerseSize> docs for more info.

  PerlSetVar StatusTerseSize On

=item StatusTerseSizeMainSummary

With this option On and the C<B::TerseSize> module installed, a
"Memory Usage" will be added to the C<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 C<-X> mode, as the results will be cached.

  PerlSetVar StatusTerseSizeMainSummary On

=item StatusGraph

When C<StatusDumper> is enabled, another link "OP Tree Graph" will be
present with the dump if this configuration variable is set to On:

  PerlSetVar StatusGraph

This requires the C<B> module (part of the Perl compiler kit) and
C<B::Graph> (version 0.03 or higher) module to be installed along with
the C<dot> program.

Dot is part of the graph visualization toolkit from AT&T:
http://www.research.att.com/sw/tools/graphviz/ ).

B<WARNING>: Some graphs may produce very large images, some graphs may
produce no image if C<B::Graph>'s output is incorrect. 

=item Dot

Location of the dot program for C<StatusGraph>, if other than
I</usr/bin> or I</usr/local/bin>.

=item GraphDir

Directory where C<StatusGraph> should write it's temporary image
files.  Default is I<$ServerRoot/logs/b_graphs>.

=back

=head1 Prerequisites

The C<Devel::Symdump> module, version B<2.00> or higher.

=head1 See Also

perl, L<Apache>, C<Devel::Symdump>, C<Data::Dumper>, C<B>, C<B::Graph>

=head1 Maintainers

Maintainer is the person(s) you should contact with updates,
corrections and patches.

=over

=item * The L<documentation mailing list|maillist::docs-dev>

=back

=head1 Authors

=over

=item * Doug MacEachern

=back

Only the major authors are listed above. For contributors see the
Changes file.

=cut