.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.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
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "App::Stacktrace 3pm"
.TH App::Stacktrace 3pm 2024-03-07 "perl v5.38.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
App::Stacktrace \- Stack trace
.SH VERSION
.IX Header "VERSION"
version 0.09
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&  perl\-stacktrace [option] pid
\&
\&    \-m      Prints a gdb script
\&    \-v      Verbose debugging
\&    \-c      Additionally, prints C stacktrace
\&    \-\-help  Show this help
\&
\&    \-\-exec  exec() into gdb
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
perl-stacktrace prints Perl stack traces of Perl threads for a given
Perl process. For each Perl frame, the full file name and line number
are printed.
.PP
For example, a stack dump of a running perl program:
.PP
.Vb 3
\&    $ ps x | grep cpan
\&    24077 pts/12   T      0:01 /usr/local/bin/perl /usr/local/bin/cpan
\&    24093 pts/12   S+     0:00 grep cpan
\&
\&    $ perl\-stacktrace 24077
\&    0x00d73416 in _\|_kernel_vsyscall ()
\&    /usr/local/bin/cpan:11
\&    /usr/local/lib/perl5/5.12.2/App/Cpan.pm:364
\&    /usr/local/lib/perl5/5.12.2/App/Cpan.pm:295
\&    /usr/local/lib/perl5/5.12.2/CPAN.pm:339
\&    /usr/local/lib/perl5/5.12.2/Term/ReadLine.pm:198
.Ve
.SH API
.IX Header "API"
There exists an internal API
.SS new
.IX Subsection "new"
This accepts the following parameters by applying them through
Getopt::Long. This is actually just a front for the script
\&\fIperl-stacktrace\fR's command line handling.
.PP
.Vb 7
\&  App::Stacktrace\->new(
\&      $pid,       # The process to attach to
\&      \*(Aqm\*(Aq,        # Dump the generated script
\&      \*(Aqv\*(Aq,        # Verbose
\&      \*(Aqexec\*(Aq,     # exec() into gdb
\&      \*(Aq\-\-noexec\*(Aq, # system() into gdb
\&  );
.Ve
.SS run
.IX Subsection "run"
Runs the app program as configured by the \f(CW\*(C`\->new(...)\*(C'\fR method.
.PP
.Vb 2
\&    $obj = App::Stacktrace\->new( ... );
\&    $obj\->run;
.Ve