Import stripped gcc-4.0.1 sources.
[dragonfly.git] / contrib / gcc-4.0 / gcc / doc / gij.1
blob9f2a7a7c39d129f2697787e4aa5a0c8c73e2de9a
1 .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14
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
13 .de Sp \" Vertical space (when we can't use .PP)
14 .if t .sp .5v
15 .if n .sp
17 .de Vb \" Begin verbatim text
18 .ft CW
19 .nf
20 .ne \\$1
22 .de Ve \" End verbatim text
23 .ft R
24 .fi
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.  | will give a
29 .\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
30 .\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
31 .\" expand to `' in nroff, nothing in troff, for use with C<>.
32 .tr \(*W-|\(bv\*(Tr
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 .\" If the F register is turned on, we'll generate index entries on stderr for
52 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
53 .\" entries marked with X<> in POD.  Of course, you'll have to process the
54 .\" output yourself in some meaningful fashion.
55 .if \nF \{\
56 .    de IX
57 .    tm Index:\\$1\t\\n%\t"\\$2"
59 .    nr % 0
60 .    rr F
61 .\}
62 .\"
63 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
64 .\" way too many mistakes in technical documents.
65 .hy 0
66 .if n .na
67 .\"
68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
69 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
70 .    \" fudge factors for nroff and troff
71 .if n \{\
72 .    ds #H 0
73 .    ds #V .8m
74 .    ds #F .3m
75 .    ds #[ \f1
76 .    ds #] \fP
77 .\}
78 .if t \{\
79 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
80 .    ds #V .6m
81 .    ds #F 0
82 .    ds #[ \&
83 .    ds #] \&
84 .\}
85 .    \" simple accents for nroff and troff
86 .if n \{\
87 .    ds ' \&
88 .    ds ` \&
89 .    ds ^ \&
90 .    ds , \&
91 .    ds ~ ~
92 .    ds /
93 .\}
94 .if t \{\
95 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
96 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
97 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
98 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
99 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
100 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
102 .    \" troff and (daisy-wheel) nroff accents
103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
110 .ds ae a\h'-(\w'a'u*4/10)'e
111 .ds Ae A\h'-(\w'A'u*4/10)'E
112 .    \" corrections for vroff
113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
115 .    \" for low resolution devices (crt and lpr)
116 .if \n(.H>23 .if \n(.V>19 \
118 .    ds : e
119 .    ds 8 ss
120 .    ds o a
121 .    ds d- d\h'-1'\(ga
122 .    ds D- D\h'-1'\(hy
123 .    ds th \o'bp'
124 .    ds Th \o'LP'
125 .    ds ae ae
126 .    ds Ae AE
128 .rm #[ #] #H #V #F C
129 .\" ========================================================================
131 .IX Title "GIJ 1"
132 .TH GIJ 1 "2005-07-07" "gcc-4.0.1" "GNU"
133 .SH "NAME"
134 gij \- GNU interpreter for Java bytecode
135 .SH "SYNOPSIS"
136 .IX Header "SYNOPSIS"
137 gij [\fB\s-1OPTION\s0\fR] ... \fI\s-1JARFILE\s0\fR [\fI\s-1ARGS\s0\fR...]
139 gij [\fB\-jar\fR] [\fB\s-1OPTION\s0\fR] ... \fI\s-1CLASS\s0\fR [\fI\s-1ARGS\s0\fR...]
140   [\fB\-cp\fR \fIpath\fR] [\fB\-classpath\fR \fIpath\fR]
141   [\fB\-D\fR\fIname\fR[=\fIvalue\fR]...]
142   [\fB\-ms=\fR\fInumber\fR] [\fB\-mx=\fR\fInumber\fR]
143   [\fB\-X\fR\fIargument\fR] [\fB\-verbose\fR] [\fB\-verbose:class\fR]
144   [\fB\-\-showversion\fR] [\fB\-\-version\fR] [\fB\-\-help\fR][\fB\-?\fR]
145 .SH "DESCRIPTION"
146 .IX Header "DESCRIPTION"
147 \&\f(CW\*(C`gij\*(C'\fR is a Java bytecode interpreter included with \f(CW\*(C`libgcj\*(C'\fR.
148 \&\f(CW\*(C`gij\*(C'\fR is not available on every platform; porting it requires a
149 small amount of assembly programming which has not been done for all the
150 targets supported by \fBgcj\fR.
152 The primary argument to \f(CW\*(C`gij\*(C'\fR is the name of a class or, with
153 \&\f(CW\*(C`\-jar\*(C'\fR, a jar file.  Options before this argument are interpreted
154 by \f(CW\*(C`gij\*(C'\fR; remaining options are passed to the interpreted program.
156 If a class name is specified and this class does not have a \f(CW\*(C`main\*(C'\fR
157 method with the appropriate signature (a \f(CW\*(C`static void\*(C'\fR method with
158 a \f(CW\*(C`String[]\*(C'\fR as its sole argument), then \f(CW\*(C`gij\*(C'\fR will print an
159 error and exit.
161 If a jar file is specified then \f(CW\*(C`gij\*(C'\fR will use information in it to
162 determine which class' \f(CW\*(C`main\*(C'\fR method will be invoked.
164 \&\f(CW\*(C`gij\*(C'\fR will invoke the \f(CW\*(C`main\*(C'\fR method with all the remaining
165 command-line options.
167 Note that \f(CW\*(C`gij\*(C'\fR is not limited to interpreting code.  Because
168 \&\f(CW\*(C`libgcj\*(C'\fR includes a class loader which can dynamically load shared
169 objects, it is possible to give \f(CW\*(C`gij\*(C'\fR the name of a class which has
170 been compiled and put into a shared library on the class path.
171 .SH "OPTIONS"
172 .IX Header "OPTIONS"
173 .IP "\fB\-cp\fR \fIpath\fR" 4
174 .IX Item "-cp path"
175 .PD 0
176 .IP "\fB\-classpath\fR \fIpath\fR" 4
177 .IX Item "-classpath path"
179 Set the initial class path.  The class path is used for finding
180 class and resource files.  If specified, this option overrides the
181 \&\f(CW\*(C`CLASSPATH\*(C'\fR environment variable.  Note that this option is
182 ignored if \f(CW\*(C`\-jar\*(C'\fR is used.
183 .IP "\fB\-D\fR\fIname\fR\fB[=\fR\fIvalue\fR\fB]\fR" 4
184 .IX Item "-Dname[=value]"
185 This defines a system property named \fIname\fR with value \fIvalue\fR.
186 If \fIvalue\fR is not specified then it defaults to the empty string.
187 These system properties are initialized at the program's startup and can
188 be retrieved at runtime using the \f(CW\*(C`java.lang.System.getProperty\*(C'\fR
189 method.
190 .IP "\fB\-ms=\fR\fInumber\fR" 4
191 .IX Item "-ms=number"
192 Equivalent to \f(CW\*(C`\-Xms\*(C'\fR.
193 .IP "\fB\-mx=\fR\fInumber\fR" 4
194 .IX Item "-mx=number"
195 Equivalent to \f(CW\*(C`\-Xmx\*(C'\fR.
196 .IP "\fB\-noverify\fR" 4
197 .IX Item "-noverify"
198 Do not verify compliance of bytecode with the \s-1VM\s0 specification. In addition,
199 this option disables type verification which is otherwise performed on BC-ABI
200 compiled code.
201 .IP "\fB\-X\fR" 4
202 .IX Item "-X"
203 .PD 0
204 .IP "\fB\-X\fR\fIargument\fR" 4
205 .IX Item "-Xargument"
207 Supplying \f(CW\*(C`\-X\*(C'\fR by itself will cause \f(CW\*(C`gij\*(C'\fR to list all the
208 supported \f(CW\*(C`\-X\*(C'\fR options.  Currently these options are supported:
209 .RS 4
210 .IP "\fB\-Xms\fR\fIsize\fR" 4
211 .IX Item "-Xmssize"
212 Set the initial heap size.
213 .IP "\fB\-Xmx\fR\fIsize\fR" 4
214 .IX Item "-Xmxsize"
215 Set the maximum heap size.
217 .RS 4
219 Unrecognized \f(CW\*(C`\-X\*(C'\fR options are ignored, for compatibility with
220 other runtimes.
222 .IP "\fB\-jar\fR" 4
223 .IX Item "-jar"
224 This indicates that the name passed to \f(CW\*(C`gij\*(C'\fR should be interpreted
225 as the name of a jar file, not a class.
226 .IP "\fB\-\-help\fR" 4
227 .IX Item "--help"
228 .PD 0
229 .IP "\fB\-?\fR" 4
230 .IX Item "-?"
232 Print help, then exit.
233 .IP "\fB\-\-showversion\fR" 4
234 .IX Item "--showversion"
235 Print version number and continue.
236 .IP "\fB\-\-fullversion\fR" 4
237 .IX Item "--fullversion"
238 Print detailed version information, then exit.
239 .IP "\fB\-\-version\fR" 4
240 .IX Item "--version"
241 Print version number, then exit.
242 .IP "\fB\-verbose\fR" 4
243 .IX Item "-verbose"
244 .PD 0
245 .IP "\fB\-verbose:class\fR" 4
246 .IX Item "-verbose:class"
248 Each time a class is initialized, print a short message on standard error.
250 \&\f(CW\*(C`gij\*(C'\fR also recognizes and ignores the following options, for
251 compatibility with existing application launch scripts:
252 \&\f(CW\*(C`\-client\*(C'\fR, \f(CW\*(C`\-server\*(C'\fR, \f(CW\*(C`\-hotspot\*(C'\fR, \f(CW\*(C`\-jrockit\*(C'\fR,
253 \&\f(CW\*(C`\-agentlib\*(C'\fR, \f(CW\*(C`\-agentpath\*(C'\fR, \f(CW\*(C`\-debug\*(C'\fR, \f(CW\*(C`\-d32\*(C'\fR,
254 \&\f(CW\*(C`\-d64\*(C'\fR, \f(CW\*(C`\-javaagent\*(C'\fR, \f(CW\*(C`\-noclassgc\*(C'\fR, \f(CW\*(C`\-verify\*(C'\fR,
255 and \f(CW\*(C`\-verifyremote\*(C'\fR.
256 .SH "SEE ALSO"
257 .IX Header "SEE ALSO"
258 \&\fIgcc\fR\|(1), \fIgcj\fR\|(1), \fIgcjh\fR\|(1), \fIjv\-scan\fR\|(1), \fIjcf\-dump\fR\|(1), \fIgfdl\fR\|(7),
259 and the Info entries for \fIgcj\fR and \fIgcc\fR.
260 \&\fIgcc\fR\|(1), \fIgcj\fR\|(1), \fIgcjh\fR\|(1), \fIjv\-scan\fR\|(1), \fIjcf\-dump\fR\|(1), \fIgfdl\fR\|(7),
261 and the Info entries for \fIgcj\fR and \fIgcc\fR.
262 .SH "COPYRIGHT"
263 .IX Header "COPYRIGHT"
264 Copyright (c) 2001, 2002, 2003, 2004, 2005 Free Software Foundation, Inc.
266 Permission is granted to copy, distribute and/or modify this document
267 under the terms of the \s-1GNU\s0 Free Documentation License, Version 1.2 or
268 any later version published by the Free Software Foundation; with the
269 Invariant Sections being ``\s-1GNU\s0 General Public License'', the Front-Cover
270 texts being (a) (see below), and with the Back-Cover Texts being (b)
271 (see below).  A copy of the license is included in the
272 man page \fIgfdl\fR\|(7).
274 (a) The \s-1FSF\s0's Front-Cover Text is:
276 .Vb 1
277 \&     A GNU Manual
280 (b) The \s-1FSF\s0's Back-Cover Text is:
282 .Vb 3
283 \&     You have freedom to copy and modify this GNU Manual, like GNU
284 \&     software.  Copies published by the Free Software Foundation raise
285 \&     funds for GNU development.