[thirdparty/man-pages.git] / man1 / memusagestat.1

.\" 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 MEMUSAGESTAT 1 2019-03-06 "GNU" "Linux programmer's manual"
.SH NAME
memusagestat \- generate graphic from memory profiling data
.SH SYNOPSIS
.BR memusagestat " [\fIoption\fR]... \fIdatafile\fR [\fIoutfile\fR]"
.SH DESCRIPTION
.B memusagestat
creates a PNG file containing a graphical representation of the
memory profiling data in the file
.IR datafile ;
that file is generated via the
.I -d
(or
.IR --data )
option of
.BR memusage (1).
.PP
The red line in the graph shows the heap usage (allocated memory)
and the green line shows the stack usage.
The x-scale is either the number of memory-handling function calls or
(if the
.I -t
option is specified)
time.
.SH OPTIONS
.TP
.BI \-o\  file \fR,\ \fB\-\-output= file
Name of the output file.
.TP
.BI \-s\  string \fR,\ \fB\-\-string= string
Use
.I string
as the title inside the output graph.
.TP
.B \-t\fR,\ \fB\-\-time
Use time (rather than number of function calls) as the scale for the X axis.
.TP
.B \-T\fR,\ \fB\-\-total
Also draw a graph of total memory consumption.
.TP
.BI \-x\  size \fR,\ \fB\-\-x-size= size
Make the output graph
.I size
pixels wide.
.TP
.BI \-y\  size \fR,\ \fB\-\-y\-size= size
Make the output graph
.I size
pixels high.
.TP
.B \-?\fR,\ \fB\-\-help
Print a help message and exit.
.TP
.B \-\-usage
Print a short usage message and exit.
.TP
.B \-V\fR,\ \fB\-\-version
Print version information and exit.
.SH BUGS
To report bugs, see
.UR http://www.gnu.org/software/libc/bugs.html
.UE
.SH EXAMPLE
See
.BR memusage (1).
.SH SEE ALSO
.BR memusage (1),
.BR mtrace (1)
Commit	Line	Data
f170e1cc	1	.\" Copyright (c) 2013, Peter Schiffer <pschiffe@redhat.com>
16e05f30 PS	2	.\"
	3	.\" %%%LICENSE_START(GPLv2+_DOC_FULL)
	4	.\" This is free documentation; you can redistribute it and/or
	5	.\" modify it under the terms of the GNU General Public License as
	6	.\" published by the Free Software Foundation; either version 2 of
	7	.\" the License, or (at your option) any later version.
	8	.\"
	9	.\" The GNU General Public License's references to "object code"
	10	.\" and "executables" are to be interpreted as the output of any
	11	.\" document formatting or typesetting system, including
	12	.\" intermediate and printed output.
	13	.\"
	14	.\" This manual is distributed in the hope that it will be useful,
	15	.\" but WITHOUT ANY WARRANTY; without even the implied warranty of
	16	.\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	17	.\" GNU General Public License for more details.
	18	.\"
	19	.\" You should have received a copy of the GNU General Public
	20	.\" License along with this manual; if not, see
	21	.\" <http://www.gnu.org/licenses/>.
	22	.\" %%%LICENSE_END
9ba01802	23	.TH MEMUSAGESTAT 1 2019-03-06 "GNU" "Linux programmer's manual"
16e05f30 PS	24	.SH NAME
	25	memusagestat \- generate graphic from memory profiling data
	26	.SH SYNOPSIS
	27	.BR memusagestat " [\fIoption\fR]... \fIdatafile\fR [\fIoutfile\fR]"
	28	.SH DESCRIPTION
	29	.B memusagestat
a863cb3a MK	30	creates a PNG file containing a graphical representation of the
	31	memory profiling data in the file
	32	.IR datafile ;
	33	that file is generated via the
	34	.I -d
	35	(or
	36	.IR --data )
	37	option of
	38	.BR memusage (1).
2a86152e	39	.PP
a863cb3a MK	40	The red line in the graph shows the heap usage (allocated memory)
	41	and the green line shows the stack usage.
	42	The x-scale is either the number of memory-handling function calls or
	43	(if the
	44	.I -t
	45	option is specified)
	46	time.
16e05f30 PS	47	.SH OPTIONS
	48	.TP
	49	.BI \-o\ file \fR,\ \fB\-\-output= file
	50	Name of the output file.
	51	.TP
	52	.BI \-s\ string \fR,\ \fB\-\-string= string
a863cb3a MK	53	Use
	54	.I string
	55	as the title inside the output graph.
16e05f30	56	.TP
a28b73cd	57	.B \-t\fR,\ \fB\-\-time
a863cb3a	58	Use time (rather than number of function calls) as the scale for the X axis.
16e05f30	59	.TP
a28b73cd	60	.B \-T\fR,\ \fB\-\-total
a863cb3a	61	Also draw a graph of total memory consumption.
16e05f30 PS	62	.TP
16e05f30 PS	63	.BI \-x\ size \fR,\ \fB\-\-x-size= size
a863cb3a MK	64	Make the output graph
	65	.I size
	66	pixels wide.
16e05f30 PS	67	.TP
16e05f30 PS	68	.BI \-y\ size \fR,\ \fB\-\-y\-size= size
a863cb3a MK	69	Make the output graph
	70	.I size
	71	pixels high.
16e05f30	72	.TP
a28b73cd	73	.B \-?\fR,\ \fB\-\-help
a863cb3a	74	Print a help message and exit.
16e05f30	75	.TP
a28b73cd	76	.B \-\-usage
16e05f30 PS	77	Print a short usage message and exit.
16e05f30 PS	78	.TP
a28b73cd	79	.B \-V\fR,\ \fB\-\-version
16e05f30	80	Print version information and exit.
16e05f30	81	.SH BUGS
a863cb3a MK	82	To report bugs, see
	83	.UR http://www.gnu.org/software/libc/bugs.html
	84	.UE
f2ae94cd MK	85	.SH EXAMPLE
	86	See
	87	.BR memusage (1).
16e05f30	88	.SH SEE ALSO
a863cb3a MK	89	.BR memusage (1),
a863cb3a MK	90	.BR mtrace (1)