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 <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 -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\
45 \ Generate a non-modular application image:\n\
46 \ jpackage create-image -o outputdir -i inputdir -n name \\\n\
47 \ --main-class className --main-jar MyJar.jar\n\
48 \ Generate an application installer:\n\
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\
55 \ Generate a Java runtime installer:\n\
56 \ jpackage create-installer -o outputdir -n name \\\n\
57 \ --runtime-image <runtime-image>\n\
58 \n\
59 Generic Options:\n\
60 \ @<filename> \n\
61 \ --app-version <version>\n\
62 \ Version of the application and/or installer\n\
63 \ Read options and/or mode from a file \n\
64 \ --copyright <copyright string>\n\
65 \ Copyright for the application\n\
66 \ --description <description string>\n\
67 \ Description of the application\n\
68 \ --help -h \n\
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\
71 \ --name -n <name>\n\
72 \ Name of the application and/or installer\n\
73 \ --output -o <output path>\n\
74 \ Path where generated output file is placed\n\
75 \ (absolute path or relative to the current directory)\n\
76 \ --temp-root <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-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\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\
114 \ --files -f <input file>[{0}<input file>...]\n\
115 \ A {0} separated list of files in the input dir to be packaged\n\
116 \ If omitted, all files in the input directory will be packaged.\n\
117 \ --icon <icon file path>\n\
118 \ Path of the icon of the application bundle\n\
119 \ (absolute path or relative to the current directory)\n\
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\
136 \ --jvm-args <java vm arguments>\n\
137 \ Java arguments to pass to the virtual machine\n\
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\
159 \ --file-associations <file path>\n\
160 \ Path to a Properties file that contains list of key, value pairs\n\
161 \ (absolute path or relative to the current directory)\n\
162 \ The keys "extension", "mime-type", "icon", and "description"\n\
163 \ can be used to describe the association.\n\
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\
168 \ --install-dir <file path>\n\
169 \ {4}\
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\
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 installer.\n\
188 \n\
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\
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-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_win_install_dir=\
219 \Relative sub-path of the installation location of the application such as\n\
220 \ "Program Files" or "AppData"\n\
221
222 MSG_Help_mac_install=\
223 \ --mac-bundle-identifier <ID string>\n\
224 \ An identifier that uniquely identifies the application for MacOSX\n\
225 \ (and on the Mac App Store)\n\
226 \ May only use alphanumeric (A-Z,a-z,0-9), hyphen (-),\n\
227 \ and period (.) characters.\n\
228 \ --mac-bundle-name <name string>\n\
229 \ Name of the application as it appears in the Menu Bar\n\
230 \ This can be different from the application name.\n\
231 \ This name must be less than 16 characters long and be suitable for\n\
232 \ displaying in the menu bar and the application Info window.\n\
233 \ Defaults to the application name.\n\
234 \ --mac-bundle-signing-prefix <prefix string>\n\
235 \ When signing the application bundle, this value is prefixed to all\n\
236 \ components that need to be signed that don't have\n\
237 \ an existing bundle identifier.\n\
238 \ --mac-sign\n\
239 \ Request that the bundle be signed\n\
240 \ --mac-signing-keychain <file path>\n\
241 \ Path of the keychain to use\n\
242 \ (absolute path or relative to the current directory)\n\
243 \ If not specified, the standard keychains are used.\n\
244 \ --mac-signing-key-user-name <user name>\n\
245 \ User name portion of the typical\n\
246 \ "Mac Developer ID Application: <user name>" signing key\n\
247
248 MSG_Help_linux_install=\
249 \ --linux-bundle-name <bundle name>\n\
250 \ Name for Linux bundle, defaults to the application name\n\
251 \ --linux-deb-maintainer <email address>\n\
252 \ Maintainer for .deb bundle\n\
253 \ --linux-menu-group <menu-group-name>\n\
254 \ Menu group this application is placed in\n\
255 \ --linux-package-deps\n\
256 \ Required packages or capabilities for the application\n\
257 \ --linux-rpm-license-type <type string>\n\
258 \ Type of the license ("License: <value>" of the RPM .spec)\n\
259
260 MSG_Help_mac_linux_install_dir=\
261 \Absolute path of the installation directory of the application\n\
262
263 MSG_Help_default_install_dir=\
264 \Absolute path of the installation directory of the application on OS X\n\
265 \ or Linux. Relative sub-path of the installation location of the application\n\
266 \ such as "Program Files" or "AppData" on Windows.\n\
267
268 MSG_Help_no_args=Usage: jpackage <mode> <options>\n\
269 \Use jpackage --help (or -h) for a list of possible options\
270