| blob | 955df0365e9d93033ed5e61d18e12ef10b764c31 |
1 '\" t
2 .\" Copyright (c) 2004, 2013, Oracle and/or its affiliates. All rights reserved.
3 .\" Arch: generic
4 .\" Software: JDK 8
5 .\" Date: 21 November 2013
6 .\" SectDesc: Java Deployment Tools
7 .\" Title: pack200.1
8 .\"
9 .if n .pl 99999
10 .TH pack200 1 "21 November 2013" "JDK 8" "Java Deployment Tools"
11 .\" -----------------------------------------------------------------
12 .\" * Define some portability stuff
13 .\" -----------------------------------------------------------------
14 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
15 .\" http://bugs.debian.org/507673
16 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
17 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
18 .ie \n(.g .ds Aq \(aq
19 .el .ds Aq '
20 .\" -----------------------------------------------------------------
21 .\" * set default formatting
22 .\" -----------------------------------------------------------------
23 .\" disable hyphenation
24 .nh
25 .\" disable justification (adjust text to left margin only)
26 .ad l
27 .\" -----------------------------------------------------------------
28 .\" * MAIN CONTENT STARTS HERE *
29 .\" -----------------------------------------------------------------
31 .SH NAME
32 pack200 \- Packages a JAR file into a compressed pack200 file for web deployment\&.
33 .SH SYNOPSIS
34 .sp
35 .nf
37 \fBpack200\fR [\fIoptions\fR] \fIoutput\-file\fR \fIJAR\-file\fR
38 .fi
39 .sp
40 Options can be in any order\&. The last option on the command line or in a properties file supersedes all previously specified options\&.
41 .TP
42 \fIoptions\fR
43 The command-line options\&. See Options\&.
44 .TP
45 \fIoutput-file\fR
46 Name of the output file\&.
47 .TP
48 \fIJAR-file\fR
49 Name of the input file\&.
50 .SH DESCRIPTION
51 The \f3pack200\fR command is a Java application that transforms a JAR file into a compressed pack200 file with the Java gzip compressor\&. The pack200 files are highly compressed files that can be directly deployed to save bandwidth and reduce download time\&.
52 .PP
53 The \f3pack200\fR command has several options to fine-tune and set the compression engine\&. The typical usage is shown in the following example, where \f3myarchive\&.pack\&.gz\fR is produced with the default \f3pack200\fR command settings:
54 .sp
55 .nf
56 \f3pack200 myarchive\&.pack\&.gz myarchive\&.jar\fP
57 .fi
58 .nf
59 \f3\fP
60 .fi
61 .sp
62 .SH OPTIONS
63 .TP
64 -r, --repack
65 .br
66 Produces a JAR file by packing and unpacking a JAR file\&. The resulting file can be used as an input to the \f3jarsigner\fR(1) tool\&. The following example packs and unpacks the myarchive\&.jar file:
67 .sp
68 .nf
69 \f3pack200 \-\-repack myarchive\-packer\&.jar myarchive\&.jar\fP
70 .fi
71 .nf
72 \f3pack200 \-\-repack myarchive\&.jar\fP
73 .fi
74 .nf
75 \f3\fP
76 .fi
77 .sp
80 The following example preserves the order of files in the input file\&.
81 .TP
82 -g, --no-gzip
83 .br
84 Produces a \f3pack200\fR file\&. With this option, a suitable compressor must be used, and the target system must use a corresponding decompresser\&.
85 .sp
86 .nf
87 \f3pack200 \-\-no\-gzip myarchive\&.pack myarchive\&.jar\fP
88 .fi
89 .nf
90 \f3\fP
91 .fi
92 .sp
94 .TP
95 -G, --strip-debug
96 .br
97 Strips debugging attributes from the output\&. These include \f3SourceFile\fR, \f3LineNumberTable\fR, \f3LocalVariableTable\fR and \f3LocalVariableTypeTable\fR\&. Removing these attributes reduces the size of both downloads and installations, but reduces the usefulness of debuggers\&.
98 .TP
99 --keep-file-order
100 .br
101 Preserve the order of files in the input file\&. This is the default behavior\&.
102 .TP
103 -O, --no-keep-file-order
104 .br
105 The packer reorders and transmits all elements\&. The packer can also remove JAR directory names to reduce the download size\&. However, certain JAR file optimizations, such as indexing, might not work correctly\&.
106 .TP
107 -S\fIvalue\fR , --segment-limit=\fIvalue\fR
108 .br
109 The value is the estimated target size \fIN\fR (in bytes) of each archive segment\&. If a single input file requires more than \fIN\fR bytes, then its own archive segment is provided\&. As a special case, a value of \f3-1\fR produces a single large segment with all input files, while a value of 0 produces one segment for each class\&. Larger archive segments result in less fragmentation and better compression, but processing them requires more memory\&.
111 The size of each segment is estimated by counting the size of each input file to be transmitted in the segment with the size of its name and other transmitted properties\&.
113 The default is -1, which means that the packer creates a single segment output file\&. In cases where extremely large output files are generated, users are strongly encouraged to use segmenting or break up the input file into smaller JARs\&.
115 A 10 MB JAR packed without this limit typically packs about 10 percent smaller, but the packer might require a larger Java heap (about 10 times the segment limit)\&.
116 .TP
117 -E\fIvalue\fR , --effort=\fIvalue\fR
118 .br
119 If the value is set to a single decimal digit, then the packer uses the indicated amount of effort in compressing the archive\&. Level 1 might produce somewhat larger size and faster compression speed, while level 9 takes much longer, but can produce better compression\&. The special value 0 instructs the \f3pack200\fR command to copy through the original JAR file directly with no compression\&. The JSR 200 standard requires any unpacker to understand this special case as a pass-through of the entire archive\&.
121 The default is 5, to invest a modest amount of time to produce reasonable compression\&.
122 .TP
123 -H\fIvalue\fR , --deflate-hint=\fIvalue\fR
124 .br
125 Overrides the default, which preserves the input information, but can cause the transmitted archive to be larger\&. The possible values are: \f3true\fR, \f3false\fR, or \f3keep\fR\&.
127 If the \f3value\fR is \f3true\fR or false, then the \f3packer200\fR command sets the deflation hint accordingly in the output archive and does not transmit the individual deflation hints of archive elements\&.
129 The \f3keep\fR value preserves deflation hints observed in the input JAR\&. This is the default\&.
130 .TP
131 -m\fIvalue\fR , --modification-time=\fIvalue\fR
132 .br
133 The possible values are \f3latest\fR and \f3keep\fR\&.
135 If the value is latest, then the packer attempts to determine the latest modification time, among all the available entries in the original archive, or the latest modification time of all the available entries in that segment\&. This single value is transmitted as part of the segment and applied to all the entries in each segment\&. This can marginally decrease the transmitted size of the archive at the expense of setting all installed files to a single date\&.
137 If the value is \f3keep\fR, then modification times observed in the input JAR are preserved\&. This is the default\&.
138 .TP
139 -P\fIfile\fR , --pass-file=\fIfile\fR
140 .br
141 Indicates that a file should be passed through bytewise with no compression\&. By repeating the option, multiple files can be specified\&. There is no pathname transformation, except that the system file separator is replaced by the JAR file separator forward slash (/)\&. The resulting file names must match exactly as strings with their occurrences in the JAR file\&. If \f3file\fR is a directory name, then all files under that directory are passed\&.
142 .TP
143 -U\fIaction\fR , --unknown-attribute=\fIaction\fR
144 .br
145 Overrides the default behavior, which means that the class file that contains the unknown attribute is passed through with the specified \f3action\fR\&. The possible values for actions are \f3error\fR, \f3strip\fR, or \f3pass\fR\&.
147 If the value is \f3error\fR, then the entire \f3pack200\fR command operation fails with a suitable explanation\&.
149 If the value is \f3strip\fR, then the attribute is dropped\&. Removing the required Java Virtual Machine (JVM) attributes can cause class loader failures\&.
151 If the value is \f3pass\fR, then the entire class is transmitted as though it is a resource\&.
152 .TP
153 .nf
154 -C\fIattribute-name\fR=\fIlayout\fR , --class-attribute=\fIattribute-name\fR=\fIaction\fR
155 .br
156 .fi
157 See next option\&.
158 .TP
159 .nf
160 -F\fIattribute-name\fR=\fIlayout\fR , --field-attribute=\fIattribute-name\fR=\fIaction\fR
161 .br
162 .fi
163 See next option\&.
164 .TP
165 .nf
166 -M\fIattribute-name\fR=\fIlayout\fR , --method-attribute=\fIattribute-name\fR=\fIaction\fR
167 .br
168 .fi
169 See next option\&.
170 .TP
171 .nf
172 -D\fIattribute-name\fR=\fIlayout\fR , --code-attribute=\fIattribute-name\fR=\fIaction\fR
173 .br
174 .fi
175 With the previous four options, the attribute layout can be specified for a class entity, such as \f3class-attribute\fR, \f3field-attribute\fR, \f3method-attribute\fR, and \f3code-attribute\fR\&. The \fIattribute-name\fR is the name of the attribute for which the layout or action is being defined\&. The possible values for \fIaction\fR are \f3some-layout-string\fR, \f3error\fR, \f3strip\fR, \f3pass\fR\&.
177 \f3some-layout-string\fR: The layout language is defined in the JSR 200 specification, for example: \f3--class-attribute=SourceFile=RUH\fR\&.
179 If the value is \f3error\fR, then the \f3pack200\fR operation fails with an explanation\&.
181 If the value is \f3strip\fR, then the attribute is removed from the output\&. Removing JVM-required attributes can cause class loader failures\&. For example, \f3--class-attribute=CompilationID=pass\fR causes the class file that contains this attribute to be passed through without further action by the packer\&.
183 If the value is \f3pass\fR, then the entire class is transmitted as though it is a resource\&.
184 .TP
185 -f \fIpack\&.properties\fR , --config-file=\fIpack\&.properties\fR
186 .br
187 A configuration file, containing Java properties to initialize the packer, can be specified on the command line\&.
188 .sp
189 .nf
190 \f3pack200 \-f pack\&.properties myarchive\&.pack\&.gz myarchive\&.jar\fP
191 .fi
192 .nf
193 \f3more pack\&.properties\fP
194 .fi
195 .nf
196 \f3# Generic properties for the packer\&.\fP
197 .fi
198 .nf
199 \f3modification\&.time=latest\fP
200 .fi
201 .nf
202 \f3deflate\&.hint=false\fP
203 .fi
204 .nf
205 \f3keep\&.file\&.order=false\fP
206 .fi
207 .nf
208 \f3# This option will cause the files bearing new attributes to\fP
209 .fi
210 .nf
211 \f3# be reported as an error rather than passed uncompressed\&.\fP
212 .fi
213 .nf
214 \f3unknown\&.attribute=error\fP
215 .fi
216 .nf
217 \f3# Change the segment limit to be unlimited\&.\fP
218 .fi
219 .nf
220 \f3segment\&.limit=\-1\fP
221 .fi
222 .nf
223 \f3\fP
224 .fi
225 .sp
227 .TP
228 -v, --verbose
229 .br
230 Outputs minimal messages\&. Multiple specification of this option will create more verbose messages\&.
231 .TP
232 -q, --quiet
233 .br
234 Specifies quiet operation with no messages\&.
235 .TP
236 -l\fIfilename\fR , --log-file=\fIfilename\fR
237 .br
238 Specifies a log file to output messages\&.
239 .TP
240 -?, -h, --help
241 .br
242 Prints help information about this command\&.
243 .TP
244 -V, --version
245 .br
246 Prints version information about this command\&.
247 .TP
248 -J\fIoption\fR
249 .br
250 Passes the specified option to the Java Virtual Machine\&. For more information, see the reference page for the java(1) command\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&.
251 .SH EXIT\ STATUS
252 The following exit values are returned: 0 for successful completion and a number greater than 0 when an error occurs\&.
253 .SH NOTES
254 This command should not be confused with \f3pack\fR(1)\&. The \f3pack\fR and \f3pack200\fR commands are separate products\&.
255 .PP
256 The Java SE API Specification provided with the JDK is the superseding authority, when there are discrepancies\&.
257 .SH SEE\ ALSO
258 .TP 0.2i
259 \(bu
260 unpack200(1)
261 .TP 0.2i
262 \(bu
263 jar(1)
264 .TP 0.2i
265 \(bu
266 jarsigner(1)
267 .RE
268 .br
269 'pl 8.5i
270 'bp