src/jdk.pack/share/man/unpack200.1
changeset 55140 d4890c3721be
parent 52714 2e52aa822c57
equal deleted inserted replaced
55139:3ea18959a349 55140:d4890c3721be
     1 '\" t
     1 .\" Copyright (c) 1994, 2019, Oracle and/or its affiliates. All rights reserved.
     2 .\" Copyright (c) 2004, 2013, Oracle and/or its affiliates. All rights reserved.
       
     3 .\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
     2 .\" DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
     4 .\"
     3 .\"
     5 .\" This code is free software; you can redistribute it and/or modify it
     4 .\" This code is free software; you can redistribute it and/or modify it
     6 .\" under the terms of the GNU General Public License version 2 only, as
     5 .\" under the terms of the GNU General Public License version 2 only, as
     7 .\" published by the Free Software Foundation.
     6 .\" published by the Free Software Foundation.
    18 .\"
    17 .\"
    19 .\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
    18 .\" Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
    20 .\" or visit www.oracle.com if you need additional information or have any
    19 .\" or visit www.oracle.com if you need additional information or have any
    21 .\" questions.
    20 .\" questions.
    22 .\"
    21 .\"
    23 .\"     Arch: generic
    22 .\" Automatically generated by Pandoc 2.3.1
    24 .\"     Software: JDK 8
       
    25 .\"     Date: 21 November 2013
       
    26 .\"     SectDesc: Java Deployment Tools
       
    27 .\"     Title: unpack200.1
       
    28 .\"
    23 .\"
    29 .if n .pl 99999
    24 .TH "UNPACK200" "1" "2018" "JDK 13" "JDK Commands"
    30 .TH unpack200 1 "21 November 2013" "JDK 8" "Java Deployment Tools"
    25 .hy
    31 .\" -----------------------------------------------------------------
    26 .SH NAME
    32 .\" * Define some portability stuff
    27 .PP
    33 .\" -----------------------------------------------------------------
    28 unpack200 \- transform a packed file into a JAR file for web deployment
    34 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    29 .SH SYNOPSIS
    35 .\" http://bugs.debian.org/507673
    30 .PP
    36 .\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
    31 \f[CB]unpack200\f[R] [\f[I]options\f[R]] \f[I]input\-file\f[R]
    37 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
    32 \f[I]JAR\-file\f[R]
    38 .ie \n(.g .ds Aq \(aq
       
    39 .el       .ds Aq '
       
    40 .\" -----------------------------------------------------------------
       
    41 .\" * set default formatting
       
    42 .\" -----------------------------------------------------------------
       
    43 .\" disable hyphenation
       
    44 .nh
       
    45 .\" disable justification (adjust text to left margin only)
       
    46 .ad l
       
    47 .\" -----------------------------------------------------------------
       
    48 .\" * MAIN CONTENT STARTS HERE *
       
    49 .\" -----------------------------------------------------------------
       
    50 
       
    51 .SH NAME    
       
    52 unpack200 \- Transforms a packed file produced by pack200(1) into a JAR file for web deployment\&.
       
    53 .SH SYNOPSIS    
       
    54 .sp     
       
    55 .nf     
       
    56 
       
    57 \fBunpack200\fR [ \fIoptions\fR ] input\-file \fIJAR\-file\fR
       
    58 .fi     
       
    59 .sp     
       
    60 .TP     
       
    61 \fIoptions\fR
       
    62 The command-line options\&. See Options\&.
       
    63 .TP     
       
    64 \fIinput-file\fR
       
    65 Name of the input file, which can be a pack200 gzip file or a pack200 file\&. The input can also be JAR file produced by \f3pack200\fR(1) with an effort of \f30\fR, in which case the contents of the input file are copied to the output JAR file with the Pack200 marker\&.
       
    66 .TP     
       
    67 \fIJAR-file\fR
       
    68 Name of the output JAR file\&.
       
    69 .SH DESCRIPTION    
       
    70 The \f3unpack200\fR command is a native implementation that transforms a packed file produced by \f3pack200\fR\f3(1)\fR into a JAR file\&. A typical usage follows\&. In the following example, the \f3myarchive\&.jar\fR file is produced from \f3myarchive\&.pack\&.gz\fR with the default \f3unpack200\fR command settings\&.
       
    71 .sp     
       
    72 .nf     
       
    73 \f3unpack200 myarchive\&.pack\&.gz myarchive\&.jar\fP
       
    74 .fi     
       
    75 .nf     
       
    76 \f3\fP
       
    77 .fi     
       
    78 .sp     
       
    79 .SH OPTIONS    
       
    80 .TP
    33 .TP
    81 -Hvalue --deflate-hint=\fIvalue\fR
    34 .B \f[I]options\f[R]
    82 .br
    35 The command\-line options.
    83 Sets the deflation to be \f3true\fR, \f3false\fR, or \f3keep\fR on all entries within a JAR file\&. The default mode is \f3keep\fR\&. If the value is \f3true\fR or \f3false\fR, then the \f3--deflate=hint\fR option overrides the default behavior and sets the deflation mode on all entries within the output JAR file\&.
    36 See \f[B]Options for the unpack200 Command\f[R].
       
    37 .RS
       
    38 .RE
    84 .TP
    39 .TP
    85 -r --remove-pack-file
    40 .B \f[I]input\-file\f[R]
    86 .br
    41 Name of the input file, which can be a \f[CB]pack200\ gzip\f[R] file or a
    87 Removes the input pack file\&.
    42 \f[CB]pack200\f[R] file.
       
    43 The input can also be a JAR file produced by \f[CB]pack200\f[R] with an
       
    44 effort of \f[CB]0\f[R], in which case the contents of the input file are
       
    45 copied to the output JAR file with the \f[CB]pack200\f[R] marker.
       
    46 .RS
       
    47 .RE
    88 .TP
    48 .TP
    89 -v --verbose
    49 .B \f[I]JAR\-file\f[R]
    90 .br
    50 Name of the output JAR file.
    91 Displays minimal messages\&. Multiple specifications of this option displays more verbose messages\&.
    51 .RS
       
    52 .RE
       
    53 .SH DESCRIPTION
       
    54 .PP
       
    55 The \f[CB]unpack200\f[R] command is a native implementation that
       
    56 transforms a packed file produced by the \f[CB]pack200\f[R] into a JAR
       
    57 file for web deployment.
       
    58 An example of typical usage follows.
       
    59 In the following example, the \f[CB]myarchive.jar\f[R] file is produced
       
    60 from \f[CB]myarchive.pack.gz\f[R] with the default \f[CB]unpack200\f[R]
       
    61 command settings.
       
    62 .RS
       
    63 .PP
       
    64 \f[CB]unpack200\ myarchive.pack.gz\ myarchive.jar\f[R]
       
    65 .RE
       
    66 .SH OPTIONS FOR THE UNPACK200 COMMAND
    92 .TP
    67 .TP
    93 -q --quiet
    68 .B \f[CB]\-H\f[R]\f[I]value\f[R] or \f[CB]\-\-deflate\-hint=\f[R]\f[I]value\f[R]
    94 .br
    69 Sets the deflation to be \f[CB]true\f[R], \f[CB]false\f[R], or \f[CB]keep\f[R]
    95 Specifies quiet operation with no messages\&.
    70 on all entries within a JAR file.
       
    71 The default mode is \f[CB]keep\f[R].
       
    72 If the value is \f[CB]true\f[R] or \f[CB]false\f[R], then the
       
    73 \f[CB]\-\-deflate=hint\f[R] option overrides the default behavior and sets
       
    74 the deflation mode on all entries within the output JAR file.
       
    75 .RS
       
    76 .RE
    96 .TP
    77 .TP
    97 -lfilename --log-file=\fIfilename\fR
    78 .B \f[CB]\-r\f[R] or \f[CB]\-\-remove\-pack\-file\f[R]
    98 .br
    79 Removes the input pack file.
    99 Specifies a log file where output messages are logged\&.
    80 .RS
       
    81 .RE
   100 .TP
    82 .TP
   101 -? -h --help
    83 .B \f[CB]\-v\f[R] or \f[CB]\-\-verbose\f[R]
   102 .br
    84 Displays minimal messages.
   103 Prints help information about the \f3unpack200\fR command\&.
    85 Multiple specifications of this option displays more verbose messages.
       
    86 .RS
       
    87 .RE
   104 .TP
    88 .TP
   105 -V --version
    89 .B \f[CB]\-q\f[R] or \f[CB]\-\-quiet\f[R]
   106 .br
    90 Specifies quiet operation with no messages.
   107 Prints version information about the \f3unpack200\fR command\&.
    91 .RS
       
    92 .RE
   108 .TP
    93 .TP
   109 -J\fIoption\fR
    94 .B \f[CB]\-l\f[R] \f[I]filename\f[R] or \f[CB]\-\-log\-file=\f[R]\f[I]filename\f[R]
   110 .br
    95 Specifies a log file where output messages are logged.
   111 Passes option to the Java Virtual Machine, where \f3option\fR is one of the options described on the reference page for the Java application launcher\&. For example, \f3-J-Xms48m\fR sets the startup memory to 48 MB\&. See java(1)\&.
    96 .RS
   112 .SH NOTES    
    97 .RE
   113 This command should not be confused with the \f3unpack\fR command\&. They are distinctly separate products\&.
    98 .TP
       
    99 .B \f[CB]\-?\f[R] or \f[CB]\-h\f[R] or \f[CB]\-\-help\f[R]
       
   100 Prints help information about the \f[CB]unpack200\f[R] command.
       
   101 .RS
       
   102 .RE
       
   103 .TP
       
   104 .B \f[CB]\-V\f[R] or \f[CB]\-\-version\f[R]
       
   105 Prints version information about the \f[CB]unpack200\f[R] command.
       
   106 .RS
       
   107 .RE
       
   108 .TP
       
   109 .B \f[CB]\-J\f[R]\f[I]option\f[R]
       
   110 Passes \f[I]option\f[R] to the Java Virtual Machine, where
       
   111 \f[CB]option\f[R] is one of the options described on the reference page
       
   112 for the Java application launcher.
       
   113 For example, \f[CB]\-J\-Xms48m\f[R] sets the startup memory to 48 MB.
       
   114 .RS
       
   115 .RE
       
   116 .SH NOTES
   114 .PP
   117 .PP
   115 The Java SE API Specification provided with the JDK is the superseding authority in case of discrepancies\&.
   118 This command shouldn\[aq]t be confused with the \f[CB]unpack\f[R] command.
   116 .SH EXIT\ STATUS    
   119 They\[aq]re distinctly separate products.
   117 The following exit values are returned: 0 for successful completion, and a value that is greater than 0 when an error occurred\&.
   120 .PP
   118 .SH SEE\ ALSO    
   121 The Java SE API Specification provided with the JDK is the superseding
   119 .TP 0.2i    
   122 authority in case of discrepancies.
   120 \(bu
   123 .SH EXIT STATUS
   121 pack200(1)
   124 .PP
   122 .TP 0.2i    
   125 The following exit values are returned: 0 for successful completion, and
   123 \(bu
   126 a value that is greater than 0 when an error occurred.
   124 jar(1)
       
   125 .TP 0.2i    
       
   126 \(bu
       
   127 jarsigner(1)
       
   128 .TP 0.2i    
       
   129 \(bu
       
   130 Pack200 and Compression at http://docs\&.oracle\&.com/javase/8/docs/technotes/guides/deployment/deployment-guide/pack200\&.html
       
   131 .TP 0.2i    
       
   132 \(bu
       
   133 The Java SE Technical Documentation page at http://docs\&.oracle\&.com/javase/
       
   134 .RE
       
   135 .br
       
   136 'pl 8.5i
       
   137 'bp