Re: For review: mtrace(1) man page

[Jan Chaloupka <jchaloup at redhat dot com>]

Hi Tushar,

On 07/22/2014 09:45 AM, Tushar Shinde wrote:
> Hi Jan,
>
> Is  this MTRACEDATA is same as environment  variable  MALLOC_TRACE 
> of MTRACE(3) ?
> If yes we should keep MALLOC_TRACE instead of MTRACEDATA to avoid 
> confusion.
>
> Tushar

thank you for noticing. Those are script arguments, not environment 
variables. Changed bold into underline.

.\" Copyright (c) 2013, Peter Schiffer (pschiffe@redhat.com)
.\"
.\" %%%LICENSE_START(GPLv2+_DOC_FULL)
.\" This is free documentation; you can redistribute it and/or
.\" modify it under the terms of the GNU General Public License as
.\" published by the Free Software Foundation; either version 2 of
.\" the License, or (at your option) any later version.
.\"
.\" The GNU General Public License's references to "object code"
.\" and "executables" are to be interpreted as the output of any
.\" document formatting or typesetting system, including
.\" intermediate and printed output.
.\"
.\" This manual is distributed in the hope that it will be useful,
.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
.\" GNU General Public License for more details.
.\"
.\" You should have received a copy of the GNU General Public
.\" License along with this manual; if not, see
.\" <http://www.gnu.org/licenses/>.
.\" %%%LICENSE_END
.TH MTRACE 1 2013-04-10 "GNU glibc 2.18" "Memory diagnostic tools"
.SH NAME
mtrace \- interpret the malloc trace log
.SH SYNOPSIS
.BR mtrace " [\fIOPTION\fR]... [\fIBINARY\fR] \fIMTRACEDATA\fR"
.SH DESCRIPTION
.B mtrace
is a Perl script used to interpret and provide human readable output
of the trace log created by
.BR mtrace (3)
function stored in the
\fIMTRACEDATA\fR
file.
If
\fIBINARY\fR
is provided, output of
.B mtrace
also contains source file name with line number information
of problem location
(assuming that
\fIBINARY\fR
was compiled with debugging information).

For more information about
.BR mtrace (3)
function and
.B mtrace
script usage, refer to the
.BR mtrace (3)
manual page.
.SH OPTIONS
.TP
.BI \fB\-\-help
Print help and exit.
.TP
.BI \fB\-\-version
Print version information and exit.
.SH BUGS
For bug reporting instructions, please see:
<http://www.gnu.org/software/libc/bugs.html>.
.SH SEE ALSO
.BR mtrace (3)