Imported Upstream version 4.8.1
[platform/upstream/gcc48.git] / gcc / doc / gcj-dbtool.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 "GCJ-DBTOOL 1"
127 .TH GCJ-DBTOOL 1 "2013-05-31" "gcc-4.8.1" "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 gcj\-dbtool \- Manipulate class file mapping databases for libgcj
134 .SH "SYNOPSIS"
135 .IX Header "SYNOPSIS"
136 gcj-dbtool \fB\s-1OPTION\s0\fR \fI\s-1DBFILE\s0\fR [\fB\s-1MORE\s0\fR] ...
137 .PP
138 gcj-dbtool [\fB\-0\fR] [\fB\-\fR] [\fB\-n\fR] [\fB\-a\fR] [\fB\-f\fR]
139   [\fB\-t\fR] [\fB\-l\fR] [\fB\-p\fR [\fI\s-1LIBDIR\s0\fR]]
140   [\fB\-v\fR] [\fB\-m\fR] [\fB\-\-version\fR] [\fB\-\-help\fR]
141 .SH "DESCRIPTION"
142 .IX Header "DESCRIPTION"
143 \&\f(CW\*(C`gcj\-dbtool\*(C'\fR is a tool for creating and manipulating class file
144 mapping databases.  \f(CW\*(C`libgcj\*(C'\fR can use these databases to find a
145 shared library corresponding to the bytecode representation of a
146 class.  This functionality is useful for ahead-of-time compilation of
147 a program that has no knowledge of \f(CW\*(C`gcj\*(C'\fR.
148 .PP
149 \&\f(CW\*(C`gcj\-dbtool\*(C'\fR works best if all the jar files added to it are
150 compiled using \f(CW\*(C`\-findirect\-dispatch\*(C'\fR.
151 .PP
152 Note that \f(CW\*(C`gcj\-dbtool\*(C'\fR is currently available as \*(L"preview
153 technology\*(R".  We believe it is a reasonable way to allow
154 application-transparent ahead-of-time compilation, but this is an
155 unexplored area.  We welcome your comments.
156 .SH "OPTIONS"
157 .IX Header "OPTIONS"
158 .IP "\fB\-n\fR \fI\s-1DBFILE\s0\fR \fB[\fR\fI\s-1SIZE\s0\fR\fB]\fR" 4
159 .IX Item "-n DBFILE [SIZE]"
160 This creates a new database.  Currently, databases cannot be resized;
161 you can choose a larger initial size if desired.  The default size is
162 32,749.
163 .IP "\fB\-a\fR \fI\s-1DBFILE\s0\fR\fB \fR\fI\s-1JARFILE\s0\fR\fB \fR\fI\s-1LIB\s0\fR" 4
164 .IX Item "-a DBFILE JARFILE LIB"
165 .PD 0
166 .IP "\fB\-f\fR \fI\s-1DBFILE\s0\fR\fB \fR\fI\s-1JARFILE\s0\fR\fB \fR\fI\s-1LIB\s0\fR" 4
167 .IX Item "-f DBFILE JARFILE LIB"
168 .PD
169 This adds a jar file to the database.  For each class file in the jar,
170 a cryptographic signature of the bytecode representation of the class
171 is recorded in the database.  At runtime, a class is looked up by its
172 signature and the compiled form of the class is looked for in the
173 corresponding shared library.  The \fB\-a\fR option will verify
174 that \fI\s-1LIB\s0\fR exists before adding it to the database; \fB\-f\fR
175 skips this check.
176 .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
177 .IX Item "[-][-0] -m DBFILE DBFILE,[DBFILE]"
178 Merge a number of databases.  The output database overwrites any
179 existing database.  To add databases into an existing database,
180 include the destination in the list of sources.
181 .Sp
182 If \fB\-\fR or \fB\-0\fR are used, the list of files to read is
183 taken from standard input instead of the command line.  For
184 \&\fB\-0\fR, Input filenames are terminated by a null character
185 instead of by whitespace.  Useful when arguments might contain white
186 space.  The \s-1GNU\s0 find \-print0 option produces input suitable for this
187 mode.
188 .IP "\fB\-t\fR \fI\s-1DBFILE\s0\fR" 4
189 .IX Item "-t DBFILE"
190 Test a database.
191 .IP "\fB\-l\fR \fI\s-1DBFILE\s0\fR" 4
192 .IX Item "-l DBFILE"
193 List the contents of a database.
194 .IP "\fB\-p\fR" 4
195 .IX Item "-p"
196 Print the name of the default database.  If there is no default
197 database, this prints a blank line.  If \fI\s-1LIBDIR\s0\fR is specified, use
198 it instead of the default library directory component of the database
199 name.
200 .IP "\fB\-\-help\fR" 4
201 .IX Item "--help"
202 Print a help message, then exit.
203 .IP "\fB\-\-version\fR" 4
204 .IX Item "--version"
205 .PD 0
206 .IP "\fB\-v\fR" 4
207 .IX Item "-v"
208 .PD
209 Print version information, then exit.
210 .SH "SEE ALSO"
211 .IX Header "SEE ALSO"
212 \&\fIgcc\fR\|(1), \fIgcj\fR\|(1), \fIgcjh\fR\|(1), \fIjcf\-dump\fR\|(1), \fIgfdl\fR\|(7),
213 and the Info entries for \fIgcj\fR and \fIgcc\fR.
214 .SH "COPYRIGHT"
215 .IX Header "COPYRIGHT"
216 Copyright (c) 2001\-2013 Free Software Foundation, Inc.
217 .PP
218 Permission is granted to copy, distribute and/or modify this document
219 under the terms of the \s-1GNU\s0 Free Documentation License, Version 1.3 or
220 any later version published by the Free Software Foundation; with no
221 Invariant Sections, the Front-Cover Texts being (a) (see below), and
222 with the Back-Cover Texts being (b) (see below).
223 A copy of the license is included in the
224 man page \fIgfdl\fR\|(7).
225 .PP
226 (a) The \s-1FSF\s0's Front-Cover Text is:
227 .PP
228 .Vb 1
229 \&     A GNU Manual
230 .Ve
231 .PP
232 (b) The \s-1FSF\s0's Back-Cover Text is:
233 .PP
234 .Vb 3
235 \&     You have freedom to copy and modify this GNU Manual, like GNU
236 \&     software.  Copies published by the Free Software Foundation raise
237 \&     funds for GNU development.
238 .Ve