OS Manuals

/usr/lib/jvm/java-17-zulu/bin/jpackage

Zulu 17 Java development kit (PSU stream)

From zulu-17-psu 17.0.20-r2 (enterprise-packages), captured 2026-11-08 by running jpackage --help (exit 0). permalink

Usage: jpackage <options>

Sample usages:
--------------
    Generate an application package suitable for the host system:
        For a modular application:
            jpackage -n name -p modulePath -m moduleName/className
        For a non-modular application:
            jpackage -i inputDir -n name \
                --main-class className --main-jar myJar.jar
        From a pre-built application image:
            jpackage -n name --app-image appImageDir
    Generate an application image:
        For a modular application:
            jpackage --type app-image -n name -p modulePath \
                -m moduleName/className
        For a non-modular application:
            jpackage --type app-image -i inputDir -n name \
                --main-class className --main-jar myJar.jar
        To provide your own options to jlink, run jlink separately:
            jlink --output appRuntimeImage -p modulePath \
                --add-modules moduleName \
                --no-header-files [<additional jlink options>...]
            jpackage --type app-image -n name \
                -m moduleName/className --runtime-image appRuntimeImage
    Generate a Java runtime package:
        jpackage -n name --runtime-image <runtime-image>

Generic Options:
  @<filename>
          Read options and/or mode from a file
          This option can be used multiple times.
  --type -t <type>
          The type of package to create
          Valid values are: {"app-image", "rpm", "deb"}
          If this option is not specified a platform dependent
          default type will be created.
  --app-version <version>
          Version of the application and/or package
  --copyright <copyright string>
          Copyright for the application
  --description <description string>
          Description of the application
  --help -h
          Print the usage text with a list and description of each valid
          option for the current platform to the output stream, and exit
  --icon <file path>
          Path of the icon of the application package
          (absolute path or relative to the current directory)
  --name -n <name>
          Name of the application and/or package
  --dest -d <destination path>
          Path where generated output file is placed
          (absolute path or relative to the current directory)
          Defaults to the current working directory.
  --temp <directory path>
          Path of a new or empty directory used to create temporary files
          (absolute path or relative to the current directory)
          If specified, the temp dir will not be removed upon the task
          completion and must be removed manually.
          If not specified, a temporary directory will be created and
          removed upon the task completion.
  --vendor <vendor string>
          Vendor of the application
  --verbose
          Enables verbose output
  --version
          Print the product version to the output stream and exit.

Options for creating the runtime image:
  --add-modules <module name>[,<module name>...]
          A comma (",") separated list of modules to add
          This module list, along with the main module (if specified)
          will be passed to jlink as the --add-module argument.
          If not specified, either just the main module (if --module is
          specified), or the default set of modules (if --main-jar is
          specified) are used.
          This option can be used multiple times.
  --module-path -p <module path>...
          A : separated list of paths
          Each path is either a directory of modules or the path to a
          modular jar.
          (Each path is absolute or relative to the current directory.)
          This option can be used multiple times.
  --jlink-options <jlink options>
          A space separated list of options to pass to jlink
          If not specified, defaults to "--strip-native-commands
          --strip-debug --no-man-pages --no-header-files".
          This option can be used multiple times.
  --runtime-image <directory path>
          Path of the predefined runtime image that will be copied into
          the application image
          (absolute path or relative to the current directory)
          If --runtime-image is not specified, jpackage will run jlink to
          create the runtime image using options:
          --strip-debug, --no-header-files, --no-man-pages, and
          --strip-native-commands.

Options for creating the application image:
  --input -i <directory path>
          Path of the input directory that contains the files to be packaged
          (absolute path or relative to the current directory)
          All files in the input directory will be packaged into the
          application image.

Options for creating the application launcher(s):
  --add-launcher <launcher name>=<file path>
          Name of launcher, and a path to a Properties file that contains
          a list of key, value pairs
          (absolute path or relative to the current directory)
          The keys "module", "main-jar", "main-class",
          "arguments", "java-options", "app-version", "icon", and
          "win-console" can be used.
          These options are added to, or used to overwrite, the original
          command line options to build an additional alternative launcher.
          The main application launcher will be built from the command line
          options. Additional alternative launchers can be built using
          this option, and this option can be used multiple times to
          build multiple additional launchers.
  --arguments <main class arguments>
          Command line arguments to pass to the main class if no command
          line arguments are given to the launcher
          This option can be used multiple times.
  --java-options <java options>
          Options to pass to the Java runtime
          This option can be used multiple times.
  --main-class <class name>
          Qualified name of the application main class to execute
          This option can only be used if --main-jar is specified.
  --main-jar <main jar file>
          The main JAR of the application; containing the main class
          (specified as a path relative to the input path)
          Either --module or --main-jar option can be specified but not
          both.
  --module -m <module name>[/<main class>]
          The main module (and optionally main class) of the application
          This module must be located on the module path.
          When this option is specified, the main module will be linked
          in the Java runtime image.  Either --module or --main-jar
          option can be specified but not both.

Options for creating the application package:
  --about-url <url>
          URL of the application's home page
  --app-image <directory path>
          Location of the predefined application image that is used
          to build an installable package
          (absolute path or relative to the current directory)
  --file-associations <file path>
          Path to a Properties file that contains list of key, value pairs
          (absolute path or relative to the current directory)
          The keys "extension", "mime-type", "icon", and "description"
          can be used to describe the association.
          This option can be used multiple times.
  --install-dir <directory path>
          Absolute path of the installation directory of the application
  --license-file <file path>
          Path to the license file
          (absolute path or relative to the current directory)
  --resource-dir <directory path>
          Path to override jpackage resources
          Icons, template files, and other resources of jpackage can be
          over-ridden by adding replacement resources to this directory.
          (absolute path or relative to the current directory)
  --runtime-image <directory path>
          Path of the predefined runtime image to install
          (absolute path or relative to the current directory)
          Option is required when creating a runtime package.

Platform dependent options for creating the application package:
  --linux-package-name <package name>
          Name for Linux package, defaults to the application name
  --linux-deb-maintainer <email address>
          Maintainer for .deb package
  --linux-menu-group <menu-group-name>
          Menu group this application is placed in
  --linux-package-deps
          Required packages or capabilities for the application
  --linux-rpm-license-type <type string>
          Type of the license ("License: <value>" of the RPM .spec)
  --linux-app-release <release value>
          Release value of the RPM <name>.spec file or
          Debian revision value of the DEB control file
  --linux-app-category <category value>
          Group value of the RPM <name>.spec file or
          Section value of DEB control file
  --linux-shortcut
          Creates a shortcut for the application.
Options (57)
OptionDescriptionSource
-m moduleName/classNamehelp
--app-version versionVersion of the application and/or packagehelp + man
--help, -h -hPrint the usage text with a list and description of each valid option for the current platform to the output stream, and exit.help + man
--verboseEnables verbose output.help + man
--versionPrint the product version to the output stream and exit.help + man
--strip-debug, --no-header-files, --no-man-pageshelp
--strip-native-commandshelp
--about-url urlURL of the application's home pagehelp + man
--linux-menu-group menu-group-nameMenu group this application is placed inhelp + man
--linux-package-depsRequired packages or capabilities for the applicationhelp + man
--linux-shortcutCreates a shortcut for the application.help + man
--type, -t typeThe type of package to create (in the manual page but not in --help)man
--copyright copyrightCopyright for the application (in the manual page but not in --help)man
--description descriptionDescription of the application (in the manual page but not in --help)man
--icon iconPath of the icon of the application package (absolute path or relative to the current directory) (in the manual page but not in --help)man
--name, -n nameName of the application and/or package (in the manual page but not in --help)man
--dest, -d outputPath where generated output file is placed (in the manual page but not in --help)man
--temp directoryPath of a new or empty directory used to create temporary files (absolute path or relative to the current directory) (in the manual page but not in --help)man
--vendor vendorVendor of the application (in the manual page but not in --help)man
--module-path, -p moduleA File.pathSeparator separated list of paths (in the manual page but not in --help)man
--jlink-options jlinkA space separated list of options to pass to jlink (in the manual page but not in --help)man
--runtime-image directoryPath of the predefined runtime image that will be copied into the application image (absolute path or relative to the current directory) (in the manual page but not in --help)man
--input, -i inputPath of the input directory that contains the files to be packaged (absolute path or relative to the current directory) (in the manual page but not in --help)man
--add-launcher launcherName of launcher, and a path to a Properties file that contains a list of key, value pairs (absolute path or relative to the current directory) (in the manual page but not in --help)man
--arguments mainCommand line arguments to pass to the main class if no command line arguments are given to the launcher (in the manual page but not in --help)man
--java-options javaOptions to pass to the Java runtime (in the manual page but not in --help)man
--main-class classQualified name of the application main class to execute (in the manual page but not in --help)man
--main-jar mainThe main JAR of the application; (in the manual page but not in --help)man
--win-consoleCreates a console launcher for the application, should be specified for application which requires console interactions (in the manual page but not in --help)man
--mac-package-identifier IDAn identifier that uniquely identifies the application for macOS (in the manual page but not in --help)man
--mac-package-name nameName of the application as it appears in the Menu Bar (in the manual page but not in --help)man
--mac-package-signing-prefix prefixWhen signing the application package, this value is prefixed to all components that need to be signed that don't have an existing package identifier. (in the manual page but not in --help)man
--mac-signRequest that the bundle be signed. (in the manual page but not in --help)man
--mac-signing-keychain keychainName of the keychain to search for the signing identity (in the manual page but not in --help)man
--mac-signing-key-user-name teamTeam or user name portion in Apple signing identities (in the manual page but not in --help)man
--mac-app-storeIndicates that the jpackage output is intended for the Mac App Store. (in the manual page but not in --help)man
--mac-entitlements filePath to file containing entitlements to use when signing executables and libraries in the bundle (in the manual page but not in --help)man
--mac-app-category categoryString used to construct LSApplicationCategoryType in application plist (in the manual page but not in --help)man
--app-image directoryLocation of the predefined application image that is used to build an installable package (in the manual page but not in --help)man
--file-associations filePath to a Properties file that contains list of key, value pairs (absolute path or relative to the current directory) (in the manual page but not in --help)man
--install-dir directoryAbsolute path of the installation directory of the application (on macos or linux), or relative sub-path of the installation directory such as "Program Files" or "AppData" (on Windows) (in the manual page but not in --help)man
--license-file filePath to the license file (absolute path or relative to the current directory) (in the manual page but not in --help)man
--resource-dir directoryPath to override jpackage resources (absolute path or relative to the current directory) (in the manual page but not in --help)man
--win-dir-chooserAdds a dialog to enable the user to choose a directory in which the product is installed. (in the manual page but not in --help)man
--win-help-url urlURL where user can obtain further information or technical support (in the manual page but not in --help)man
--win-menuRequest to add a Start Menu shortcut for this application (in the manual page but not in --help)man
--win-menu-group menuStart Menu group this application is placed in (in the manual page but not in --help)man
--win-per-user-installRequest to perform an install on a per-user basis (in the manual page but not in --help)man
--win-shortcutRequest to create a desktop shortcut for this application (in the manual page but not in --help)man
--win-shortcut-promptAdds a dialog to enable the user to choose if shortcuts will be created by installer (in the manual page but not in --help)man
--win-update-url urlURL of available application update information (in the manual page but not in --help)man
--win-upgrade-uuid idUUID associated with upgrades for this package (in the manual page but not in --help)man
--linux-package-name packageName for Linux package (in the manual page but not in --help)man
--linux-deb-maintainer emailMaintainer for .deb bundle (in the manual page but not in --help)man
--linux-rpm-license-type typeType of the license ("License: <value>" of the RPM .spec) (in the manual page but not in --help)man
--linux-app-release releaseRelease value of the RPM <name>.spec file or Debian revision value of the DEB control file (in the manual page but not in --help)man
--linux-app-category categoryGroup value of the RPM <name>.spec file or Section value of DEB control file (in the manual page but not in --help)man

Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.