contrib/gcc-4.0/gcc/doc/gcjh.1

   1 .\" Automatically generated by Pod::Man v1.34, Pod::Parser v1.13
   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.  | 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"
  58 ..
  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'
 101 .\}
 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 \
 117 \{\
 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
 127 .\}
 128 .rm #[ #] #H #V #F C
 129 .\" ========================================================================
 130 .\"
 131 .IX Title "GCJH 1"
 132 .TH GCJH 1 "2005-04-21" "gcc-4.0.0" "GNU"
 133 .SH "NAME"
 134 gcjh \- generate header files from Java class files
 135 .SH "SYNOPSIS"
 136 .IX Header "SYNOPSIS"
 137 gcjh [\fB\-stubs\fR] [\fB\-jni\fR]
 138     [\fB\-add\fR \fItext\fR] [\fB\-append\fR \fItext\fR] [\fB\-friend\fR \fItext\fR]
 139     [\fB\-preprend\fR \fItext\fR]
 140     [\fB\-\-classpath\fR=\fIpath\fR] [\fB\-\-CLASSPATH\fR=\fIpath\fR]
 141     [\fB\-I\fR\fIdir\fR...] [\fB\-d\fR \fIdir\fR...]
 142     [\fB\-o\fR \fIfile\fR] [\fB\-td\fR \fIdir\fR]
 143     [\fB\-M\fR] [\fB\-MM\fR] [\fB\-MD\fR] [\fB\-MMD\fR]
 144     [\fB\-\-version\fR] [\fB\-\-help\fR] [\fB\-v\fR] [\fB\-\-verbose\fR]
 145     \fIclassname\fR...
 146 .SH "DESCRIPTION"
 147 .IX Header "DESCRIPTION"
 148 The \f(CW\*(C`gcjh\*(C'\fR program is used to generate header files from class
 149 files.  It can generate both \s-1CNI\s0 and \s-1JNI\s0 header files, as well as stub
 150 implementation files which can be used as a basis for implementing the
 151 required native methods.
 152 .SH "OPTIONS"
 153 .IX Header "OPTIONS"
 154 .IP "\fB\-stubs\fR" 4
 155 .IX Item "-stubs"
 156 This causes \f(CW\*(C`gcjh\*(C'\fR to generate stub files instead of header files.
 157 By default the stub file will be named after the class, with a suffix of
 158 \&\fB.cc\fR.  In \s-1JNI\s0 mode, the default output file will have the suffix
 159 \&\fB.c\fR.
 160 .IP "\fB\-jni\fR" 4
 161 .IX Item "-jni"
 162 This tells \f(CW\*(C`gcjh\*(C'\fR to generate a \s-1JNI\s0 header or stub.  By default,
 163 \&\s-1CNI\s0 headers are generated.
 164 .IP "\fB\-add\fR \fItext\fR" 4
 165 .IX Item "-add text"
 166 Inserts \fItext\fR into the class body.  This is ignored in \s-1JNI\s0 mode.
 167 .IP "\fB\-append\fR \fItext\fR" 4
 168 .IX Item "-append text"
 169 Inserts \fItext\fR into the header file after the class declaration.
 170 This is ignored in \s-1JNI\s0 mode.
 171 .IP "\fB\-friend\fR \fItext\fR" 4
 172 .IX Item "-friend text"
 173 Inserts \fItext\fR into the class as a \f(CW\*(C`friend\*(C'\fR declaration.
 174 This is ignored in \s-1JNI\s0 mode.
 175 .IP "\fB\-prepend\fR \fItext\fR" 4
 176 .IX Item "-prepend text"
 177 Inserts \fItext\fR into the header file before the class declaration.
 178 This is ignored in \s-1JNI\s0 mode.
 179 .IP "\fB\-\-classpath=\fR\fIpath\fR" 4
 180 .IX Item "--classpath=path"
 181 .PD 0
 182 .IP "\fB\-\-CLASSPATH=\fR\fIpath\fR" 4
 183 .IX Item "--CLASSPATH=path"
 184 .IP "\fB\-I\fR\fIdirectory\fR" 4
 185 .IX Item "-Idirectory"
 186 .IP "\fB\-d\fR \fIdirectory\fR" 4
 187 .IX Item "-d directory"
 188 .IP "\fB\-o\fR \fIfile\fR" 4
 189 .IX Item "-o file"
 190 .PD
 191 These options are all identical to the corresponding \fBgcj\fR options.
 192 .IP "\fB\-o\fR \fIfile\fR" 4
 193 .IX Item "-o file"
 194 Sets the output file name.  This cannot be used if there is more than
 195 one class on the command line.
 196 .IP "\fB\-td\fR \fIdirectory\fR" 4
 197 .IX Item "-td directory"
 198 Sets the name of the directory to use for temporary files.
 199 .IP "\fB\-M\fR" 4
 200 .IX Item "-M"
 201 Print all dependencies to stdout; suppress ordinary output.
 202 .IP "\fB\-MM\fR" 4
 203 .IX Item "-MM"
 204 Print non-system dependencies to stdout; suppress ordinary output.
 205 .IP "\fB\-MD\fR" 4
 206 .IX Item "-MD"
 207 Print all dependencies to stdout.
 208 .IP "\fB\-MMD\fR" 4
 209 .IX Item "-MMD"
 210 Print non-system dependencies to stdout.
 211 .IP "\fB\-\-help\fR" 4
 212 .IX Item "--help"
 213 Print help about \f(CW\*(C`gcjh\*(C'\fR and exit.  No further processing is done.
 214 .IP "\fB\-\-version\fR" 4
 215 .IX Item "--version"
 216 Print version information for \f(CW\*(C`gcjh\*(C'\fR and exit.  No further
 217 processing is done.
 218 .IP "\fB\-v, \-\-verbose\fR" 4
 219 .IX Item "-v, --verbose"
 220 Print extra information while running.
 221 .PP
 222 All remaining options are considered to be names of classes.
 223 .SH "SEE ALSO"
 224 .IX Header "SEE ALSO"
 225 \&\fIgcc\fR\|(1), \fIgcj\fR\|(1), \fIgij\fR\|(1), \fIjv\-scan\fR\|(1), \fIjcf\-dump\fR\|(1), \fIgfdl\fR\|(7),
 226 and the Info entries for \fIgcj\fR and \fIgcc\fR.
 227 .SH "COPYRIGHT"
 228 .IX Header "COPYRIGHT"
 229 Copyright (c) 2001, 2002, 2003, 2004, 2005 Free Software Foundation, Inc.
 230 .PP
 231 Permission is granted to copy, distribute and/or modify this document
 232 under the terms of the \s-1GNU\s0 Free Documentation License, Version 1.2 or
 233 any later version published by the Free Software Foundation; with the
 234 Invariant Sections being ``\s-1GNU\s0 General Public License'', the Front-Cover
 235 texts being (a) (see below), and with the Back-Cover Texts being (b)
 236 (see below).  A copy of the license is included in the
 237 man page \fIgfdl\fR\|(7).
 238 .PP
 239 (a) The \s-1FSF\s0's Front-Cover Text is:
 240 .PP
 241 .Vb 1
 242 \&     A GNU Manual
 243 .Ve
 244 .PP
 245 (b) The \s-1FSF\s0's Back-Cover Text is:
 246 .PP
 247 .Vb 3
 248 \&     You have freedom to copy and modify this GNU Manual, like GNU
 249 \&     software.  Copies published by the Free Software Foundation raise
 250 \&     funds for GNU development.
 251 .Ve