Java Platform, Standard Edition Packaging Tool User's Guide Release 15 F29756-01 September 2020 Java Platform, Standard Edition Packaging Tool User's Guide, Release 15 F29756-01 Copyright © 2020, Oracle and/or its affiliates. This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by intellectual property laws. Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means. Reverse engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited. The information contained herein is subject to change without notice and is not warranted to be error-free. If you find any errors, please report them to us in writing. If this is software or related documentation that is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government, then the following notice is applicable: U.S. GOVERNMENT END USERS: Oracle programs (including any operating system, integrated software, any programs embedded, installed or activated on delivered hardware, and modifications of such programs) and Oracle computer documentation or other Oracle data delivered to or accessed by U.S. Government end users are "commercial computer software" or "commercial computer software documentation" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, the use, reproduction, duplication, release, display, disclosure, modification, preparation of derivative works, and/or adaptation of i) Oracle programs (including any operating system, integrated software, any programs embedded, installed or activated on delivered hardware, and modifications of such programs), ii) Oracle computer documentation and/or iii) other Oracle data, is subject to the rights and limitations specified in the license contained in the applicable contract. The terms governing the U.S. Government’s use of Oracle cloud services are defined by the applicable contract for such services. No other rights are granted to the U.S. Government. This software or hardware is developed for general use in a variety of information management applications. It is not developed or intended for use in any inherently dangerous applications, including applications that may create a risk of personal injury. If you use this software or hardware in dangerous applications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure its safe use. Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this software or hardware in dangerous applications. Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners. Intel and Intel Inside are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks are used under license and are trademarks or registered trademarks of SPARC International, Inc. AMD, Epyc, and the AMD logo are trademarks or registered trademarks of Advanced Micro Devices. UNIX is a registered trademark of The Open Group. This software or hardware and documentation may provide access to or information about content, products, and services from third parties. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to third-party content, products, and services unless otherwise set forth in an applicable agreement between you and Oracle. Oracle Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to your access to or use of third-party content, products, or services, except as set forth in an applicable agreement between you and Oracle. Contents Preface Audience v Documentation Accessibility v Related Documents v Conventions v 1 Packaging Overview Packaging Pre-Reqs 1-2 Application Preparation 1-2 Generated Application Image 1-2 Java Runtime Requirements 1-3 2 Basic Packaging Defaults for Options Not Specified 2-1 Package a Non-Modular Application 2-3 Package a Modular Application 2-3 Identify Your Application with Package Metadata 2-4 3 Support Application Requirements Set Default Command-Line Arguments 3-1 Set JVM Options 3-2 Set File Associations 3-3 Add Launchers 3-4 Sign the Application Package (macOS) 3-6 4 Manage the Installation of Your Application Include a License 4-1 Create a Shortcut 4-1 Set the Installation Directory 4-2 iii Add the Application to a Menu 4-2 Launch in Console 4-3 5 Image and Runtime Modifications Application Image Modifications 5-1 Java Runtime Modifications 5-1 6 Override jpackage Resources Resources Used in Packaging 6-1 View Resources 6-3 iv Preface This guide provides information about using jpackage, the packaging tool provided with the JDK for generating installable packages for self-contained Java applications. Audience This guide is intended for developers interested in creating self-contained Java applications that provide native packaging formats, which give the end user a natural installation experience. Documentation Accessibility For information about Oracle's commitment to accessibility, visit the Oracle Accessibility Program website at http://www.oracle.com/pls/topic/lookup? ctx=acc&id=docacc. Access to Oracle Support Oracle customers that have purchased support have access to electronic support through My Oracle Support. For information, visit http://www.oracle.com/pls/topic/ lookup?ctx=acc&id=info or visit http://www.oracle.com/pls/topic/lookup?ctx=acc&id=trs if you are hearing impaired. Related Documents See JDK 15 Documentation. Conventions The following conventions are used in this document: Convention Meaning boldface Boldface type indicates graphical user interface elements associated with an action, or terms defined in text or the glossary. italic Italic type indicates book titles, emphasis, or placeholder variables for which you supply particular values. monospace Monospace type indicates commands within a paragraph, URLs, code in examples, text that appears on the screen, or text that you enter. v 1 Packaging Overview The packaging tool jpackage enables you to generate installable packages for modular and non-modular Java applications. Platform-specific packages for Linux, macOS and Windows provide your users with a familiar way to install and launch your applications. Note: The jpackage tool is included in the JDK as an incubator module named jdk.incubator.jpackage. As a feature delivered in an incubator module, the tool's command line options, application layout, and other exported interfaces are not guaranteed to be stable. The jdk.incubator.jpackage module is not resolved by default, and produces a warning when it is resolved. A warning is also issued when jpackage is run. For information about incubator modules, see JEP 11: Incubator Modules. The simplest form of packaging takes a pre-built Java application as input and generates an installable package in a platform-dependent default format. The packaging tool generates a runtime for your application using the jlink command. For applications that require more advanced capabilities, command line options are available for features such as the following: • Provide a custom icon • Install the application in a specific location • Specify JVM options and application arguments to be used when launching the application • Set file associations to launch the application when an associated file type is opened • Launch the application from a platform-specific menu group • Set up multiple launchers for the application • Sign the bundle (macOS only) For a description of jpackage and its options, see The jpackage Command in the Java Development Kit Tool Specifications. Topics: • Packaging Pre-Reqs • Application Preparation • Java Runtime Requirements 1-1 Chapter 1 Packaging Pre-Reqs Packaging Pre-Reqs Application packages must be built on the target platform. The system used for packaging must contain the application, a JDK, and software needed by the packaging tool. To package your application for multiple platforms, you must run the packaging tool on each platform. If you want more than one format for a platform, you must run the tool once for each format. The following platforms and formats are supported with the required software: • Linux: deb, rpm: – For Red Hat Linux, the rpm-build package is required. – For Ubuntu Linux, the fakeroot package is required. • macOS: pkg, app in a dmg Xcode command line tools are required when the --mac-sign option is used to request that the package be signed, and when the --icon option is used to customize the DMG image. • Windows: exe, msi WiX 3.0 or later is required. Application Preparation To package your application, you must first build it and create the necessary JAR or module files. Resources needed by your application must also be available on the system used for packaging. The following application-related information and resources are used for packaging: • JAR or module files for the application • Application metadata, for example, name, version, description, copyright, license file • Installation options, for example, shortcut, menu group, additional launchers, file associations • Launch options, for example, application arguments, JVM options As part of the packaging process,