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 51 Franklin Street, Fifth Floor@*
  62 Boston, MA 02110-1301, 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 -i
 154 Generate an index of the packages in this jar and its Class-Path
 155 (currently a no-op for jar command-line compatibility).
 156
 157 @item -0
 158 Store only; use no ZIP compression.
 159
 160 @item -V
 161 @itemx --version
 162 Display version information.
 163
 164 @item -f @var{archive}
 165 Specify archive file name.
 166
 167 @item -m @var{manifest}
 168 Include manifest information from specified @var{manifest} file.
 169
 170 @item -v
 171 Generate verbose output on standard output.
 172
 173 @end table
 174
 175 All remaining options are considered to be names of files.
 176
 177 @c man end
 178
 179 @node Invoking grepjar
 180 @chapter Invoking grepjar
 181
 182 @c man title grepjar search files in a jar file for a pattern
 183
 184 @c man begin DESCRIPTION grepjar
 185
 186 The @code{grepjar} program can be used to search files in a jar file for
 187 a pattern.
 188
 189 @c man end
 190
 191 @ignore
 192 @c man begin SYNOPSIS grepjar
 193 grepjar [@option{-bcinsw}] @option{-e} @var{PATTERN} | @var{PATTERN} @var{files}@dots{}
 194 @c man end
 195 @c man begin SEEALSO grepjar
 196 fastjar(1), gcj(1), gij(1), gfdl(7) and the Info entry for @file{gcj}.
 197 @c man end
 198 @end ignore
 199
 200 @c man begin OPTIONS grepjar
 201
 202 @table @gcctabopt
 203 @item -b
 204 Print byte offset of match.
 205
 206 @item -c
 207 Print number of matches.
 208
 209 @item -i
 210 Compare case-insensitively.
 211
 212 @item -n
 213 Print line number of each match.
 214
 215 @item -s
 216 Suppress error messages.
 217
 218 @item -w
 219 Force @var{PATTERN} to match only whole words.
 220
 221 @item -e @var{PATTERN}
 222 Use @var{PATTERN} as regular expression.
 223
 224 @item --help
 225 Print help, then exit.
 226
 227 @item -V
 228 @itemx --version
 229 Print version number, then exit.
 230 @end table
 231
 232 @c man end
 233
 234 @include gpl.texi
 235
 236 @bye