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} 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{jar} and @command{grepjar}.
  78
  79 @menu
  80 * Invoking jar::        Options supported by @command{jar}
  81 * Invoking grepjar::    Options supported by @command{grepjar}
  82 * Copying::             The GNU General Public License
  83 @end menu
  84
  85 @node Invoking jar
  86 @chapter Invoking jar
  87
  88 @c man title jar archive tool for Java archives
  89
  90 @c man begin DESCRIPTION jar
  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 jar
 104 jar @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 jar
 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 jar
 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. This option is disabled due to bugs (currently
 129 fails with exit status 1 and does nothing).
 130
 131 @end table
 132
 133 The following parameters are optional:
 134
 135 @table @gcctabopt
 136
 137 @item -@@
 138 Read the names of the files to add to the archive from stdin.  This
 139 option is supported only in combination with @option{-c} or @option{-u}.
 140 Non standard option added in the GCC version.
 141
 142 @item -C @var{directory}
 143 Change to the @var{directory} and include the following file.
 144
 145 @item -E
 146 Prevent fastjar from reading the content of a directory when specifying
 147 one (and instead relying on the provided list of files to populate the
 148 archive with regard to the directory entry). Non standard option added
 149 in the GCC version.
 150
 151 @item -M
 152 Do not create a manifest file for the entries.
 153
 154 @item -0
 155 Store only; use no ZIP compression.
 156
 157 @item -V
 158 @itemx --version
 159 Display version information.
 160
 161 @item -f @var{archive}
 162 Specify archive file name.
 163
 164 @item -m @var{manifest}
 165 Include manifest information from specified @var{manifest} file.
 166
 167 @item -v
 168 Generate verbose output on standard output.
 169
 170 @end table
 171
 172 All remaining options are considered to be names of files.
 173
 174 @c man end
 175
 176 @node Invoking grepjar
 177 @chapter Invoking grepjar
 178
 179 @c man title grepjar search files in a jar file for a pattern
 180
 181 @c man begin DESCRIPTION grepjar
 182
 183 The @code{grepjar} program can be used to search files in a jar file for
 184 a pattern.
 185
 186 @c man end
 187
 188 @ignore
 189 @c man begin SYNOPSIS grepjar
 190 grepjar [@option{-bcinsw}] @option{-e} @var{PATTERN} | @var{PATTERN} @var{files}@dots{}
 191 @c man end
 192 @c man begin SEEALSO grepjar
 193 jar(1), gcj(1), gij(1), gfdl(7) and the Info entry for @file{gcj}.
 194 @c man end
 195 @end ignore
 196
 197 @c man begin OPTIONS grepjar
 198
 199 @table @gcctabopt
 200 @item -b
 201 Print byte offset of match.
 202
 203 @item -c
 204 Print number of matches.
 205
 206 @item -i
 207 Compare case-insensitively.
 208
 209 @item -n
 210 Print line number of each match.
 211
 212 @item -s
 213 Suppress error messages.
 214
 215 @item -w
 216 Force @var{PATTERN} to match only whole words.
 217
 218 @item -e @var{PATTERN}
 219 Use @var{PATTERN} as regular expression.
 220
 221 @item --help
 222 Print help, then exit.
 223
 224 @item -V
 225 @itemx --version
 226 Print version number, then exit.
 227 @end table
 228
 229 @c man end
 230
 231 @include gpl.texi
 232
 233 @bye