OSDN Git Service

2004-07-23 Thomas Fitzsimmons <fitzsim@redhat.com>
[pf3gnuchains/gcc-fork.git] / fastjar / fastjar.texi
1 \input texinfo @c -*-texinfo-*-
2 @setfilename fastjar.info
3 @settitle Guide to GNU jar utilites
4
5 @c Note: When reading this manual you'll find lots of strange
6 @c circumlocutions like ``compiler for the Java language''.
7 @c This is necessary due to Sun's restrictions on the use of
8 @c the word ``Java'.
9
10 @c When this manual is copyrighted.
11 @set copyrights-fastjar 2002
12
13 @include gcc-common.texi
14
15 @c Versions
16 @set which-gcj GCC-@value{version-GCC}
17
18 @ifinfo
19 @format
20 @dircategory Programming
21 @direntry
22 * fastjar: (fastjar).       GNU jar utilities
23 @end direntry
24
25 @dircategory Individual utilities
26 @direntry
27 * fastjar: (fastjar)Invoking fastjar.
28                             An archive tool for Java archives
29 * grepjar: (fastjar)Invoking grepjar.
30                             Search files in a jar file for a pattern
31 @end direntry
32 @end format
33
34 @c man begin COPYRIGHT
35 Copyright (C) @value{copyrights-fastjar} Matthias Klose
36
37 Permission is granted to copy, distribute and/or modify this document
38 under the terms of the GNU General Public License as published by the
39 Free Software Foundation; either version 2, or (at your option) any
40 later version. A copy of the license is included in the
41 @c man end
42 section entitled ``GNU General Public License''.
43 @ignore
44 @c man begin COPYRIGHT
45 man page gpl(7).
46 @c man end
47 @end ignore
48 @end ifinfo
49
50 @titlepage
51 @title GNU jar utilites
52 @author Brian Burns
53
54 @page
55 @vskip 0pt plus 1filll
56 Copyright @copyright{} @value{copyrights-gcj} Matthias Klose
57 @sp 2
58 For the @value{which-gcj} Version*
59 @sp 1
60 Published by the Free Software Foundation @*
61 59 Temple Place - Suite 330@*
62 Boston, MA 02111-1307, USA@*
63 @sp 1
64 Permission is granted to copy, distribute and/or modify this document
65 under the terms of the GNU General Public License as published by the
66 Free Software Foundation; either version 2, or (at your option) any
67 later version. A copy of the license is included in the
68 section entitled ``GNU General Public License''.
69 @end titlepage
70 @contents
71 @page
72
73
74 @node Top
75 @top Introduction
76
77 This manual describes how to use @command{fastjar} and @command{grepjar}.
78
79 @menu
80 * Invoking fastjar::    Options supported by @command{fastjar}
81 * Invoking grepjar::    Options supported by @command{grepjar}
82 * Copying::             The GNU General Public License
83 @end menu
84
85 @node Invoking fastjar
86 @chapter Invoking fastjar
87
88 @c man title fastjar archive tool for Java archives
89
90 @c man begin DESCRIPTION fastjar
91
92 @code{fastjar} is an implementation of Sun's jar utility that comes with
93 the JDK, written entirely in C, and runs in a fraction of the time while
94 being feature compatible.
95
96 If any file is a directory then it is processed recursively.  The
97 manifest file name and the archive file name needs to be specified in
98 the same order the @option{-m} and @option{-f} flags are specified.
99
100 @c man end
101
102 @ignore
103 @c man begin SYNOPSIS fastjar
104 fastjar @option{-ctxu} [@option{OPTIONS}] [@var{jar-file}] [@var{manifest-file}] [@option{-C} @var{dir}] @var{files}@dots{}
105 @c man end
106 @c man begin SEEALSO fastjar
107 gcj(1), gij(1), grepjar(1)
108 and the Info entry for @file{gcj}.
109 @c man end
110 @end ignore
111
112 @c man begin OPTIONS fastjar
113
114 Exactly one of the following actions must be specified:
115
116 @table @gcctabopt
117
118 @item -c
119 Create new archive.
120
121 @item -t
122 List table of contents for archive.
123
124 @item -x
125 Extract named (or all) files from archive.
126
127 @item -u
128 Update existing archive.
129
130 @end table
131
132 The following parameters are optional:
133
134 @table @gcctabopt
135
136 @item -@@
137 Read the names of the files to add to the archive from stdin.  This
138 option is supported only in combination with @option{-c} or @option{-u}.
139 Non standard option added in the GCC version.
140
141 @item -C @var{directory}
142 Change to the @var{directory} and include the following file.
143
144 @item -E
145 Prevent fastjar from reading the content of a directory when specifying
146 one (and instead relying on the provided list of files to populate the
147 archive with regard to the directory entry). Non standard option added
148 in the GCC version.
149
150 @item -M
151 Do not create a manifest file for the entries.
152
153 @item -0
154 Store only; use no ZIP compression.
155
156 @item -V
157 @itemx --version
158 Display version information.
159
160 @item -f @var{archive}
161 Specify archive file name.
162
163 @item -m @var{manifest}
164 Include manifest information from specified @var{manifest} file.
165
166 @item -v
167 Generate verbose output on standard output.
168
169 @end table
170
171 All remaining options are considered to be names of files.
172
173 @c man end
174
175 @node Invoking grepjar
176 @chapter Invoking grepjar
177
178 @c man title grepjar search files in a jar file for a pattern
179
180 @c man begin DESCRIPTION grepjar
181
182 The @code{grepjar} program can be used to search files in a jar file for
183 a pattern.
184
185 @c man end
186
187 @ignore
188 @c man begin SYNOPSIS grepjar
189 grepjar [@option{-bcinsw}] @option{-e} @var{PATTERN} | @var{PATTERN} @var{files}@dots{}
190 @c man end
191 @c man begin SEEALSO grepjar
192 fastjar(1), gcj(1), gij(1), gfdl(7) and the Info entry for @file{gcj}.
193 @c man end
194 @end ignore
195
196 @c man begin OPTIONS grepjar
197
198 @table @gcctabopt
199 @item -b
200 Print byte offset of match.
201
202 @item -c
203 Print number of matches.
204
205 @item -i
206 Compare case-insensitively.
207
208 @item -n
209 Print line number of each match.
210
211 @item -s
212 Suppress error messages.
213
214 @item -w
215 Force @var{PATTERN} to match only whole words.
216
217 @item -e @var{PATTERN}
218 Use @var{PATTERN} as regular expression.
219
220 @item --help
221 Print help, then exit.
222
223 @item -V
224 @itemx --version
225 Print version number, then exit.
226 @end table
227
228 @c man end
229
230 @include gpl.texi
231
232 @bye