.\" Automatically generated by Pod::Man 4.14 (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
..
.\" 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.  \*(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-
.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" ''
.    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 "Test::Valgrind::Tool::memcheck 3pm"
.TH Test::Valgrind::Tool::memcheck 3pm "2023-08-04" "perl v5.36.0" "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"
Test::Valgrind::Tool::memcheck \- Run an analysis through the memcheck tool.
.SH "VERSION"
.IX Header "VERSION"
Version 1.19
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This class contains the information required by the session for running the \f(CW\*(C`memcheck\*(C'\fR tool.
.SH "METHODS"
.IX Header "METHODS"
This class inherits Test::Valgrind::Tool.
.ie n .SS """requires_version"""
.el .SS "\f(CWrequires_version\fP"
.IX Subsection "requires_version"
.Vb 1
\&    my $required_version = $tvt\->requires_version;
.Ve
.PP
This tool requires \f(CW\*(C`valgrind\*(C'\fR \f(CW3.1.0\fR.
.ie n .SS """new"""
.el .SS "\f(CWnew\fP"
.IX Subsection "new"
.Vb 4
\&    my $tvtm = Test::Valgrind::Tool::memcheck\->new(
\&     callers => $callers,
\&     %extra_args,
\&    );
.Ve
.PP
Your usual constructor.
.PP
\&\f(CW$callers\fR specifies the number of stack frames to inspect for errors : the bigger you set it, the more granular the analysis is.
.PP
Other arguments are passed straight to \f(CW\*(C`Test::Valgrind::Tool\->new\*(C'\fR.
.ie n .SS """callers"""
.el .SS "\f(CWcallers\fP"
.IX Subsection "callers"
.Vb 1
\&    my $callers = $tvtm\->callers;
.Ve
.PP
Read-only accessor for the \f(CW\*(C`callers\*(C'\fR option.
.ie n .SS """parser_class"""
.el .SS "\f(CWparser_class\fP"
.IX Subsection "parser_class"
.Vb 1
\&    my $parser_class = $tvtm\->parser_class($session);
.Ve
.PP
This tool uses a Test::Valgrind::Parser::XML::Twig parser in analysis mode, and a Test::Valgrind::Parser::Suppressions::Text parser in suppressions mode.
.ie n .SS """report_class"""
.el .SS "\f(CWreport_class\fP"
.IX Subsection "report_class"
.Vb 1
\&    my $report_class = $tvtm\->report_class($session);
.Ve
.PP
This tool emits \f(CW\*(C`Test::Valgrind::Tool::memcheck::Report\*(C'\fR object reports in analysis mode, and \f(CW\*(C`Test::Valgrind::Report::Suppressions\*(C'\fR object reports in suppressions mode.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Test::Valgrind, Test::Valgrind::Tool.
.SH "AUTHOR"
.IX Header "AUTHOR"
Vincent Pit, \f(CW\*(C`<perl at profvince.com>\*(C'\fR, <http://www.profvince.com>.
.PP
You can contact me by mail or on \f(CW\*(C`irc.perl.org\*(C'\fR (vincent).
.SH "BUGS"
.IX Header "BUGS"
Please report any bugs or feature requests to \f(CW\*(C`bug\-test\-valgrind at rt.cpan.org\*(C'\fR, or through the web interface at <http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Test\-Valgrind>.
I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.
.SH "SUPPORT"
.IX Header "SUPPORT"
You can find documentation for this module with the perldoc command.
.PP
.Vb 1
\&    perldoc Test::Valgrind::Tool::memcheck
.Ve
.SH "COPYRIGHT & LICENSE"
.IX Header "COPYRIGHT & LICENSE"
Copyright 2009,2010,2011,2013,2015,2016 Vincent Pit, all rights reserved.
.PP
This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.