author | herrick |
Mon, 11 Mar 2019 15:15:16 -0400 | |
branch | JDK-8200758-branch |
changeset 57257 | 69ad9df313e4 |
parent 57213 | 8ff0a29bf9bc |
child 57261 | 13b6672477df |
permissions | -rw-r--r-- |
56986 | 1 |
# |
57106
ea870b9ce89a
8216492: Update copyright of all new jpackage fils to 2019
kcr
parents:
57099
diff
changeset
|
2 |
# Copyright (c) 2017, 2019, Oracle and/or its affiliates. All rights reserved. |
56986 | 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 |
||
57257 | 27 |
MSG_Help=Usage: jpackage <mode> <options>\n\ |
56986 | 28 |
\n\ |
29 |
where mode is one of: \n\ |
|
30 |
\ create-image\n\ |
|
31 |
\ Generates a platform-specific application image.\n\ |
|
57150 | 32 |
\ create-installer\n\ |
56986 | 33 |
\ Generates a platform-specific installer for the application.\n\ |
34 |
\ \n\ |
|
35 |
Sample usages:\n\ |
|
36 |
--------------\n\ |
|
57150 | 37 |
\ Generate a modular application image:\n\ |
57257 | 38 |
\ jpackage create-image -o outputdir -n name \\\n\ |
39 |
\ -m moduleName/className -p modulePath\n\ |
|
40 |
\ To provide your own options to jlink, run jlink separately:\n\ |
|
41 |
\ jlink --output app.runtime -m moduleName -p modulePath \\\n\ |
|
42 |
\ --no-header-files [<additional jlink options>...]\n\ |
|
43 |
\ jpackage -o outputdir -n name -m moduleName/className \\\n\ |
|
44 |
\ --runtime-image app-runtime\n\ |
|
57150 | 45 |
\ Generate a non-modular application image:\n\ |
57257 | 46 |
\ jpackage create-image -o outputdir -i inputdir -n name \\\n\ |
47 |
\ --main-class className --main-jar MyJar.jar\n\ |
|
57071 | 48 |
\ Generate an application installer:\n\ |
57257 | 49 |
\ jpackage create-installer -o outputdir -n name \\\n\ |
50 |
\ -m moduleName/className -p modulePath\n\ |
|
51 |
\ jpackage create-installer -i inputdir -o outputdir -n name \\\n\ |
|
52 |
\ --main-class package.ClassName --main-jar MyJar.jar\n\ |
|
53 |
\ jpackage create-installer -o outputdir -n <installer-name> \\\n\ |
|
54 |
\ --app-image <app image dir> [--installer-type <type>]\n\ |
|
57150 | 55 |
\ Generate a Java runtime installer:\n\ |
57257 | 56 |
\ jpackage create-installer -o outputdir -n name \\\n\ |
57 |
\ --runtime-image <runtime-image>\n\ |
|
56986 | 58 |
\n\ |
57257 | 59 |
Generic Options:\n\ |
57060 | 60 |
\ @<filename> \n\ |
57257 | 61 |
\ --app-version <version>\n\ |
62 |
\ Version of the application and/or installer\n\ |
|
57071 | 63 |
\ Read options and/or mode from a file \n\ |
57257 | 64 |
\ --copyright <copyright string>\n\ |
65 |
\ Copyright for the application\n\ |
|
66 |
\ --description <description string>\n\ |
|
67 |
\ Description of the application\n\ |
|
56986 | 68 |
\ --help -h \n\ |
57071 | 69 |
\ Print the usage text with a list and description of each valid\n\ |
70 |
\ option for the current platform to the output stream, and exit\n\ |
|
57257 | 71 |
\ --name -n <name>\n\ |
72 |
\ Name of the application and/or installer\n\ |
|
57078
db003bfc5bf7
JDK-8215453: remove unused BundlerParams and fix misleading messages
herrick
parents:
57071
diff
changeset
|
73 |
\ --output -o <output path>\n\ |
db003bfc5bf7
JDK-8215453: remove unused BundlerParams and fix misleading messages
herrick
parents:
57071
diff
changeset
|
74 |
\ Path where generated output file is placed\n\ |
db003bfc5bf7
JDK-8215453: remove unused BundlerParams and fix misleading messages
herrick
parents:
57071
diff
changeset
|
75 |
\ (absolute path or relative to the current directory)\n\ |
57257 | 76 |
\ --temp-root <file path>\n\ |
77 |
\ Path of a new or empty directory used to create temporary files\n\ |
|
57078
db003bfc5bf7
JDK-8215453: remove unused BundlerParams and fix misleading messages
herrick
parents:
57071
diff
changeset
|
78 |
\ (absolute path or relative to the current directory)\n\ |
57257 | 79 |
\ If specified, the temp-root will not be removed upon the task\n\ |
80 |
\ completion and must be removed manually\n\ |
|
81 |
\ If not specified, a temporary directory will be created and\n\ |
|
82 |
\ removed upon the task completion.\n\ |
|
83 |
\ --vendor <vendor string>\n\ |
|
84 |
\ Vendor of the application\n\ |
|
85 |
\ --verbose\n\ |
|
86 |
\ Enables verbose output\n\ |
|
87 |
\ --version -v\n\ |
|
88 |
\ Print the product version to the output stream and exit\n\ |
|
89 |
\n\ |
|
90 |
\Options for creating the runtime image:\n\ |
|
91 |
\ --add-modules <module name>[,<module name>...]\n\ |
|
92 |
\ A comma (",") separated list of modules to add.\n\ |
|
93 |
\ This module list, along with the main module (if specified)\n\ |
|
94 |
\ will be passed to jlink as the --add-module argument.\n\ |
|
95 |
\ if not specified, either just the main module (if --module is\n\ |
|
96 |
\ specified), or the default set of modules (if --main-jar is \n\ |
|
97 |
\ specified) are used.\n\ |
|
98 |
\ --module-path -p <module path>...\n\ |
|
99 |
\ A {0} separated list of paths\n\ |
|
100 |
\ Each path is either a directory of modules or the path to a\n\ |
|
101 |
\ modular jar.\n\ |
|
102 |
\ (each path is absolute or relative to the current directory)\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\ |
|
57180 | 114 |
\ --files -f <input file>[{0}<input file>...]\n\ |
57071 | 115 |
\ A {0} separated list of files in the input dir to be packaged\n\ |
57025 | 116 |
\ If omitted, all files in the input directory will be packaged.\n\ |
57078
db003bfc5bf7
JDK-8215453: remove unused BundlerParams and fix misleading messages
herrick
parents:
57071
diff
changeset
|
117 |
\ --icon <icon file path>\n\ |
db003bfc5bf7
JDK-8215453: remove unused BundlerParams and fix misleading messages
herrick
parents:
57071
diff
changeset
|
118 |
\ Path of the icon of the application bundle\n\ |
db003bfc5bf7
JDK-8215453: remove unused BundlerParams and fix misleading messages
herrick
parents:
57071
diff
changeset
|
119 |
\ (absolute path or relative to the current directory)\n\ |
57257 | 120 |
\ --input -i <input path>\n\ |
121 |
\ Path of the input directory that contains the files to be packaged\n\ |
|
122 |
\ (absolute path or relative to the current directory)\n\ |
|
123 |
\n\ |
|
124 |
\Options for creating the application launcher(s):\n\ |
|
125 |
\ --add-launcher <file path>\n\ |
|
126 |
\ Path to a Properties file that contains list of key, value pairs\n\ |
|
127 |
\ (absolute path or relative to the current directory)\n\ |
|
128 |
\ The keys "name" (required), "module", "add-modules",\n\ |
|
129 |
\ "main-jar", "main-class", "arguments", "jvm-args",\n\ |
|
130 |
\ "app-version", "icon", and "win-console" can be used.\n\ |
|
131 |
\ These options are added to, or used to overwrite, the original\n\ |
|
132 |
\ command line options when building an additional launcher.\n\ |
|
133 |
\ --arguments <main class arguments>\n\ |
|
134 |
\ Command line arguments to pass to the main class if no command\n\ |
|
135 |
\ line arguments are given to the launcher\n\ |
|
56986 | 136 |
\ --jvm-args <java vm arguments>\n\ |
57180 | 137 |
\ Java arguments to pass to the virtual machine\n\ |
57257 | 138 |
\ --main-class <class name>\n\ |
139 |
\ Qualified name of the application main class to execute\n\ |
|
140 |
\ This option can only be used if --main-jar is specified.\n\ |
|
141 |
\ --main-jar <main jar file>\n\ |
|
142 |
\ The main JAR of the application; containing the main class\n\ |
|
143 |
\ (specified as a path relative to the input path)\n\ |
|
144 |
\ Either --module or --main-jar option can be specified but not\n\ |
|
145 |
\ both.\n\ |
|
146 |
\ --module -m <module name>[/<main class>]\n\ |
|
147 |
\ The main module (and optionally main class) of the application\n\ |
|
148 |
\ This module must be located on the module path.\n\ |
|
149 |
\ When this option is specified, the main module will be linked\n\ |
|
150 |
\ in the Java runtime image. Either --module or --main-jar\n\ |
|
151 |
\ option can be specified but not both.\n\ |
|
152 |
{2}\n\ |
|
153 |
\Options for creating the application installer(s):\n\ |
|
154 |
\ --app-image <file path>\n\ |
|
155 |
\ Location of the predefined application image that is used\n\ |
|
156 |
\ to build an installable package\n\ |
|
157 |
\ (absolute path or relative to the current directory)\n\ |
|
158 |
\ See the create-image mode options to create the application image.\n\ |
|
56986 | 159 |
\ --file-associations <file path>\n\ |
57078
db003bfc5bf7
JDK-8215453: remove unused BundlerParams and fix misleading messages
herrick
parents:
57071
diff
changeset
|
160 |
\ Path to a Properties file that contains list of key, value pairs\n\ |
db003bfc5bf7
JDK-8215453: remove unused BundlerParams and fix misleading messages
herrick
parents:
57071
diff
changeset
|
161 |
\ (absolute path or relative to the current directory)\n\ |
db003bfc5bf7
JDK-8215453: remove unused BundlerParams and fix misleading messages
herrick
parents:
57071
diff
changeset
|
162 |
\ The keys "extension", "mime-type", "icon", and "description"\n\ |
db003bfc5bf7
JDK-8215453: remove unused BundlerParams and fix misleading messages
herrick
parents:
57071
diff
changeset
|
163 |
\ can be used to describe the association.\n\ |
57257 | 164 |
\ --identifier <id string>\n\ |
165 |
\ Machine readable identifier of the application\n\ |
|
166 |
\ The format must be a DNS name in reverse order,\n\ |
|
167 |
\ such as com.example.myapplication.\n\ |
|
56986 | 168 |
\ --install-dir <file path>\n\ |
57078
db003bfc5bf7
JDK-8215453: remove unused BundlerParams and fix misleading messages
herrick
parents:
57071
diff
changeset
|
169 |
\ Absolute path of the installation directory of the application\n\ |
57257 | 170 |
\ --installer-type <type> \n\ |
171 |
\ The type of the installer to create\n\ |
|
172 |
\ Valid values are: {1} \n\ |
|
173 |
\ If this option is not specified (in create-installer mode) all\n\ |
|
174 |
\ supported types of installable packages for the current\n\ |
|
175 |
\ platform will be created.\n\ |
|
57080 | 176 |
\ --license-file <file path>\n\ |
177 |
\ Path to the license file\n\ |
|
178 |
\ (absolute path or relative to the current directory)\n\ |
|
57091
06bc4bd64599
8215515: Add a command line option to override internal resources.
herrick
parents:
57080
diff
changeset
|
179 |
\ --resource-dir <path>\n\ |
06bc4bd64599
8215515: Add a command line option to override internal resources.
herrick
parents:
57080
diff
changeset
|
180 |
\ Path to override jpackage resources\n\ |
06bc4bd64599
8215515: Add a command line option to override internal resources.
herrick
parents:
57080
diff
changeset
|
181 |
\ Icons, template files, and other resources of jpackage can be\n\ |
06bc4bd64599
8215515: Add a command line option to override internal resources.
herrick
parents:
57080
diff
changeset
|
182 |
\ over-ridden by adding replacement resources to this directory.\n\ |
06bc4bd64599
8215515: Add a command line option to override internal resources.
herrick
parents:
57080
diff
changeset
|
183 |
\ (absolute path or relative to the current directory)\n\ |
57257 | 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 installer.\n\ |
|
56986 | 188 |
\n\ |
57257 | 189 |
\Platform dependent options for creating the application installer(s):\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\ |
|
56986 | 198 |
|
57257 | 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-registry-name <registry name>\n\ |
|
210 |
\ Name of the application for registry references.\n\ |
|
211 |
\ The default is the Application Name with only\n\ |
|
212 |
\ alphanumerics, dots, and dashes (no whitespace)\n\ |
|
213 |
\ --win-shortcut\n\ |
|
214 |
\ Creates a desktop shortcut for the application\n\ |
|
215 |
\ --win-upgrade-uuid <id string>\n\ |
|
216 |
\ UUID associated with upgrades for this package\n\ |
|
217 |
||
218 |
MSG_Help_mac_install=\ |
|
219 |
\ --mac-bundle-identifier <ID string>\n\ |
|
220 |
\ An identifier that uniquely identifies the application for MacOSX\n\ |
|
221 |
\ (and on the Mac App Store)\n\ |
|
222 |
\ May only use alphanumeric (A-Z,a-z,0-9), hyphen (-),\n\ |
|
223 |
\ and period (.) characters.\n\ |
|
56986 | 224 |
\ --mac-bundle-name <name string>\n\ |
57071 | 225 |
\ Name of the application as it appears in the Menu Bar\n\ |
226 |
\ This can be different from the application name.\n\ |
|
227 |
\ This name must be less than 16 characters long and be suitable for\n\ |
|
228 |
\ displaying in the menu bar and the application Info window.\n\ |
|
229 |
\ Defaults to the application name.\n\ |
|
56986 | 230 |
\ --mac-bundle-signing-prefix <prefix string>\n\ |
231 |
\ When signing the application bundle, this value is prefixed to all\n\ |
|
57071 | 232 |
\ components that need to be signed that don't have\n\ |
233 |
\ an existing bundle identifier.\n\ |
|
57257 | 234 |
\ --mac-sign\n\ |
235 |
\ Request that the bundle be signed\n\ |
|
56986 | 236 |
\ --mac-signing-keychain <file path>\n\ |
57078
db003bfc5bf7
JDK-8215453: remove unused BundlerParams and fix misleading messages
herrick
parents:
57071
diff
changeset
|
237 |
\ Path of the keychain to use\n\ |
db003bfc5bf7
JDK-8215453: remove unused BundlerParams and fix misleading messages
herrick
parents:
57071
diff
changeset
|
238 |
\ (absolute path or relative to the current directory)\n\ |
57071 | 239 |
\ If not specified, the standard keychains are used.\n\ |
57257 | 240 |
\ --mac-signing-key-user-name <user name>\n\ |
241 |
\ User name portion of the typical\n\ |
|
242 |
\ "Mac Developer ID Application: <user name>" signing key\n\ |
|
56986 | 243 |
|
57257 | 244 |
MSG_Help_linux_install=\ |
56986 | 245 |
\ --linux-bundle-name <bundle name>\n\ |
57071 | 246 |
\ Name for Linux bundle, defaults to the application name\n\ |
57257 | 247 |
\ --linux-deb-maintainer <email address>\n\ |
248 |
\ Maintainer for .deb bundle\n\ |
|
249 |
\ --linux-menu-group <menu-group-name>\n\ |
|
250 |
\ Menu group this application is placed in\n\ |
|
56986 | 251 |
\ --linux-package-deps\n\ |
57071 | 252 |
\ Required packages or capabilities for the application\n\ |
56986 | 253 |
\ --linux-rpm-license-type <type string>\n\ |
57071 | 254 |
\ Type of the license ("License: <value>" of the RPM .spec)\n\ |
57022
81021f910bc2
8213333: Fix issues found in jpackager with automated tests
herrick
parents:
57021
diff
changeset
|
255 |
|
57039 | 256 |
MSG_Help_no_args=Usage: jpackage <mode> <options>\n\ |
57071 | 257 |
\Use jpackage --help (or -h) for a list of possible options\ |
258 |