Imported Upstream version 4.8.1
[platform/upstream/gcc48.git] / libjava / classpath / doc / gjavah.1
1 .\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16)
2 .\"
3 .\" Standard preamble:
4 .\" ========================================================================
5 .de Sp \" Vertical space (when we can't use .PP)
6 .if t .sp .5v
7 .if n .sp
8 ..
9 .de Vb \" Begin verbatim text
10 .ft CW
11 .nf
12 .ne \\$1
13 ..
14 .de Ve \" End verbatim text
15 .ft R
16 .fi
17 ..
18 .\" Set up some character translations and predefined strings.  \*(-- will
19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
20 .\" double quote, and \*(R" will give a right double quote.  \*(C+ will
21 .\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
22 .\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
23 .\" nothing in troff, for use with C<>.
24 .tr \(*W-
25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
26 .ie n \{\
27 .    ds -- \(*W-
28 .    ds PI pi
29 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
30 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
31 .    ds L" ""
32 .    ds R" ""
33 .    ds C` ""
34 .    ds C' ""
35 'br\}
36 .el\{\
37 .    ds -- \|\(em\|
38 .    ds PI \(*p
39 .    ds L" ``
40 .    ds R" ''
41 'br\}
42 .\"
43 .\" Escape single quotes in literal strings from groff's Unicode transform.
44 .ie \n(.g .ds Aq \(aq
45 .el       .ds Aq '
46 .\"
47 .\" If the F register is turned on, we'll generate index entries on stderr for
48 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
49 .\" entries marked with X<> in POD.  Of course, you'll have to process the
50 .\" output yourself in some meaningful fashion.
51 .ie \nF \{\
52 .    de IX
53 .    tm Index:\\$1\t\\n%\t"\\$2"
54 ..
55 .    nr % 0
56 .    rr F
57 .\}
58 .el \{\
59 .    de IX
60 ..
61 .\}
62 .\"
63 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
64 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
65 .    \" fudge factors for nroff and troff
66 .if n \{\
67 .    ds #H 0
68 .    ds #V .8m
69 .    ds #F .3m
70 .    ds #[ \f1
71 .    ds #] \fP
72 .\}
73 .if t \{\
74 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
75 .    ds #V .6m
76 .    ds #F 0
77 .    ds #[ \&
78 .    ds #] \&
79 .\}
80 .    \" simple accents for nroff and troff
81 .if n \{\
82 .    ds ' \&
83 .    ds ` \&
84 .    ds ^ \&
85 .    ds , \&
86 .    ds ~ ~
87 .    ds /
88 .\}
89 .if t \{\
90 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
91 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
92 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
93 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
94 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
95 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
96 .\}
97 .    \" troff and (daisy-wheel) nroff accents
98 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
99 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
100 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
101 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
102 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
103 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
104 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
105 .ds ae a\h'-(\w'a'u*4/10)'e
106 .ds Ae A\h'-(\w'A'u*4/10)'E
107 .    \" corrections for vroff
108 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
109 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
110 .    \" for low resolution devices (crt and lpr)
111 .if \n(.H>23 .if \n(.V>19 \
112 \{\
113 .    ds : e
114 .    ds 8 ss
115 .    ds o a
116 .    ds d- d\h'-1'\(ga
117 .    ds D- D\h'-1'\(hy
118 .    ds th \o'bp'
119 .    ds Th \o'LP'
120 .    ds ae ae
121 .    ds Ae AE
122 .\}
123 .rm #[ #] #H #V #F C
124 .\" ========================================================================
125 .\"
126 .IX Title "GJAVAH 1"
127 .TH GJAVAH 1 "2013-05-31" "0.99.1-pre" "GNU"
128 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
129 .\" way too many mistakes in technical documents.
130 .if n .ad l
131 .nh
132 .SH "NAME"
133 gjavah \- \- generate header files from Java class files
134 .SH "SYNOPSIS"
135 .IX Header "SYNOPSIS"
136 gjavah ...
137 .SH "DESCRIPTION"
138 .IX Header "DESCRIPTION"
139 The \fBgjavah\fR program is used to generate header files from class
140 files.  It can generate both \s-1CNI\s0 and \s-1JNI\s0 header files, as well as stub
141 implementation files which can be used as a basis for implementing the
142 required native methods.
143 .SH "OPTIONS"
144 .IX Header "OPTIONS"
145 .IP "\fB\-d\fR \fI\s-1DIR\s0\fR" 4
146 .IX Item "-d DIR"
147 Set output directory.
148 .IP "\fB\-o\fR \fI\s-1FILE\s0\fR" 4
149 .IX Item "-o FILE"
150 Set output file (only one of \fB\-d\fR or \fB\-o\fR may be used).
151 .IP "\fB\-cmdfile\fR \fI\s-1FILE\s0\fR" 4
152 .IX Item "-cmdfile FILE"
153 Read command file.
154 .IP "\fB\-all\fR \fI\s-1DIR\s0\fR" 4
155 .IX Item "-all DIR"
156 Operate on all class files under directory \fI\s-1DIR\s0\fR.
157 .IP "\fB\-stubs\fR" 4
158 .IX Item "-stubs"
159 Emit stub implementation.
160 .IP "\fB\-jni\fR" 4
161 .IX Item "-jni"
162 Emit \s-1JNI\s0 stubs or header (default).
163 .IP "\fB\-cni\fR" 4
164 .IX Item "-cni"
165 Emit \s-1CNI\s0 stubs or header (default \s-1JNI\s0).
166 .IP "\fB\-verbose\fR" 4
167 .IX Item "-verbose"
168 Set verbose mode.
169 .IP "\fB\-force\fR" 4
170 .IX Item "-force"
171 Output files should always be written.
172 .PP
173 Class path options:
174 .IP "\fB\-classpath\fR \fI\s-1PATH\s0\fR" 4
175 .IX Item "-classpath PATH"
176 Set the class path.
177 .IP "\fB\-I\fR\fI\s-1DIR\s0\fR" 4
178 .IX Item "-IDIR"
179 Add directory to class path.
180 .IP "\fB\-bootclasspath\fR \fI\s-1PATH\s0\fR" 4
181 .IX Item "-bootclasspath PATH"
182 Set the boot class path.
183 .IP "\fB\-extdirs\fR \fI\s-1PATH\s0\fR" 4
184 .IX Item "-extdirs PATH"
185 Set the extension directory path.
186 .PP
187 Standard options:
188 .IP "\fB\-help\fR" 4
189 .IX Item "-help"
190 Print help text, then exit.
191 .IP "\fB\-version\fR" 4
192 .IX Item "-version"
193 Print version number, then exit.
194 .IP "\fB\-J\fR\fI\s-1OPTION\s0\fR" 4
195 .IX Item "-JOPTION"
196 Pass argument to the Java runtime.
197 .SH "BUGS"
198 .IX Header "BUGS"
199 .SH "SEE ALSO"
200 .IX Header "SEE ALSO"
201 \&\fIjavac\fR\|(1), ...
202 .SH "AUTHOR"
203 .IX Header "AUTHOR"