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