aboutsummaryrefslogtreecommitdiffstats
path: root/gcc-4.2.1/gcc/doc/gjnih.1
blob: 7a94a608a1a234a1103ebfcb95dc5ae97860b455 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  | will give a
.\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
.\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
.\" expand to `' in nroff, nothing in troff, for use with C<>.
.tr \(*W-|\(bv\*(Tr
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
'br\}
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.if \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.\"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.hy 0
.if n .na
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "GJNIH 1"
.TH GJNIH 1 "2007-07-19" "gcc-4.2.1" "GNU"
.SH "NAME"
gjnih \- generate JNI header files from Java class files
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
gjnih [\fB\-stubs\fR] [\fB\-jni\fR]
    [\fB\-force\fR] [\fB\-old\fR] [\fB\-trace\fR] [\fB\-J\fR \fIoption\fR]
    [\fB\-add\fR \fItext\fR] [\fB\-append\fR \fItext\fR] [\fB\-friend\fR \fItext\fR]
    [\fB\-preprend\fR \fItext\fR]
    [\fB\-\-classpath\fR=\fIpath\fR] [\fB\-\-CLASSPATH\fR=\fIpath\fR]
    [\fB\-\-bootclasspath\fR=\fIpath\fR]
    [\fB\-I\fR\fIdir\fR...] [\fB\-d\fR \fIdir\fR...]
    [\fB\-o\fR \fIfile\fR] [\fB\-td\fR \fIdir\fR]
    [\fB\-M\fR] [\fB\-MM\fR] [\fB\-MD\fR] [\fB\-MMD\fR]
    [\fB\-\-version\fR] [\fB\-\-help\fR] [\fB\-v\fR] [\fB\-\-verbose\fR]
    \fIclassname\fR...
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
The \f(CW\*(C`gjnih\*(C'\fR program is used to generate \s-1JNI\s0 header files from class
files.  Running it is equivalent to running \f(CW\*(C`gcjh \-jni\*(C'\fR.
.SH "OPTIONS"
.IX Header "OPTIONS"
.IP "\fB\-stubs\fR" 4
.IX Item "-stubs"
This causes \f(CW\*(C`gjnih\*(C'\fR to generate stub files instead of header files.
By default the stub file will be named after the class, with a suffix of
\&\fB.c\fR.
.IP "\fB\-jni\fR" 4
.IX Item "-jni"
This option specifies the default behavior which is to generate a \s-1JNI\s0
header or stub.
.IP "\fB\-force\fR" 4
.IX Item "-force"
This option forces \f(CW\*(C`gjnih\*(C'\fR to write the output file.
.IP "\fB\-old\fR" 4
.IX Item "-old"
This option is accepted but ignored for compatibility.
.IP "\fB\-trace\fR" 4
.IX Item "-trace"
This option is accepted but ignored for compatibility.
.IP "\fB\-J\fR \fIoption\fR" 4
.IX Item "-J option"
This option is accepted but ignored for compatibility.
.IP "\fB\-add\fR \fItext\fR" 4
.IX Item "-add text"
Inserts \fItext\fR into the class body.  This is ignored in by
\&\f(CW\*(C`gjnih\*(C'\fR.
.IP "\fB\-append\fR \fItext\fR" 4
.IX Item "-append text"
Inserts \fItext\fR into the header file after the class declaration.
This is ignored in by \f(CW\*(C`gjnih\*(C'\fR.
.IP "\fB\-friend\fR \fItext\fR" 4
.IX Item "-friend text"
Inserts \fItext\fR into the class as a \f(CW\*(C`friend\*(C'\fR declaration.
This is ignored by \f(CW\*(C`gjnih\*(C'\fR.
.IP "\fB\-prepend\fR \fItext\fR" 4
.IX Item "-prepend text"
Inserts \fItext\fR into the header file before the class declaration.
This is ignored in by \f(CW\*(C`gjnih\*(C'\fR.
.IP "\fB\-\-classpath=\fR\fIpath\fR" 4
.IX Item "--classpath=path"
.PD 0
.IP "\fB\-\-CLASSPATH=\fR\fIpath\fR" 4
.IX Item "--CLASSPATH=path"
.IP "\fB\-\-bootclasspath=\fR\fIpath\fR" 4
.IX Item "--bootclasspath=path"
.IP "\fB\-I\fR\fIdirectory\fR" 4
.IX Item "-Idirectory"
.IP "\fB\-d\fR \fIdirectory\fR" 4
.IX Item "-d directory"
.IP "\fB\-o\fR \fIfile\fR" 4
.IX Item "-o file"
.PD
These options are all identical to the corresponding \fBgcj\fR options.
.IP "\fB\-o\fR \fIfile\fR" 4
.IX Item "-o file"
Sets the output file name.  This cannot be used if there is more than
one class on the command line.
.IP "\fB\-td\fR \fIdirectory\fR" 4
.IX Item "-td directory"
Sets the name of the directory to use for temporary files.
.IP "\fB\-M\fR" 4
.IX Item "-M"
Print all dependencies to stdout; suppress ordinary output.
.IP "\fB\-MM\fR" 4
.IX Item "-MM"
Print non-system dependencies to stdout; suppress ordinary output.
.IP "\fB\-MD\fR" 4
.IX Item "-MD"
Print all dependencies to stdout.
.IP "\fB\-MMD\fR" 4
.IX Item "-MMD"
Print non-system dependencies to stdout.
.IP "\fB\-\-help\fR" 4
.IX Item "--help"
Print help about \f(CW\*(C`gjnih\*(C'\fR and exit.  No further processing is done.
.IP "\fB\-\-version\fR" 4
.IX Item "--version"
Print version information for \f(CW\*(C`gjnih\*(C'\fR and exit.  No further
processing is done.
.IP "\fB\-v, \-\-verbose\fR" 4
.IX Item "-v, --verbose"
Print extra information while running.
.PP
All remaining options are considered to be names of classes.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fIgcc\fR\|(1), \fIgcj\fR\|(1), \fIgcjh\fR\|(1), \fIgij\fR\|(1), \fIjv\-scan\fR\|(1), \fIjcf\-dump\fR\|(1), \fIgfdl\fR\|(7),
and the Info entries for \fIgcj\fR and \fIgcc\fR.
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright (c) 2001, 2002, 2003, 2004, 2005 Free Software Foundation, Inc.
.PP
Permission is granted to copy, distribute and/or modify this document
under the terms of the \s-1GNU\s0 Free Documentation License, Version 1.2 or
any later version published by the Free Software Foundation; with the
Invariant Sections being \*(L"\s-1GNU\s0 General Public License\*(R", the Front-Cover
texts being (a) (see below), and with the Back-Cover Texts being (b)
(see below).  A copy of the license is included in the
man page \fIgfdl\fR\|(7).
.PP
(a) The \s-1FSF\s0's Front-Cover Text is:
.PP
.Vb 1
\&     A GNU Manual
.Ve
.PP
(b) The \s-1FSF\s0's Back-Cover Text is:
.PP
.Vb 3
\&     You have freedom to copy and modify this GNU Manual, like GNU
\&     software.  Copies published by the Free Software Foundation raise
\&     funds for GNU development.
.Ve