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