comparison gcc/doc/gc-analyze.1 @ 0:a06113de4d67

first commit
author kent <kent@cr.ie.u-ryukyu.ac.jp>
date Fri, 17 Jul 2009 14:47:48 +0900
parents
children 58ad6c70ea60
comparison
equal deleted inserted replaced
-1:000000000000 0:a06113de4d67
1 .\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.07)
2 .\"
3 .\" Standard preamble:
4 .\" ========================================================================
5 .de Sh \" Subsection heading
6 .br
7 .if t .Sp
8 .ne 5
9 .PP
10 \fB\\$1\fR
11 .PP
12 ..
13 .de Sp \" Vertical space (when we can't use .PP)
14 .if t .sp .5v
15 .if n .sp
16 ..
17 .de Vb \" Begin verbatim text
18 .ft CW
19 .nf
20 .ne \\$1
21 ..
22 .de Ve \" End verbatim text
23 .ft R
24 .fi
25 ..
26 .\" Set up some character translations and predefined strings. \*(-- will
27 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
28 .\" double quote, and \*(R" will give a right double quote. \*(C+ will
29 .\" give a nicer C++. Capital omega is used to do unbreakable dashes and
30 .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
31 .\" nothing in troff, for use with C<>.
32 .tr \(*W-
33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
34 .ie n \{\
35 . ds -- \(*W-
36 . ds PI pi
37 . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
38 . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
39 . ds L" ""
40 . ds R" ""
41 . ds C` ""
42 . ds C' ""
43 'br\}
44 .el\{\
45 . ds -- \|\(em\|
46 . ds PI \(*p
47 . ds L" ``
48 . ds R" ''
49 'br\}
50 .\"
51 .\" Escape single quotes in literal strings from groff's Unicode transform.
52 .ie \n(.g .ds Aq \(aq
53 .el .ds Aq '
54 .\"
55 .\" If the F register is turned on, we'll generate index entries on stderr for
56 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
57 .\" entries marked with X<> in POD. Of course, you'll have to process the
58 .\" output yourself in some meaningful fashion.
59 .ie \nF \{\
60 . de IX
61 . tm Index:\\$1\t\\n%\t"\\$2"
62 ..
63 . nr % 0
64 . rr F
65 .\}
66 .el \{\
67 . de IX
68 ..
69 .\}
70 .\"
71 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
72 .\" Fear. Run. Save yourself. No user-serviceable parts.
73 . \" fudge factors for nroff and troff
74 .if n \{\
75 . ds #H 0
76 . ds #V .8m
77 . ds #F .3m
78 . ds #[ \f1
79 . ds #] \fP
80 .\}
81 .if t \{\
82 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
83 . ds #V .6m
84 . ds #F 0
85 . ds #[ \&
86 . ds #] \&
87 .\}
88 . \" simple accents for nroff and troff
89 .if n \{\
90 . ds ' \&
91 . ds ` \&
92 . ds ^ \&
93 . ds , \&
94 . ds ~ ~
95 . ds /
96 .\}
97 .if t \{\
98 . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
99 . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
100 . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
101 . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
102 . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
103 . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
104 .\}
105 . \" troff and (daisy-wheel) nroff accents
106 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
107 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
108 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
109 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
110 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
111 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
112 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
113 .ds ae a\h'-(\w'a'u*4/10)'e
114 .ds Ae A\h'-(\w'A'u*4/10)'E
115 . \" corrections for vroff
116 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
117 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
118 . \" for low resolution devices (crt and lpr)
119 .if \n(.H>23 .if \n(.V>19 \
120 \{\
121 . ds : e
122 . ds 8 ss
123 . ds o a
124 . ds d- d\h'-1'\(ga
125 . ds D- D\h'-1'\(hy
126 . ds th \o'bp'
127 . ds Th \o'LP'
128 . ds ae ae
129 . ds Ae AE
130 .\}
131 .rm #[ #] #H #V #F C
132 .\" ========================================================================
133 .\"
134 .IX Title "GC-ANALYZE 1"
135 .TH GC-ANALYZE 1 "2009-04-21" "gcc-4.4.0" "GNU"
136 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
137 .\" way too many mistakes in technical documents.
138 .if n .ad l
139 .nh
140 .SH "NAME"
141 gc\-analyze \- Analyze Garbage Collector (GC) memory dumps
142 .SH "SYNOPSIS"
143 .IX Header "SYNOPSIS"
144 \&\fBgc-analyze\fR [\fB\s-1OPTION\s0\fR] ... [\fIfile\fR]
145 .SH "DESCRIPTION"
146 .IX Header "DESCRIPTION"
147 \&\fBgc-analyze\fR prints an analysis of a \s-1GC\s0 memory dump to
148 standard out.
149 .PP
150 The memory dumps may be created by calling
151 \&\f(CW\*(C`gnu.gcj.util.GCInfo.enumerate(String namePrefix)\*(C'\fR from java
152 code. A memory dump will be created on an out of memory condition if
153 \&\f(CW\*(C`gnu.gcj.util.GCInfo.setOOMDump(String namePrefix)\*(C'\fR is called
154 before the out of memory occurs.
155 .PP
156 Running this program will create two files: \fITestDump001\fR and
157 \&\fITestDump001.bytes\fR.
158 .PP
159 .Vb 2
160 \& import gnu.gcj.util.*;
161 \& import java.util.*;
162 \&
163 \& public class GCDumpTest
164 \& {
165 \& static public void main(String args[])
166 \& {
167 \& ArrayList<String> l = new ArrayList<String>(1000);
168 \&
169 \& for (int i = 1; i < 1500; i++) {
170 \& l.add("This is string #" + i);
171 \& }
172 \& GCInfo.enumerate("TestDump");
173 \& }
174 \& }
175 .Ve
176 .PP
177 The memory dump may then be displayed by running:
178 .PP
179 .Vb 1
180 \& gc\-analyze \-v TestDump001
181 .Ve
182 .SH "OPTIONS"
183 .IX Header "OPTIONS"
184 .IP "\fB\-\-verbose\fR" 4
185 .IX Item "--verbose"
186 .PD 0
187 .IP "\fB\-v\fR" 4
188 .IX Item "-v"
189 .PD
190 Verbose output.
191 .IP "\fB\-p\fR \fItool-prefix\fR" 4
192 .IX Item "-p tool-prefix"
193 Prefix added to the names of the \fBnm\fR and \fBreadelf\fR commands.
194 .IP "\fB\-d\fR \fIdirectory\fR" 4
195 .IX Item "-d directory"
196 Directory that contains the executable and shared libraries used when
197 the dump was generated.
198 .IP "\fB\-\-help\fR" 4
199 .IX Item "--help"
200 Print a help message, then exit.
201 .IP "\fB\-\-version\fR" 4
202 .IX Item "--version"
203 Print version information, then exit.
204 .SH "SEE ALSO"
205 .IX Header "SEE ALSO"
206 .SH "COPYRIGHT"
207 .IX Header "COPYRIGHT"
208 Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
209 .PP
210 Permission is granted to copy, distribute and/or modify this document
211 under the terms of the \s-1GNU\s0 Free Documentation License, Version 1.2 or
212 any later version published by the Free Software Foundation; with no
213 Invariant Sections, the Front-Cover Texts being (a) (see below), and
214 with the Back-Cover Texts being (b) (see below).
215 A copy of the license is included in the
216 man page \fIgfdl\fR\|(7).
217 .PP
218 (a) The \s-1FSF\s0's Front-Cover Text is:
219 .PP
220 .Vb 1
221 \& A GNU Manual
222 .Ve
223 .PP
224 (b) The \s-1FSF\s0's Back-Cover Text is:
225 .PP
226 .Vb 3
227 \& You have freedom to copy and modify this GNU Manual, like GNU
228 \& software. Copies published by the Free Software Foundation raise
229 \& funds for GNU development.
230 .Ve