1 # 2 # Copyright (c) 2017, 2019, Oracle and/or its affiliates. All rights reserved. 3 # DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 # 5 # 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 7 # published by the Free Software Foundation. Oracle designates this 8 # particular file as subject to the "Classpath" exception as provided 9 # by Oracle in the LICENSE file that accompanied this code. 10 # 11 # This code is distributed in the hope that it will be useful, but WITHOUT 12 # ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 13 # FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 14 # version 2 for more details (a copy is included in the LICENSE file that 15 # accompanied this code). 16 # 17 # You should have received a copy of the GNU General Public License version 18 # 2 along with this work; if not, write to the Free Software Foundation, 19 # Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 20 # 21 # Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 22 # or visit www.oracle.com if you need additional information or have any 23 # questions. 24 # 25 # 26 27 MSG_Help_common=Usage: jpackage <mode> <options>\n\ 28 \n\ 29 where mode is one of: \n\ 30 \ create-image\n\ 31 \ Generates a platform-specific application image.\n\ 32 \ create-installer\n\ 33 \ Generates a platform-specific installer for the application.\n\ 34 \ \n\ 35 Sample usages:\n\ 36 --------------\n\ 37 \ Generate a modular application image:\n\ 38 \ jpackage create-image --output outputdir --name AppName \\\n\ 39 \ --main-class package.ClassName --module moduleName -p modulePath\n\ 40 \ jpackage create-image --o outputdir -n AppName \\\n\ 41 \ -c package.ClassName -m moduleName -p modulePath\n\ 42 \ Generate a non-modular application image:\n\ 43 \ jpackage create-image --input inputdir --output outputdir \\\n\ 44 \ --name AppName --main-class package.ClassName --main-jar MyJar.jar\n\ 45 \ jpackage create-image -i inputdir -o outputdir -n AppName \\\n\ 46 \ -c package.ClassName -j MyJar.jar\n\ 47 \ Generate an application installer:\n\ 48 \ jpackage create-installer -i inputdir -o outputdir \\\n\ 49 \ -n <installer-name> -c package.ClassName -j MyJar.jar\n\ 50 \ jpackage create-installer -o outputdir -n <installer-name>\\\n\ 51 \ --app-image <app image dir>\n\ 52 \ Generate a Java runtime installer:\n\ 53 \ jpackage create-installer --runtime-installer\\\n\ 54 \ --name <installer-name> --output outputdir\n\ 55 \ jpackage create-installer --runtime-installer \\\n\ 56 \ -n <installer-name> -o outputdir --runtime-image <runtime-path>\n\ 57 \n\ 58 The following options are valid for all platforms:\n\ 59 \ @<filename> \n\ 60 \ Read options and/or mode from a file \n\ 61 \ --help -h \n\ 62 \ Print the usage text with a list and description of each valid\n\ 63 \ option for the current platform to the output stream, and exit\n\ 64 \ --version -v\n\ 65 \ Print the product version to the output stream and exit\n\ 66 \ --output -o <output path>\n\ 67 \ Path where generated output file is placed\n\ 68 \ (absolute path or relative to the current directory)\n\ 69 \ --input -i <input path>\n\ 70 \ Path of the input directory that contains the files to package\n\ 71 \ (absolute path or relative to the current directory)\n\ 72 \ --files -f <input file>[{0}<input file>...]\n\ 73 \ A {0} separated list of files in the input dir to be packaged\n\ 74 \ If omitted, all files in the input directory will be packaged.\n\ 75 \ --name -n <application name>\n\ 76 \ Name of the application\n\ 77 \ --main-jar -j <main jar file>\n\ 78 \ The main JAR of the application; containing the main class\n\ 79 \ (specified as a path relative to the input path)\n\ 80 \ --main-class -c <class name>\n\ 81 \ Qualified name of the application main class to execute\n\ 82 \ --installer-type <type> \n\ 83 \ The type of the installer created in create-image mode\n\ 84 \ Valid values for "type" are "msi", "exe", "rpm", "deb", "dmg",\n\ 85 \ "pkg", and "pkg-app-store".\n\ 86 \ If this option is not specified (in create-installer mode),\n\ 87 \ all supported types of installable packages for the current\n\ 88 \ platform will be generated.\n\ 89 \ --runtime-installer \n\ 90 \ Generates a platform-specific installer for a Java runtime.\n\ 91 \ --app-version <version string>\n\ 92 \ Version of the application\n\ 93 \ --arguments -a <main class arguments>\n\ 94 \ Command line arguments to pass to the main class if no command\n\ 95 \ line arguments are given to the launcher\n\ 96 \ --icon <icon file path>\n\ 97 \ Path of the icon of the application bundle\n\ 98 \ (absolute path or relative to the current directory)\n\ 99 \ --identifier <id string>\n\ 100 \ Machine readable identifier of the application\n\ 101 \ The format must be a DNS name in reverse order,\n\ 102 \ such as com.example.myapplication.\n\ 103 \ --verbose\n\ 104 \ Enables verbose output\n\ 105 \ --strip-native-commands\n\ 106 \ Removes native executables from the custom run-time images\n\ 107 \ --jvm-args <java vm arguments>\n\ 108 \ Java arguments to pass to the virtual machine\n\ 109 \ --file-associations <file path>\n\ 110 \ Path to a Properties file that contains list of key, value pairs\n\ 111 \ (absolute path or relative to the current directory)\n\ 112 \ The keys "extension", "mime-type", "icon", and "description"\n\ 113 \ can be used to describe the association.\n\ 114 \ --secondary-launcher <file path>\n\ 115 \ Path to a Properties file that contains list of key, value pairs\n\ 116 \ (absolute path or relative to the current directory)\n\ 117 \ The keys "name" (required), "version", "module", "class",\n\ 118 \ "icon", "arguments", "jvm-args", "win-menu",\n\ 119 \ "win-shortcut", and "win-console" can be used.\n\ 120 \ These options are added to, or used to overwrite, the original\n\ 121 \ command line options when building the secondary launcher.\n\ 122 \ --build-root <file path>\n\ 123 \ Path of a new or empty directory used to create temporary files\n\ 124 \ (absolute path or relative to the current directory)\n\ 125 \ If not specified, a temporary directory will be created and\n\ 126 \ removed upon the task completion.\n\ 127 \ --runtime-image <file path>\n\ 128 \ Path of the predefined runtime image that is used to build\n\ 129 \ an application image and installable package\n\ 130 \ (absolute path or relative to the current directory)\n\ 131 \ --app-image <file path>\n\ 132 \ Location of the predefined application image that is used\n\ 133 \ to build an installable package\n\ 134 \ (absolute path or relative to the current directory)\n\ 135 \ --install-dir <file path>\n\ 136 \ Absolute path of the installation directory of the application\n\ 137 \ This option is ignored on Windows, use --win-dir-chooser to\n\ 138 \ provide user the ability to choose the installation directory.\n\ 139 \ --license-file <file path>\n\ 140 \ Path to the license file\n\ 141 \ (absolute path or relative to the current directory)\n\ 142 \ --copyright <copyright string>\n\ 143 \ Copyright for the application\n\ 144 \ --description <description string>\n\ 145 \ Description of the application\n\ 146 \ --category <category string>\n\ 147 \ Category or group of the application\n\ 148 \ --vendor <vendor string>\n\ 149 \ Vendor of the application\n\ 150 \ --overwrite\n\ 151 \ Allow the recursive deletion of an existing application \n\ 152 \ output directory when creating an application image\n\ 153 \ --resource-dir <path>\n\ 154 \ Path to override jpackage resources\n\ 155 \ Icons, template files, and other resources of jpackage can be\n\ 156 \ over-ridden by adding replacement resources to this directory.\n\ 157 \ (absolute path or relative to the current directory)\n\ 158 \n\ 159 Modular options:\n\ 160 \ --module -m <module name>\n\ 161 \ Main module of the application\n\ 162 \ This module must contain the main-class,\n\ 163 \ and be located on the module path.\n\ 164 \ --module-path -p <module path>\n\ 165 \ Path jlink looks in for modules when packaging the Java Runtime\n\ 166 \ (absolute path or relative to the current directory)\n\ 167 \ --add-modules <module name>[,<module name>...]\n\ 168 \ A comma (",") separated list of modules to add.\n\ 169 170 MSG_Help_mac=\nThe following options are valid for Mac OS X platforms:\n\ 171 \ --mac-sign\n\ 172 \ Request that the bundle be signed\n\ 173 \ --mac-bundle-name <name string>\n\ 174 \ Name of the application as it appears in the Menu Bar\n\ 175 \ This can be different from the application name.\n\ 176 \ This name must be less than 16 characters long and be suitable for\n\ 177 \ displaying in the menu bar and the application Info window.\n\ 178 \ Defaults to the application name.\n\ 179 \ --mac-bundle-identifier <ID string>\n\ 180 \ An identifier that uniquely identifies the application for MacOSX\n\ 181 \ (and on the Mac App Store)\n\ 182 \ May only use alphanumeric (A-Z,a-z,0-9), hyphen (-),\n\ 183 \ and period (.) characters.\n\ 184 \ --mac-app-store-category <category string>\n\ 185 \ Mac App Store Categories\n\ 186 \ Note that the key is the string shown to\n\ 187 \ the user and the value is the ID of the category.\n\ 188 \ --mac-app-store-entitlements <file path>\n\ 189 \ Path of a custom mac app store entitlements file\n\ 190 \ (absolute path or relative to the current directory)\n\ 191 \ --mac-bundle-signing-prefix <prefix string>\n\ 192 \ When signing the application bundle, this value is prefixed to all\n\ 193 \ components that need to be signed that don't have\n\ 194 \ an existing bundle identifier.\n\ 195 \ --mac-signing-key-user-name <user name>\n\ 196 \ User name portion of the typical\n\ 197 \ "Mac Developer ID Application: <user name>" signing key\n\ 198 \ --mac-signing-keychain <file path>\n\ 199 \ Path of the keychain to use\n\ 200 \ (absolute path or relative to the current directory)\n\ 201 \ If not specified, the standard keychains are used.\n\ 202 203 MSG_Help_linux=\nThe following options are valid for Linux platforms:\n\ 204 \ --linux-bundle-name <bundle name>\n\ 205 \ Name for Linux bundle, defaults to the application name\n\ 206 \ --linux-package-deps\n\ 207 \ Required packages or capabilities for the application\n\ 208 \ --linux-rpm-license-type <type string>\n\ 209 \ Type of the license ("License: <value>" of the RPM .spec)\n\ 210 \ --linux-deb-maintainer <email address>\n\ 211 \ Maintainer for .deb bundle\n\ 212 213 MSG_Help_win=\nThe following options are valid for Windows platforms:\n\ 214 \ --win-menu\n\ 215 \ Adds the application to the system menu\n\ 216 \ --win-menu-group <menu group name>\n\ 217 \ Start Menu group this application is placed in\n\ 218 \ --win-per-user-install\n\ 219 \ Request to perform an install on a per-user basis\n\ 220 \ --win-dir-chooser\n\ 221 \ Adds a dialog to enable the user to choose a directory in which\n\ 222 \ the product is installed\n\ 223 \ --win-registry-name <registry name>\n\ 224 \ Name of the application for registry references.\n\ 225 \ The default is the Application Name with only\n\ 226 \ alphanumerics, dots, and dashes (no whitespace)\n\ 227 \ --win-upgrade-uuid <id string>\n\ 228 \ UUID associated with upgrades for this package\n\ 229 \ --win-shortcut\n\ 230 \ Creates a desktop shortcut for the application\n\ 231 \ --win-console\n\ 232 \ Creates a console launcher for the application, should be\n\ 233 \ specified for application which requires console interactions\n\ 234 235 MSG_Help_no_args=Usage: jpackage <mode> <options>\n\ 236 \Use jpackage --help (or -h) for a list of possible options\ 237