aboutsummaryrefslogtreecommitdiffhomepage
path: root/src/jdk.jpackage/share/classes/jdk/jpackage/internal/resources/HelpResources.properties
blob: 9160761eedec23148e4dd5f77f60273df1aa53e2 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
#
# Copyright (c) 2017, 2021, Oracle and/or its affiliates. All rights reserved.
# DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
#
# This code is free software; you can redistribute it and/or modify it
# under the terms of the GNU General Public License version 2 only, as
# published by the Free Software Foundation.  Oracle designates this
# particular file as subject to the "Classpath" exception as provided
# by Oracle in the LICENSE file that accompanied this code.
#
# This code is distributed in the hope that it will be useful, but WITHOUT
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
# version 2 for more details (a copy is included in the LICENSE file that
# accompanied this code).
#
# You should have received a copy of the GNU General Public License version
# 2 along with this work; if not, write to the Free Software Foundation,
# Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
#
# Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
# or visit www.oracle.com if you need additional information or have any
# questions.
#
#

MSG_Help=Usage: jpackage <options>\n\
\n\
Sample usages:\n\
--------------\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 \\\n\
\                --add-modules moduleName \\\n\
\                --no-header-files [<additional jlink options>...]\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 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 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 <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 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\
\  --verbose\n\
\          Enables verbose output\n\
\  --version\n\
\          Print the product version to the output stream and exit\n\
\n\
\Options for creating the runtime image:\n\
\  --add-modules <module name>[,<module name>...]\n\
\          A comma (",") separated list of modules to add.\n\
\          This module list, along with the main module (if specified)\n\
\          will be passed to jlink as the --add-module argument.\n\
\          if not specified, either just the main module (if --module is\n\
\          specified), or the default set of modules (if --main-jar is \n\
\          specified) are used.\n\
\          This option can be used multiple times.\n\
\  --module-path -p <module path>...\n\
\          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\
\  --jlink-options <jlink options> \n\
\          A space separated list of options to pass to jlink \n\
\          If not specified, defaults to "--strip-native-commands \n\
\          --strip-debug --no-man-pages --no-header-files" \n\
\          This option can be used multiple times.\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.\n\
\n\
\Options for creating the application image:\n\
\  --icon <icon file path>\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\
\          application image.\n\
\n\
\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", "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\
\          options. Additional alternative launchers can be built using\n\
\          this option, and this option can be used multiple times to\n\
\          build multiple additional launchers. \n\
\  --arguments <main class arguments>\n\
\          Command line arguments to pass to the main class if no command\n\
\          line arguments are given to the launcher\n\
\          This option can be used multiple times.\n\
\  --java-options <java options>\n\
\          Options to pass to the Java runtime\n\
\          This option can be used multiple times.\n\
\  --main-class <class name>\n\
\          Qualified name of the application main class to execute\n\
\          This option can only be used if --main-jar is specified.\n\
\  --main-jar <main jar file>\n\
\          The main JAR of the application; containing the main class\n\
\          (specified as a path relative to the input path)\n\
\          Either --module or --main-jar option can be specified but not\n\
\          both.\n\
\  --module -m <module name>[/<main class>]\n\
\          The main module (and optionally main class) of the application\n\
\          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 package:\n\
\  --about-url <url>\n\
\          URL of the application's home page\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\
\  --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\
\  --install-dir <file path>\n\
\          {4}\
\  --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\
\          Icons, template files, and other resources of jpackage can be\n\
\          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 package.\n\
\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\
\  --win-console\n\
\          Creates a console launcher for the application, should be\n\
\          specified for application which requires console interactions\n\

MSG_Help_win_install=\
\  --win-dir-chooser\n\
\          Adds a dialog to enable the user to choose a directory in which\n\
\          the product is installed\n\
\  --win-help-url <url>\n\
\          URL where user can obtain further information or technical support\n\
\  --win-menu\n\
\          Request to add a Start menu shortcut for this application\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-shortcut\n\
\          Request to add desktop shortcut for this application\n\
\  --win-shortcut-prompt\n\
\          Adds a dialog to enable the user to choose if shortcuts\n\
\          will be created by installer\n\
\  --win-update-url <url>\n\
\          URL of available application update information\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-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-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-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 package be signed\n\
\  --mac-signing-keychain <file path>\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 <team name>\n\
\          Team or user name portion of Apple signing identities.\n\
\  --mac-app-store\n\
\          Indicates that the jpackage output is intended for the\n\
\          Mac App Store.\n\
\  --mac-entitlements <file path>\n\
\          Path to file containing entitlements to use when signing\n\
\          executables and libraries in the bundle.\n\
\  --mac-app-category <category string>\n\
\          String used to construct LSApplicationCategoryType in\n\
\          application plist.  The default value is "utilities".\n\

MSG_Help_linux_install=\
\  --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 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\n\
\          the application such as "Program Files" or "AppData" on Windows.\n\

MSG_Help_no_args=Usage: jpackage <options>\n\
\Use jpackage --help (or -h) for a list of possible options\