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 * jar: (fastjar)Invoking jar.
  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} Free Software Foundation, Inc.
  36
  37 Permission is granted to copy, distribute and/or modify this document
  38 under the terms of the GNU Free Documentation License, Version 1.2 or
  39 any later version published by the Free Software Foundation; with the
  40 Invariant Sections being ``GNU General Public License'', the Front-Cover
  41 texts being (a) (see below), and with the Back-Cover Texts being (b)
  42 (see below).  A copy of the license is included in the
  43 @c man end
  44 section entitled
  45 ``GNU Free Documentation License''.
  46 @ignore
  47 @c man begin COPYRIGHT
  48 man page gfdl(7).
  49 @c man end
  50 @end ignore
  51
  52 @c man begin COPYRIGHT
  53
  54 (a) The FSF's Front-Cover Text is:
  55
  56      A GNU Manual
  57
  58 (b) The FSF's Back-Cover Text is:
  59
  60      You have freedom to copy and modify this GNU Manual, like GNU
  61      software.  Copies published by the Free Software Foundation raise
  62      funds for GNU development.
  63 @c man end
  64 @end ifinfo
  65
  66 @titlepage
  67 @title GNU jar utilites
  68 @author Brian Burns
  69
  70 @page
  71 @vskip 0pt plus 1filll
  72 Copyright @copyright{} @value{copyrights-gcj} Free Software Foundation, Inc.
  73 @sp 2
  74 For the @value{which-gcj} Version*
  75 @sp 1
  76 Published by the Free Software Foundation @*
  77 59 Temple Place - Suite 330@*
  78 Boston, MA 02111-1307, USA@*
  79 @sp 1
  80 Permission is granted to copy, distribute and/or modify this document
  81 under the terms of the GNU Free Documentation License, Version 1.2 or
  82 any later version published by the Free Software Foundation; with the
  83 Invariant Sections being ``GNU General Public License'', the Front-Cover
  84 texts being (a) (see below), and with the Back-Cover Texts being (b)
  85 (see below).  A copy of the license is included in the section entitled
  86 ``GNU Free Documentation License''.
  87
  88 (a) The FSF's Front-Cover Text is:
  89
  90      A GNU Manual
  91
  92 (b) The FSF's Back-Cover Text is:
  93
  94      You have freedom to copy and modify this GNU Manual, like GNU
  95      software.  Copies published by the Free Software Foundation raise
  96      funds for GNU development.
  97 @end titlepage
  98 @contents
  99 @page
 100
 101
 102 @node Top
 103 @top Introduction
 104
 105 This manual describes how to use @command{jar} and @command{grepjar}.
 106
 107 @menu
 108 * Invoking jar::        Options supported by @command{jar}
 109 * Invoking grepjar::    Options supported by @command{grepjar}
 110 * Copying::             The GNU General Public License
 111 * GNU Free Documentation License::
 112                         How you can share and copy this manual
 113 @end menu
 114
 115 @node Invoking jar
 116 @chapter Invoking jar
 117
 118 @c man title jar archive tool for Java archives
 119
 120 @c man begin DESCRIPTION jar
 121
 122 @code{fastjar} is an implementation of Sun's jar utility that comes with
 123 the JDK, written entirely in C, and runs in a fraction of the time while
 124 being feature compatible.
 125
 126 If any file is a directory then it is processed recursively.  The
 127 manifest file name and the archive file name needs to be specified in
 128 the same order the @option{-m} and @option{-f} flags are specified.
 129
 130 @c man end
 131
 132 @ignore
 133 @c man begin SYNOPSIS jar
 134 jar @option{-ctxu} [@option{OPTIONS}] [@var{jar-file}] [@var{manifest-file}] [@option{-C} @var{dir}] @var{files}@dots{}
 135 @c man end
 136 @c man begin SEEALSO jar
 137 gcj(1), gij(1), grepjar(1)
 138 and the Info entry for @file{gcj}.
 139 @c man end
 140 @end ignore
 141
 142 @c man begin OPTIONS jar
 143
 144 Exactly one of the following actions must be specified:
 145
 146 @table @gcctabopt
 147
 148 @item -c
 149 Create new archive.
 150
 151 @item -t
 152 List table of contents for archive.
 153
 154 @item -x
 155 Extract named (or all) files from archive.
 156
 157 @item -u
 158 Update existing archive. This option is disabled due to bugs (currently
 159 fails with exit status 1 and does nothing).
 160
 161 @end table
 162
 163 The following parameters are optional:
 164
 165 @table @gcctabopt
 166
 167 @item -@@
 168 Read the names of the files to add to the archive from stdin.  This
 169 option is supported only in combination with @option{-c} or @option{-u}.
 170 Non standard option added in the GCC version.
 171
 172 @item -C @var{directory}
 173 Change to the @var{directory} and include the following file.
 174
 175 @item -E
 176 Prevent fastjar from reading the content of a directory when specifying
 177 one (and instead relying on the provided list of files to populate the
 178 archive with regard to the directory entry). Non standard option added
 179 in the GCC version.
 180
 181 @item -M
 182 Do not create a manifest file for the entries.
 183
 184 @item -0
 185 Store only; use no ZIP compression.
 186
 187 @item -V
 188 @itemx --version
 189 Display version information.
 190
 191 @item -f @var{archive}
 192 Specify archive file name.
 193
 194 @item -m @var{manifest}
 195 Include manifest information from specified @var{manifest} file.
 196
 197 @item -v
 198 Generate verbose output on standard output.
 199
 200 @end table
 201
 202 All remaining options are considered to be names of files.
 203
 204 @c man end
 205
 206 @node Invoking grepjar
 207 @chapter Invoking grepjar
 208
 209 @c man title grepjar search files in a jar file for a pattern
 210
 211 @c man begin DESCRIPTION grepjar
 212
 213 The @code{grepjar} program can be used to search files in a jar file for
 214 a pattern.
 215
 216 @c man end
 217
 218 @ignore
 219 @c man begin SYNOPSIS grepjar
 220 grepjar [@option{-bcinsw}] @option{-e} @var{PATTERN} | @var{PATTERN} @var{files}@dots{}
 221 @c man end
 222 @c man begin SEEALSO grepjar
 223 jar(1), gcj(1), gij(1), gfdl(7) and the Info entry for @file{gcj}.
 224 @c man end
 225 @end ignore
 226
 227 @c man begin OPTIONS grepjar
 228
 229 @table @gcctabopt
 230 @item -b
 231 Print byte offset of match.
 232
 233 @item -c
 234 Print number of matches.
 235
 236 @item -i
 237 Compare case-insensitively.
 238
 239 @item -n
 240 Print line number of each match.
 241
 242 @item -s
 243 Suppress error messages.
 244
 245 @item -w
 246 Force @var{PATTERN} to match only whole words.
 247
 248 @item -e @var{PATTERN}
 249 Use @var{PATTERN} as regular expression.
 250
 251 @item --help
 252 Print help, then exit.
 253
 254 @item -V
 255 @itemx --version
 256 Print version number, then exit.
 257 @end table
 258
 259 @c man end
 260
 261 @include gpl.texi
 262
 263 @include fdl.texi
 264
 265 @bye