user_namespaces.7: Minor wording improvement
[man-pages.git] / man1 / memusagestat.1
bloba922eb51724c2e20eaecece4e095908377344be3
1 .\" Copyright (c) 2013, Peter Schiffer <pschiffe@redhat.com>
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
23 .TH MEMUSAGESTAT 1 2021-03-22 "GNU" "Linux programmer's manual"
24 .SH NAME
25 memusagestat \- generate graphic from memory profiling data
26 .SH SYNOPSIS
27 .nf
28 .BR memusagestat " [\fIoption\fR]... \fIdatafile\fR [\fIoutfile\fR]"
29 .fi
30 .SH DESCRIPTION
31 .B memusagestat
32 creates a PNG file containing a graphical representation of the
33 memory profiling data in the file
34 .IR datafile ;
35 that file is generated via the
36 .I \-d
37 (or
38 .IR \-\-data )
39 option of
40 .BR memusage (1).
41 .PP
42 The red line in the graph shows the heap usage (allocated memory)
43 and the green line shows the stack usage.
44 The x-scale is either the number of memory-handling function calls or
45 (if the
46 .I \-t
47 option is specified)
48 time.
49 .SH OPTIONS
50 .TP
51 .BI \-o\  file \fR,\ \fB\-\-output= file
52 Name of the output file.
53 .TP
54 .BI \-s\  string \fR,\ \fB\-\-string= string
55 Use
56 .I string
57 as the title inside the output graph.
58 .TP
59 .B \-t\fR,\ \fB\-\-time
60 Use time (rather than number of function calls) as the scale for the X axis.
61 .TP
62 .B \-T\fR,\ \fB\-\-total
63 Also draw a graph of total memory consumption.
64 .TP
65 .BI \-x\  size \fR,\ \fB\-\-x\-size= size
66 Make the output graph
67 .I size
68 pixels wide.
69 .TP
70 .BI \-y\  size \fR,\ \fB\-\-y\-size= size
71 Make the output graph
72 .I size
73 pixels high.
74 .TP
75 .B \-?\fR,\ \fB\-\-help
76 Print a help message and exit.
77 .TP
78 .B \-\-usage
79 Print a short usage message and exit.
80 .TP
81 .B \-V\fR,\ \fB\-\-version
82 Print version information and exit.
83 .SH BUGS
84 To report bugs, see
85 .UR http://www.gnu.org/software/libc/bugs.html
86 .UE
87 .SH EXAMPLES
88 See
89 .BR memusage (1).
90 .SH SEE ALSO
91 .BR memusage (1),
92 .BR mtrace (1)