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=Usage: jpackage <options>\n\ 28 \n\ 29 Sample usages:\n\ 30 --------------\n\ 31 \ Generate a non-modular application image:\n\ 32 \ jpackage --package-type app-image -o outputdir -i inputdir -n name \\\n\ 33 \ --main-class className --main-jar MyJar.jar\n\ 34 \ Generate a modular application image:\n\ 35 \ jpackage --package-type app-image -o outputdir -n name -p modulePath -m moduleName/className\n\ 36 \ To provide your own options to jlink, run jlink separately:\n\ 37 \ jlink --output appRuntimeImage -p ModulePath -m moduleName \\\n\ 38 \ --no-header-files [<additional jlink options>...]\n\ 39 \ jpackage --package-type app-image -o outputdir -n name \\\n\ 40 \ -m moduleName/className --runtime-image appRuntimeImage\n\ 41 \ Generate an application package:\n\ 42 \ jpackage --package-type <type> -o outputdir -n name \\\n\ 43 \ -p modulePath -m moduleName/className\n\ 44 \ jpackage --package-type <type> -i inputdir -o outputdir -n name \\\n\ 45 \ --main-class package.ClassName --main-jar MyJar.jar\n\ 46 \ jpackage --package-type <type> -o outputdir -n name \\\n\ 47 \ --app-image <app image dir>\n\ 48 \ Generate a Java runtime package:\n\ 49 \ jpackage -o outputdir -n name --runtime-image <runtime-image>\n\ 50 \n\ 51 Generic Options:\n\ 52 \ @<filename> \n\ 53 \ Read options and/or mode from a file \n\ 54 \ This option can be used multiple times.\n\ 55 \ --package-type <type> \n\ 56 \ The type of package to create\n\ 57 \ Valid values are: {1} \n\ 58 \ If this option is not specified a platform dependent\n\ 59 \ default package type will be created.\n\ 60 \ --app-version <version>\n\ 61 \ Version of the application and/or package\n\ 62 \ --copyright <copyright string>\n\ 63 \ Copyright for the application\n\ 64 \ --description <description string>\n\ 65 \ Description of the application\n\ 66 \ --help -h \n\ 67 \ Print the usage text with a list and description of each valid\n\ 68 \ option for the current platform to the output stream, and exit\n\ 69 \ --name -n <name>\n\ 70 \ Name of the application and/or package\n\ 71 \ --output -o <output path>\n\ 72 \ Path where generated output file is placed\n\ 73 \ (absolute path or relative to the current directory)\n\ 74 \ --temp-root <file path>\n\ 75 \ Path of a new or empty directory used to create temporary files\n\ 76 \ (absolute path or relative to the current directory)\n\ 77 \ If specified, the temp-root will not be removed upon the task\n\ 78 \ completion and must be removed manually\n\ 79 \ If not specified, a temporary directory will be created and\n\ 80 \ removed upon the task completion.\n\ 81 \ --vendor <vendor string>\n\ 82 \ Vendor of the application\n\ 83 \ --verbose\n\ 84 \ Enables verbose output\n\ 85 \ --version\n\ 86 \ Print the product version to the output stream and exit\n\ 87 \n\ 88 \Options for creating the runtime image:\n\ 89 \ --add-modules <module name>[,<module name>...]\n\ 90 \ A comma (",") separated list of modules to add.\n\ 91 \ This module list, along with the main module (if specified)\n\ 92 \ will be passed to jlink as the --add-module argument.\n\ 93 \ if not specified, either just the main module (if --module is\n\ 94 \ specified), or the default set of modules (if --main-jar is \n\ 95 \ specified) are used.\n\ 96 \ This option can be used multiple times.\n\ 97 \ --module-path -p <module path>...\n\ 98 \ A {0} separated list of paths\n\ 99 \ Each path is either a directory of modules or the path to a\n\ 100 \ modular jar.\n\ 101 \ (each path is absolute or relative to the current directory)\n\ 102 \ This option can be used multiple times.\n\ 103 \ --runtime-image <file path>\n\ 104 \ Path of the predefined runtime image that will be copied into\n\ 105 \ the application image\n\ 106 \ (absolute path or relative to the current directory)\n\ 107 \ If --runtime-image is not specified, jpackage will run jlink to\n\ 108 \ create the runtime image using options:\n\ 109 \ --strip-debug, --no-header-files, --no-man-pages, and\n\ 110 \ --strip-native-commands. --bind-services will also be added if\n\ 111 \ --add-modules is not specified.\n\ 112 \n\ 113 \Options for creating the application image:\n\ 114 \ --icon <icon file path>\n\ 115 \ Path of the icon of the application bundle\n\ 116 \ (absolute path or relative to the current directory)\n\ 117 \ --input -i <input path>\n\ 118 \ Path of the input directory that contains the files to be packaged\n\ 119 \ (absolute path or relative to the current directory)\n\ 120 \ All files in the input directory will be packaged into the\n\ 121 \ application image.\n\ 122 \n\ 123 \Options for creating the application launcher(s):\n\ 124 \ --add-launcher <launcher name>=<file path>\n\ 125 \ Name of launcher, and a path to a Properties file that contains\n\ 126 \ a list of key, value pairs\n\ 127 \ (absolute path or relative to the current directory)\n\ 128 \ The keys "module", "main-jar", "main-class",\n\ 129 \ "arguments", "java-options", "app-version", "icon", and\n\ 130 \ "win-console" can be used.\n\ 131 \ These options are added to, or used to overwrite, the original\n\ 132 \ command line options to build an additional alternative launcher.\n\ 133 \ The main application launcher will be built from the command line\n\ 134 \ options. Additional alternative launchers can be built using\n\ 135 \ this option, and this option can be used multiple times to\n\ 136 \ build multiple additional launchers. \n\ 137 \ --arguments <main class arguments>\n\ 138 \ Command line arguments to pass to the main class if no command\n\ 139 \ line arguments are given to the launcher\n\ 140 \ This option can be used multiple times.\n\ 141 \ --java-options <java options>\n\ 142 \ Options to pass to the Java runtime\n\ 143 \ This option can be used multiple times.\n\ 144 \ --main-class <class name>\n\ 145 \ Qualified name of the application main class to execute\n\ 146 \ This option can only be used if --main-jar is specified.\n\ 147 \ --main-jar <main jar file>\n\ 148 \ The main JAR of the application; containing the main class\n\ 149 \ (specified as a path relative to the input path)\n\ 150 \ Either --module or --main-jar option can be specified but not\n\ 151 \ both.\n\ 152 \ --module -m <module name>[/<main class>]\n\ 153 \ The main module (and optionally main class) of the application\n\ 154 \ This module must be located on the module path.\n\ 155 \ When this option is specified, the main module will be linked\n\ 156 \ in the Java runtime image. Either --module or --main-jar\n\ 157 \ option can be specified but not both.\n\ 158 {2}\n\ 159 \Options for creating the application package:\n\ 160 \ --app-image <file path>\n\ 161 \ Location of the predefined application image that is used\n\ 162 \ to build an installable package\n\ 163 \ (absolute path or relative to the current directory)\n\ 164 \ --file-associations <file path>\n\ 165 \ Path to a Properties file that contains list of key, value pairs\n\ 166 \ (absolute path or relative to the current directory)\n\ 167 \ The keys "extension", "mime-type", "icon", and "description"\n\ 168 \ can be used to describe the association.\n\ 169 \ This option can be used multiple times.\n\ 170 \ --identifier <id string>\n\ 171 \ An identifier that uniquely identifies the application\n\ 172 \ Defaults to the main class name.\n\ 173 \ The value should be a valid DNS name.\n\ 174 \ --install-dir <file path>\n\ 175 \ {4}\ 176 \ --license-file <file path>\n\ 177 \ Path to the license file\n\ 178 \ (absolute path or relative to the current directory)\n\ 179 \ --resource-dir <path>\n\ 180 \ Path to override jpackage resources\n\ 181 \ Icons, template files, and other resources of jpackage can be\n\ 182 \ over-ridden by adding replacement resources to this directory.\n\ 183 \ (absolute path or relative to the current directory)\n\ 184 \ --runtime-image <file-path>\n\ 185 \ Path of the predefined runtime image to install\n\ 186 \ (absolute path or relative to the current directory)\n\ 187 \ Option is required when creating a runtime package.\n\ 188 \n\ 189 \Platform dependent options for creating the application package:\n\ 190 {3} 191 192 MSG_Help_win_launcher=\ 193 \n\ 194 \Platform dependent option for creating the application launcher:\n\ 195 \ --win-console\n\ 196 \ Creates a console launcher for the application, should be\n\ 197 \ specified for application which requires console interactions\n\ 198 199 MSG_Help_win_install=\ 200 \ --win-dir-chooser\n\ 201 \ Adds a dialog to enable the user to choose a directory in which\n\ 202 \ the product is installed\n\ 203 \ --win-menu\n\ 204 \ Adds the application to the system menu\n\ 205 \ --win-menu-group <menu group name>\n\ 206 \ Start Menu group this application is placed in\n\ 207 \ --win-per-user-install\n\ 208 \ Request to perform an install on a per-user basis\n\ 209 \ --win-shortcut\n\ 210 \ Creates a desktop shortcut for the application\n\ 211 \ --win-upgrade-uuid <id string>\n\ 212 \ UUID associated with upgrades for this package\n\ 213 214 MSG_Help_win_install_dir=\ 215 \Relative sub-path under the default installation location\n\ 216 217 MSG_Help_mac_launcher=\ 218 \ --mac-bundle-identifier <ID string>\n\ 219 \ An identifier that uniquely identifies the application for macOS\n\ 220 \ Defaults to the value of --identifier option.\n\ 221 \ May only use alphanumeric (A-Z,a-z,0-9), hyphen (-),\n\ 222 \ and period (.) characters.\n\ 223 \ --mac-bundle-name <name string>\n\ 224 \ Name of the application as it appears in the Menu Bar\n\ 225 \ This can be different from the application name.\n\ 226 \ This name must be less than 16 characters long and be suitable for\n\ 227 \ displaying in the menu bar and the application Info window.\n\ 228 \ Defaults to the application name.\n\ 229 \ --mac-bundle-signing-prefix <prefix string>\n\ 230 \ When signing the application bundle, this value is prefixed to all\n\ 231 \ components that need to be signed that don't have\n\ 232 \ an existing bundle identifier.\n\ 233 \ --mac-sign\n\ 234 \ Request that the bundle be signed\n\ 235 \ --mac-signing-keychain <file path>\n\ 236 \ Path of the keychain to search for the signing identity\n\ 237 \ (absolute path or relative to the current directory).\n\ 238 \ If not specified, the standard keychains are used.\n\ 239 \ --mac-signing-key-user-name <team name>\n\ 240 \ Team name portion in Apple signing identities' names.\n\ 241 \ For example "Developer ID Application: "\n\ 242 243 MSG_Help_linux_install=\ 244 \ --linux-bundle-name <bundle name>\n\ 245 \ Name for Linux bundle, defaults to the application name\n\ 246 \ --linux-deb-maintainer <email address>\n\ 247 \ Maintainer for .deb bundle\n\ 248 \ --linux-deb-copyright-file <file path>\n\ 249 \ Path to custom copyright file for Debian packaging\n\ 250 \ (absolute path or relative to the current directory)\n\ 251 \ --linux-menu-group <menu-group-name>\n\ 252 \ Menu group this application is placed in\n\ 253 \ --linux-package-deps\n\ 254 \ Required packages or capabilities for the application\n\ 255 \ --linux-rpm-license-type <type string>\n\ 256 \ Type of the license ("License: <value>" of the RPM .spec)\n\ 257 \ --linux-app-release <release value>\n\ 258 \ Release value of the RPM <name>.spec file or \n\ 259 \ Debian revision value of the DEB control file.\n\ 260 \ --linux-app-category <category value>\n\ 261 \ Group value of the RPM <name>.spec file or \n\ 262 \ Section value of DEB control file.\n\ 263 264 MSG_Help_mac_linux_install_dir=\ 265 \Absolute path of the installation directory of the application\n\ 266 267 MSG_Help_default_install_dir=\ 268 \Absolute path of the installation directory of the application on OS X\n\ 269 \ or Linux. Relative sub-path of the installation location of the application\n\ 270 \ such as "Program Files" or "AppData" on Windows.\n\ 271 272 MSG_Help_no_args=Usage: jpackage <mode> <options>\n\ 273 \Use jpackage --help (or -h) for a list of possible options\ 274