< prev index next >
src/jdk.incubator.jpackage/share/classes/jdk/incubator/jpackage/internal/resources/HelpResources.properties
Print this page
@@ -22,64 +22,65 @@
# or visit www.oracle.com if you need additional information or have any
# questions.
#
#
-MSG_Help=Usage: jpackage <mode> <options>\n\
+MSG_Help=Usage: jpackage <options>\n\
\n\
-where mode is one of: \n\
-\ create-app-image\n\
-\ Generates a platform-specific application image.\n\
-\ create-installer\n\
-\ Generates a platform-specific installer for the application.\n\
-\ \n\
Sample usages:\n\
--------------\n\
-\ Generate a non-modular application image:\n\
-\ jpackage create-app-image -o outputdir -i inputdir -n name \\\n\
-\ --main-class className --main-jar MyJar.jar\n\
-\ Generate a modular application image:\n\
-\ jpackage create-app-image -o outputdir -n name \\\n\
-\ -p modulePath -m moduleName/className\n\
+\ Generate an application package suitable for the host system:\n\
+\ For a modular application:\n\
+\ jpackage -n name -p modulePath -m moduleName/className\n\
+\ For a non-modular application:\n\
+\ jpackage -i inputDir -n name \\\n\
+\ --main-class className --main-jar myJar.jar\n\
+\ From a pre-built application image:\n\
+\ jpackage -n name --app-image appImageDir\n\
+\ Generate an application image:\n\
+\ For a modular application:\n\
+\ jpackage --type app-image -n name -p modulePath \\\n\
+\ -m moduleName/className\n\
+\ For a non-modular application:\n\
+\ jpackage --type app-image -i inputDir -n name \\\n\
+\ --main-class className --main-jar myJar.jar\n\
\ To provide your own options to jlink, run jlink separately:\n\
-\ jlink --output appRuntimeImage -p ModulePath -m moduleName\\\n\
+\ jlink --output appRuntimeImage -p modulePath -m moduleName \\\n\
\ --no-header-files [<additional jlink options>...]\n\
-\ jpackage create-app-image -o outputdir -n name\\\n\
-\ -m moduleName/className --runtime-image appRuntimeIMage\n\
-\ Generate an application installer:\n\
-\ jpackage create-installer -o outputdir -n name \\\n\
-\ -p modulePath -m moduleName/className\n\
-\ jpackage create-installer -i inputdir -o outputdir -n name \\\n\
-\ --main-class package.ClassName --main-jar MyJar.jar\n\
-\ jpackage create-installer -o outputdir -n <installer-name> \\\n\
-\ --app-image <app image dir> [--installer-type <type>]\n\
-\ Generate a Java runtime installer:\n\
-\ jpackage create-installer -o outputdir -n name \\\n\
-\ --runtime-image <runtime-image>\n\
+\ jpackage --type app-image -n name \\\n\
+\ -m moduleName/className --runtime-image appRuntimeImage\n\
+\ Generate a Java runtime package:\n\
+\ jpackage -n name --runtime-image <runtime-image>\n\
\n\
Generic Options:\n\
\ @<filename> \n\
\ Read options and/or mode from a file \n\
\ This option can be used multiple times.\n\
+\ --type -t <type> \n\
+\ The type of package to create\n\
+\ Valid values are: {1} \n\
+\ If this option is not specified a platform dependent\n\
+\ default type will be created.\n\
\ --app-version <version>\n\
-\ Version of the application and/or installer\n\
+\ Version of the application and/or package\n\
\ --copyright <copyright string>\n\
\ Copyright for the application\n\
\ --description <description string>\n\
\ Description of the application\n\
\ --help -h \n\
\ Print the usage text with a list and description of each valid\n\
\ option for the current platform to the output stream, and exit\n\
\ --name -n <name>\n\
-\ Name of the application and/or installer\n\
-\ --output -o <output path>\n\
+\ Name of the application and/or package\n\
+\ --dest -d <destination path>\n\
\ Path where generated output file is placed\n\
+\ Defaults to the current working directory.\n\
\ (absolute path or relative to the current directory)\n\
-\ --temp-root <file path>\n\
+\ --temp <file path>\n\
\ Path of a new or empty directory used to create temporary files\n\
\ (absolute path or relative to the current directory)\n\
-\ If specified, the temp-root will not be removed upon the task\n\
+\ If specified, the temp dir will not be removed upon the task\n\
\ completion and must be removed manually\n\
\ If not specified, a temporary directory will be created and\n\
\ removed upon the task completion.\n\
\ --vendor <vendor string>\n\
\ Vendor of the application\n\
@@ -101,23 +102,25 @@
\ A {0} separated list of paths\n\
\ Each path is either a directory of modules or the path to a\n\
\ modular jar.\n\
\ (each path is absolute or relative to the current directory)\n\
\ This option can be used multiple times.\n\
+\ --bind-services \n\
+\ Pass on --bind-services option to jlink (which will link in \n\
+\ service provider modules and their dependences) \n\
\ --runtime-image <file path>\n\
\ Path of the predefined runtime image that will be copied into\n\
\ the application image\n\
\ (absolute path or relative to the current directory)\n\
\ If --runtime-image is not specified, jpackage will run jlink to\n\
\ create the runtime image using options:\n\
\ --strip-debug, --no-header-files, --no-man-pages, and\n\
-\ --strip-native-commands. --bind-services will also be added if\n\
-\ --add-modules is not specified.\n\
+\ --strip-native-commands.\n\
\n\
\Options for creating the application image:\n\
\ --icon <icon file path>\n\
-\ Path of the icon of the application bundle\n\
+\ Path of the icon of the application package\n\
\ (absolute path or relative to the current directory)\n\
\ --input -i <input path>\n\
\ Path of the input directory that contains the files to be packaged\n\
\ (absolute path or relative to the current directory)\n\
\ All files in the input directory will be packaged into the\n\
@@ -126,11 +129,11 @@
\Options for creating the application launcher(s):\n\
\ --add-launcher <launcher name>=<file path>\n\
\ Name of launcher, and a path to a Properties file that contains\n\
\ a list of key, value pairs\n\
\ (absolute path or relative to the current directory)\n\
-\ The keys "module", "add-modules", "main-jar", "main-class",\n\
+\ The keys "module", "main-jar", "main-class",\n\
\ "arguments", "java-options", "app-version", "icon", and\n\
\ "win-console" can be used.\n\
\ These options are added to, or used to overwrite, the original\n\
\ command line options to build an additional alternative launcher.\n\
\ The main application launcher will be built from the command line\n\
@@ -157,34 +160,23 @@
\ This module must be located on the module path.\n\
\ When this option is specified, the main module will be linked\n\
\ in the Java runtime image. Either --module or --main-jar\n\
\ option can be specified but not both.\n\
{2}\n\
-\Options for creating the application installer(s):\n\
+\Options for creating the application package:\n\
\ --app-image <file path>\n\
\ Location of the predefined application image that is used\n\
\ to build an installable package\n\
\ (absolute path or relative to the current directory)\n\
-\ See create-app-image mode options to create the application image.\n\
\ --file-associations <file path>\n\
\ Path to a Properties file that contains list of key, value pairs\n\
\ (absolute path or relative to the current directory)\n\
\ The keys "extension", "mime-type", "icon", and "description"\n\
\ can be used to describe the association.\n\
\ This option can be used multiple times.\n\
-\ --identifier <id string>\n\
-\ An identifier that uniquely identifies the application\n\
-\ Defaults to the main class name.\n\
-\ The value should be a valid DNS name.\n\
\ --install-dir <file path>\n\
\ {4}\
-\ --installer-type <type> \n\
-\ The type of the installer to create\n\
-\ Valid values are: {1} \n\
-\ If this option is not specified (in create-installer mode) all\n\
-\ supported types of installable packages for the current\n\
-\ platform will be created.\n\
\ --license-file <file path>\n\
\ Path to the license file\n\
\ (absolute path or relative to the current directory)\n\
\ --resource-dir <path>\n\
\ Path to override jpackage resources\n\
@@ -192,13 +184,13 @@
\ over-ridden by adding replacement resources to this directory.\n\
\ (absolute path or relative to the current directory)\n\
\ --runtime-image <file-path>\n\
\ Path of the predefined runtime image to install\n\
\ (absolute path or relative to the current directory)\n\
-\ Option is required when creating a runtime installer.\n\
+\ Option is required when creating a runtime package.\n\
\n\
-\Platform dependent options for creating the application installer(s):\n\
+\Platform dependent options for creating the application package:\n\
{3}
MSG_Help_win_launcher=\
\n\
\Platform dependent option for creating the application launcher:\n\
@@ -214,66 +206,70 @@
\ Adds the application to the system menu\n\
\ --win-menu-group <menu group name>\n\
\ Start Menu group this application is placed in\n\
\ --win-per-user-install\n\
\ Request to perform an install on a per-user basis\n\
-\ --win-registry-name <registry name>\n\
-\ Name of the application for registry references.\n\
-\ The default is the Application Name with only\n\
-\ alphanumerics, dots, and dashes (no whitespace)\n\
\ --win-shortcut\n\
\ Creates a desktop shortcut for the application\n\
\ --win-upgrade-uuid <id string>\n\
\ UUID associated with upgrades for this package\n\
MSG_Help_win_install_dir=\
\Relative sub-path under the default installation location\n\
MSG_Help_mac_launcher=\
-\ --mac-bundle-identifier <ID string>\n\
-\ An identifier that uniquely identifies the application for MacOSX\n\
-\ Defaults to the value of --identifier option.\n\
+\ --mac-package-identifier <ID string>\n\
+\ An identifier that uniquely identifies the application for macOS\n\
+\ Defaults to the main class name.\n\
\ May only use alphanumeric (A-Z,a-z,0-9), hyphen (-),\n\
\ and period (.) characters.\n\
-\ --mac-bundle-name <name string>\n\
+\ --mac-package-name <name string>\n\
\ Name of the application as it appears in the Menu Bar\n\
\ This can be different from the application name.\n\
\ This name must be less than 16 characters long and be suitable for\n\
\ displaying in the menu bar and the application Info window.\n\
\ Defaults to the application name.\n\
-\ --mac-bundle-signing-prefix <prefix string>\n\
-\ When signing the application bundle, this value is prefixed to all\n\
-\ components that need to be signed that don't have\n\
-\ an existing bundle identifier.\n\
+\ --mac-package-signing-prefix <prefix string>\n\
+\ When signing the application package, this value is prefixed\n\
+\ to all components that need to be signed that don't have\n\
+\ an existing package identifier.\n\
\ --mac-sign\n\
-\ Request that the bundle be signed\n\
+\ Request that the package be signed\n\
\ --mac-signing-keychain <file path>\n\
-\ Path of the keychain to use\n\
-\ (absolute path or relative to the current directory)\n\
+\ Path of the keychain to search for the signing identity\n\
+\ (absolute path or relative to the current directory).\n\
\ If not specified, the standard keychains are used.\n\
-\ --mac-signing-key-user-name <user name>\n\
-\ User name portion of the typical\n\
-\ "Mac Developer ID Application: <user name>" signing key\n\
+\ --mac-signing-key-user-name <team name>\n\
+\ Team name portion in Apple signing identities' names.\n\
+\ For example "Developer ID Application: "\n\
MSG_Help_linux_install=\
-\ --linux-bundle-name <bundle name>\n\
-\ Name for Linux bundle, defaults to the application name\n\
+\ --linux-package-name <package name>\n\
+\ Name for Linux package, defaults to the application name\n\
\ --linux-deb-maintainer <email address>\n\
-\ Maintainer for .deb bundle\n\
+\ Maintainer for .deb package\n\
\ --linux-menu-group <menu-group-name>\n\
\ Menu group this application is placed in\n\
\ --linux-package-deps\n\
\ Required packages or capabilities for the application\n\
\ --linux-rpm-license-type <type string>\n\
\ Type of the license ("License: <value>" of the RPM .spec)\n\
+\ --linux-app-release <release value>\n\
+\ Release value of the RPM <name>.spec file or \n\
+\ Debian revision value of the DEB control file.\n\
+\ --linux-app-category <category value>\n\
+\ Group value of the RPM <name>.spec file or \n\
+\ Section value of DEB control file.\n\
+\ --linux-shortcut\n\
+\ Creates a shortcut for the application\n\
MSG_Help_mac_linux_install_dir=\
\Absolute path of the installation directory of the application\n\
MSG_Help_default_install_dir=\
\Absolute path of the installation directory of the application on OS X\n\
-\ or Linux. Relative sub-path of the installation location of the application\n\
-\ such as "Program Files" or "AppData" on Windows.\n\
+\ or Linux. Relative sub-path of the installation location of\n\
+\ the application such as "Program Files" or "AppData" on Windows.\n\
-MSG_Help_no_args=Usage: jpackage <mode> <options>\n\
+MSG_Help_no_args=Usage: jpackage <options>\n\
\Use jpackage --help (or -h) for a list of possible options\
< prev index next >