remove unused files
[platform/upstream/gcc48.git] / gcc / doc / gcj-dbtool.1
1 .\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.20)
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 .    ds C`
42 .    ds C'
43 'br\}
44 .\"
45 .\" Escape single quotes in literal strings from groff's Unicode transform.
46 .ie \n(.g .ds Aq \(aq
47 .el       .ds Aq '
48 .\"
49 .\" If the F register is turned on, we'll generate index entries on stderr for
50 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
51 .\" entries marked with X<> in POD.  Of course, you'll have to process the
52 .\" output yourself in some meaningful fashion.
53 .\"
54 .\" Avoid warning from groff about undefined register 'F'.
55 .de IX
56 ..
57 .nr rF 0
58 .if \n(.g .if rF .nr rF 1
59 .if (\n(rF:(\n(.g==0)) \{
60 .    if \nF \{
61 .        de IX
62 .        tm Index:\\$1\t\\n%\t"\\$2"
63 ..
64 .        if !\nF==2 \{
65 .            nr % 0
66 .            nr F 2
67 .        \}
68 .    \}
69 .\}
70 .rr rF
71 .\"
72 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
73 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
74 .    \" fudge factors for nroff and troff
75 .if n \{\
76 .    ds #H 0
77 .    ds #V .8m
78 .    ds #F .3m
79 .    ds #[ \f1
80 .    ds #] \fP
81 .\}
82 .if t \{\
83 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
84 .    ds #V .6m
85 .    ds #F 0
86 .    ds #[ \&
87 .    ds #] \&
88 .\}
89 .    \" simple accents for nroff and troff
90 .if n \{\
91 .    ds ' \&
92 .    ds ` \&
93 .    ds ^ \&
94 .    ds , \&
95 .    ds ~ ~
96 .    ds /
97 .\}
98 .if t \{\
99 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
100 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
101 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
102 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
103 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
104 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
105 .\}
106 .    \" troff and (daisy-wheel) nroff accents
107 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
108 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
109 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
110 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
111 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
112 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
113 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
114 .ds ae a\h'-(\w'a'u*4/10)'e
115 .ds Ae A\h'-(\w'A'u*4/10)'E
116 .    \" corrections for vroff
117 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
118 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
119 .    \" for low resolution devices (crt and lpr)
120 .if \n(.H>23 .if \n(.V>19 \
121 \{\
122 .    ds : e
123 .    ds 8 ss
124 .    ds o a
125 .    ds d- d\h'-1'\(ga
126 .    ds D- D\h'-1'\(hy
127 .    ds th \o'bp'
128 .    ds Th \o'LP'
129 .    ds ae ae
130 .    ds Ae AE
131 .\}
132 .rm #[ #] #H #V #F C
133 .\" ========================================================================
134 .\"
135 .IX Title "GCJ-DBTOOL 1"
136 .TH GCJ-DBTOOL 1 "2013-10-16" "gcc-4.8.2" "GNU"
137 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
138 .\" way too many mistakes in technical documents.
139 .if n .ad l
140 .nh
141 .SH "NAME"
142 gcj\-dbtool \- Manipulate class file mapping databases for libgcj
143 .SH "SYNOPSIS"
144 .IX Header "SYNOPSIS"
145 gcj-dbtool \fB\s-1OPTION\s0\fR \fI\s-1DBFILE\s0\fR [\fB\s-1MORE\s0\fR] ...
146 .PP
147 gcj-dbtool [\fB\-0\fR] [\fB\-\fR] [\fB\-n\fR] [\fB\-a\fR] [\fB\-f\fR]
148   [\fB\-t\fR] [\fB\-l\fR] [\fB\-p\fR [\fI\s-1LIBDIR\s0\fR]]
149   [\fB\-v\fR] [\fB\-m\fR] [\fB\-\-version\fR] [\fB\-\-help\fR]
150 .SH "DESCRIPTION"
151 .IX Header "DESCRIPTION"
152 \&\f(CW\*(C`gcj\-dbtool\*(C'\fR is a tool for creating and manipulating class file
153 mapping databases.  \f(CW\*(C`libgcj\*(C'\fR can use these databases to find a
154 shared library corresponding to the bytecode representation of a
155 class.  This functionality is useful for ahead-of-time compilation of
156 a program that has no knowledge of \f(CW\*(C`gcj\*(C'\fR.
157 .PP
158 \&\f(CW\*(C`gcj\-dbtool\*(C'\fR works best if all the jar files added to it are
159 compiled using \f(CW\*(C`\-findirect\-dispatch\*(C'\fR.
160 .PP
161 Note that \f(CW\*(C`gcj\-dbtool\*(C'\fR is currently available as \*(L"preview
162 technology\*(R".  We believe it is a reasonable way to allow
163 application-transparent ahead-of-time compilation, but this is an
164 unexplored area.  We welcome your comments.
165 .SH "OPTIONS"
166 .IX Header "OPTIONS"
167 .IP "\fB\-n\fR \fI\s-1DBFILE\s0\fR \fB[\fR\fI\s-1SIZE\s0\fR\fB]\fR" 4
168 .IX Item "-n DBFILE [SIZE]"
169 This creates a new database.  Currently, databases cannot be resized;
170 you can choose a larger initial size if desired.  The default size is
171 32,749.
172 .IP "\fB\-a\fR \fI\s-1DBFILE\s0\fR\fB \fR\fI\s-1JARFILE\s0\fR\fB \fR\fI\s-1LIB\s0\fR" 4
173 .IX Item "-a DBFILE JARFILE LIB"
174 .PD 0
175 .IP "\fB\-f\fR \fI\s-1DBFILE\s0\fR\fB \fR\fI\s-1JARFILE\s0\fR\fB \fR\fI\s-1LIB\s0\fR" 4
176 .IX Item "-f DBFILE JARFILE LIB"
177 .PD
178 This adds a jar file to the database.  For each class file in the jar,
179 a cryptographic signature of the bytecode representation of the class
180 is recorded in the database.  At runtime, a class is looked up by its
181 signature and the compiled form of the class is looked for in the
182 corresponding shared library.  The \fB\-a\fR option will verify
183 that \fI\s-1LIB\s0\fR exists before adding it to the database; \fB\-f\fR
184 skips this check.
185 .IP "\fB[\fR\fB\-\fR\fB][\fR\fB\-0\fR\fB] \-m\fR \fI\s-1DBFILE\s0\fR\fB \fR\fI\s-1DBFILE\s0\fR\fB,[\fR\fI\s-1DBFILE\s0\fR\fB]\fR" 4
186 .IX Item "[-][-0] -m DBFILE DBFILE,[DBFILE]"
187 Merge a number of databases.  The output database overwrites any
188 existing database.  To add databases into an existing database,
189 include the destination in the list of sources.
190 .Sp
191 If \fB\-\fR or \fB\-0\fR are used, the list of files to read is
192 taken from standard input instead of the command line.  For
193 \&\fB\-0\fR, Input filenames are terminated by a null character
194 instead of by whitespace.  Useful when arguments might contain white
195 space.  The \s-1GNU\s0 find \-print0 option produces input suitable for this
196 mode.
197 .IP "\fB\-t\fR \fI\s-1DBFILE\s0\fR" 4
198 .IX Item "-t DBFILE"
199 Test a database.
200 .IP "\fB\-l\fR \fI\s-1DBFILE\s0\fR" 4
201 .IX Item "-l DBFILE"
202 List the contents of a database.
203 .IP "\fB\-p\fR" 4
204 .IX Item "-p"
205 Print the name of the default database.  If there is no default
206 database, this prints a blank line.  If \fI\s-1LIBDIR\s0\fR is specified, use
207 it instead of the default library directory component of the database
208 name.
209 .IP "\fB\-\-help\fR" 4
210 .IX Item "--help"
211 Print a help message, then exit.
212 .IP "\fB\-\-version\fR" 4
213 .IX Item "--version"
214 .PD 0
215 .IP "\fB\-v\fR" 4
216 .IX Item "-v"
217 .PD
218 Print version information, then exit.
219 .SH "SEE ALSO"
220 .IX Header "SEE ALSO"
221 \&\fIgcc\fR\|(1), \fIgcj\fR\|(1), \fIgcjh\fR\|(1), \fIjcf\-dump\fR\|(1), \fIgfdl\fR\|(7),
222 and the Info entries for \fIgcj\fR and \fIgcc\fR.
223 .SH "COPYRIGHT"
224 .IX Header "COPYRIGHT"
225 Copyright (c) 2001\-2013 Free Software Foundation, Inc.
226 .PP
227 Permission is granted to copy, distribute and/or modify this document
228 under the terms of the \s-1GNU\s0 Free Documentation License, Version 1.3 or
229 any later version published by the Free Software Foundation; with no
230 Invariant Sections, the Front-Cover Texts being (a) (see below), and
231 with the Back-Cover Texts being (b) (see below).
232 A copy of the license is included in the
233 man page \fIgfdl\fR\|(7).
234 .PP
235 (a) The \s-1FSF\s0's Front-Cover Text is:
236 .PP
237 .Vb 1
238 \&     A GNU Manual
239 .Ve
240 .PP
241 (b) The \s-1FSF\s0's Back-Cover Text is:
242 .PP
243 .Vb 3
244 \&     You have freedom to copy and modify this GNU Manual, like GNU
245 \&     software.  Copies published by the Free Software Foundation raise
246 \&     funds for GNU development.
247 .Ve