22 # or visit www.oracle.com if you need additional information or have any |
22 # or visit www.oracle.com if you need additional information or have any |
23 # questions. |
23 # questions. |
24 # |
24 # |
25 # |
25 # |
26 |
26 |
27 MSG_Help_common=Usage: jpackage <mode> <options>\n\ |
27 MSG_Help=Usage: jpackage <mode> <options>\n\ |
28 \n\ |
28 \n\ |
29 where mode is one of: \n\ |
29 where mode is one of: \n\ |
30 \ create-image\n\ |
30 \ create-image\n\ |
31 \ Generates a platform-specific application image.\n\ |
31 \ Generates a platform-specific application image.\n\ |
32 \ create-installer\n\ |
32 \ create-installer\n\ |
33 \ Generates a platform-specific installer for the application.\n\ |
33 \ Generates a platform-specific installer for the application.\n\ |
34 \ \n\ |
34 \ \n\ |
35 Sample usages:\n\ |
35 Sample usages:\n\ |
36 --------------\n\ |
36 --------------\n\ |
37 \ Generate a modular application image:\n\ |
37 \ Generate a modular application image:\n\ |
38 \ jpackage create-image --output outputdir --name AppName \\\n\ |
38 \ jpackage create-image -o outputdir -n name \\\n\ |
39 \ --main-class package.ClassName --module moduleName -p modulePath\n\ |
39 \ -m moduleName/className -p modulePath\n\ |
40 \ jpackage create-image --o outputdir -n AppName \\\n\ |
40 \ To provide your own options to jlink, run jlink separately:\n\ |
41 \ -c package.ClassName -m moduleName -p modulePath\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\ |
42 \ Generate a non-modular application image:\n\ |
45 \ Generate a non-modular application image:\n\ |
43 \ jpackage create-image --input inputdir --output outputdir \\\n\ |
46 \ jpackage create-image -o outputdir -i inputdir -n name \\\n\ |
44 \ --name AppName --main-class package.ClassName --main-jar MyJar.jar\n\ |
47 \ --main-class className --main-jar MyJar.jar\n\ |
45 \ jpackage create-image -i inputdir -o outputdir -n AppName \\\n\ |
|
46 \ -c package.ClassName -j MyJar.jar\n\ |
|
47 \ Generate an application installer:\n\ |
48 \ Generate an application installer:\n\ |
48 \ jpackage create-installer -i inputdir -o outputdir \\\n\ |
49 \ jpackage create-installer -o outputdir -n name \\\n\ |
49 \ -n <installer-name> -c package.ClassName -j MyJar.jar\n\ |
50 \ -m moduleName/className -p modulePath\n\ |
50 \ jpackage create-installer -o outputdir -n <installer-name>\\\n\ |
51 \ jpackage create-installer -i inputdir -o outputdir -n name \\\n\ |
51 \ --app-image <app image dir>\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\ |
52 \ Generate a Java runtime installer:\n\ |
55 \ Generate a Java runtime installer:\n\ |
53 \ jpackage create-installer --runtime-installer\\\n\ |
56 \ jpackage create-installer -o outputdir -n name \\\n\ |
54 \ --name <installer-name> --output outputdir\n\ |
57 \ --runtime-image <runtime-image>\n\ |
55 \ jpackage create-installer --runtime-installer \\\n\ |
58 \n\ |
56 \ -n <installer-name> -o outputdir --runtime-image <runtime-path>\n\ |
59 Generic Options:\n\ |
57 \n\ |
|
58 The following options are valid for all platforms:\n\ |
|
59 \ @<filename> \n\ |
60 \ @<filename> \n\ |
|
61 \ --app-version <version>\n\ |
|
62 \ Version of the application and/or installer\n\ |
60 \ Read options and/or mode from a file \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\ |
61 \ --help -h \n\ |
68 \ --help -h \n\ |
62 \ Print the usage text with a list and description of each valid\n\ |
69 \ Print the usage text with a list and description of each valid\n\ |
63 \ option for the current platform to the output stream, and exit\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\ |
64 \ --version -v\n\ |
87 \ --version -v\n\ |
65 \ Print the product version to the output stream and exit\n\ |
88 \ Print the product version to the output stream and exit\n\ |
66 \ --output -o <output path>\n\ |
89 \n\ |
67 \ Path where generated output file is placed\n\ |
90 \Options for creating the runtime image:\n\ |
68 \ (absolute path or relative to the current directory)\n\ |
91 \ --add-modules <module name>[,<module name>...]\n\ |
69 \ --input -i <input path>\n\ |
92 \ A comma (",") separated list of modules to add.\n\ |
70 \ Path of the input directory that contains the files to package\n\ |
93 \ This module list, along with the main module (if specified)\n\ |
71 \ (absolute path or relative to the current directory)\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\ |
72 \ --files -f <input file>[{0}<input file>...]\n\ |
114 \ --files -f <input file>[{0}<input file>...]\n\ |
73 \ A {0} separated list of files in the input dir to be packaged\n\ |
115 \ A {0} separated list of files in the input dir to be packaged\n\ |
74 \ If omitted, all files in the input directory will be packaged.\n\ |
116 \ If omitted, all files in the input directory will be packaged.\n\ |
75 \ --name -n <application name>\n\ |
117 \ --icon <icon file path>\n\ |
76 \ Name of the application\n\ |
118 \ Path of the icon of the application bundle\n\ |
77 \ --main-jar -j <main jar file>\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\ |
78 \ The main JAR of the application; containing the main class\n\ |
142 \ The main JAR of the application; containing the main class\n\ |
79 \ (specified as a path relative to the input path)\n\ |
143 \ (specified as a path relative to the input path)\n\ |
80 \ --main-class -c <class name>\n\ |
144 \ Either --module or --main-jar option can be specified but not\n\ |
81 \ Qualified name of the application main class to execute\n\ |
145 \ both.\n\ |
82 \ --installer-type <type> \n\ |
146 \ --module -m <module name>[/<main class>]\n\ |
83 \ The type of the installer created in create-image mode\n\ |
147 \ The main module (and optionally main class) of the application\n\ |
84 \ Valid values for "type" are "msi", "exe", "rpm", "deb", "dmg",\n\ |
148 \ This module must be located on the module path.\n\ |
85 \ "pkg", and "pkg-app-store".\n\ |
149 \ When this option is specified, the main module will be linked\n\ |
86 \ If this option is not specified (in create-installer mode),\n\ |
150 \ in the Java runtime image. Either --module or --main-jar\n\ |
87 \ all supported types of installable packages for the current\n\ |
151 \ option can be specified but not both.\n\ |
88 \ platform will be generated.\n\ |
152 {2}\n\ |
89 \ --runtime-installer \n\ |
153 \Options for creating the application installer(s):\n\ |
90 \ Generates a platform-specific installer for a Java runtime.\n\ |
154 \ --app-image <file path>\n\ |
91 \ --app-version <version string>\n\ |
155 \ Location of the predefined application image that is used\n\ |
92 \ Version of the application\n\ |
156 \ to build an installable package\n\ |
93 \ --arguments -a <main class arguments>\n\ |
157 \ (absolute path or relative to the current directory)\n\ |
94 \ Command line arguments to pass to the main class if no command\n\ |
158 \ See the create-image mode options to create the application image.\n\ |
95 \ line arguments are given to the launcher\n\ |
159 \ --file-associations <file path>\n\ |
96 \ --icon <icon file path>\n\ |
160 \ Path to a Properties file that contains list of key, value pairs\n\ |
97 \ Path of the icon of the application bundle\n\ |
161 \ (absolute path or relative to the current directory)\n\ |
98 \ (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\ |
99 \ --identifier <id string>\n\ |
164 \ --identifier <id string>\n\ |
100 \ Machine readable identifier of the application\n\ |
165 \ Machine readable identifier of the application\n\ |
101 \ The format must be a DNS name in reverse order,\n\ |
166 \ The format must be a DNS name in reverse order,\n\ |
102 \ such as com.example.myapplication.\n\ |
167 \ such as com.example.myapplication.\n\ |
103 \ --verbose\n\ |
|
104 \ Enables verbose output\n\ |
|
105 \ --strip-native-commands\n\ |
|
106 \ Removes native executables from the custom run-time images\n\ |
|
107 \ --jvm-args <java vm arguments>\n\ |
|
108 \ Java arguments to pass to the virtual machine\n\ |
|
109 \ --file-associations <file path>\n\ |
|
110 \ Path to a Properties file that contains list of key, value pairs\n\ |
|
111 \ (absolute path or relative to the current directory)\n\ |
|
112 \ The keys "extension", "mime-type", "icon", and "description"\n\ |
|
113 \ can be used to describe the association.\n\ |
|
114 \ --secondary-launcher <file path>\n\ |
|
115 \ Path to a Properties file that contains list of key, value pairs\n\ |
|
116 \ (absolute path or relative to the current directory)\n\ |
|
117 \ The keys "name" (required), "version", "module", "class",\n\ |
|
118 \ "icon", "arguments", "jvm-args", "win-menu",\n\ |
|
119 \ "win-shortcut", and "win-console" can be used.\n\ |
|
120 \ These options are added to, or used to overwrite, the original\n\ |
|
121 \ command line options when building the secondary launcher.\n\ |
|
122 \ --build-root <file path>\n\ |
|
123 \ Path of a new or empty directory used to create temporary files\n\ |
|
124 \ (absolute path or relative to the current directory)\n\ |
|
125 \ If not specified, a temporary directory will be created and\n\ |
|
126 \ removed upon the task completion.\n\ |
|
127 \ --runtime-image <file path>\n\ |
|
128 \ Path of the predefined runtime image that is used to build\n\ |
|
129 \ an application image and installable package\n\ |
|
130 \ (absolute path or relative to the current directory)\n\ |
|
131 \ --app-image <file path>\n\ |
|
132 \ Location of the predefined application image that is used\n\ |
|
133 \ to build an installable package\n\ |
|
134 \ (absolute path or relative to the current directory)\n\ |
|
135 \ --install-dir <file path>\n\ |
168 \ --install-dir <file path>\n\ |
136 \ Absolute path of the installation directory of the application\n\ |
169 \ Absolute path of the installation directory of the application\n\ |
137 \ This option is ignored on Windows, use --win-dir-chooser to\n\ |
170 \ --installer-type <type> \n\ |
138 \ provide user the ability to choose the installation directory.\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\ |
139 \ --license-file <file path>\n\ |
176 \ --license-file <file path>\n\ |
140 \ Path to the license file\n\ |
177 \ Path to the license file\n\ |
141 \ (absolute path or relative to the current directory)\n\ |
178 \ (absolute path or relative to the current directory)\n\ |
142 \ --copyright <copyright string>\n\ |
|
143 \ Copyright for the application\n\ |
|
144 \ --description <description string>\n\ |
|
145 \ Description of the application\n\ |
|
146 \ --category <category string>\n\ |
|
147 \ Category or group of the application\n\ |
|
148 \ --vendor <vendor string>\n\ |
|
149 \ Vendor of the application\n\ |
|
150 \ --overwrite\n\ |
|
151 \ Allow the recursive deletion of an existing application \n\ |
|
152 \ output directory when creating an application image\n\ |
|
153 \ --resource-dir <path>\n\ |
179 \ --resource-dir <path>\n\ |
154 \ Path to override jpackage resources\n\ |
180 \ Path to override jpackage resources\n\ |
155 \ Icons, template files, and other resources of jpackage can be\n\ |
181 \ Icons, template files, and other resources of jpackage can be\n\ |
156 \ over-ridden by adding replacement resources to this directory.\n\ |
182 \ over-ridden by adding replacement resources to this directory.\n\ |
157 \ (absolute path or relative to the current directory)\n\ |
183 \ (absolute path or relative to the current directory)\n\ |
158 \n\ |
184 \ --runtime-image <file-path>\n\ |
159 Modular options:\n\ |
185 \ Path of the predefined runtime image to install\n\ |
160 \ --module -m <module name>\n\ |
186 \ (absolute path or relative to the current directory)\n\ |
161 \ Main module of the application\n\ |
187 \ Option is required when creating a runtime installer.\n\ |
162 \ This module must contain the main-class,\n\ |
188 \n\ |
163 \ and be located on the module path.\n\ |
189 \Platform dependent options for creating the application installer(s):\n\ |
164 \ --module-path -p <module path>\n\ |
190 {3} |
165 \ Path jlink looks in for modules when packaging the Java Runtime\n\ |
191 |
166 \ (absolute path or relative to the current directory)\n\ |
192 MSG_Help_win_launcher=\ |
167 \ --add-modules <module name>[,<module name>...]\n\ |
193 \n\ |
168 \ A comma (",") separated list of modules to add.\n\ |
194 \Platform dependent option for creating the application launcher:\n\ |
169 |
195 \ --win-console\n\ |
170 MSG_Help_mac=\nThe following options are valid for Mac OS X platforms:\n\ |
196 \ Creates a console launcher for the application, should be\n\ |
171 \ --mac-sign\n\ |
197 \ specified for application which requires console interactions\n\ |
172 \ Request that the bundle be signed\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_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\ |
173 \ --mac-bundle-name <name string>\n\ |
224 \ --mac-bundle-name <name string>\n\ |
174 \ Name of the application as it appears in the Menu Bar\n\ |
225 \ Name of the application as it appears in the Menu Bar\n\ |
175 \ This can be different from the application name.\n\ |
226 \ This can be different from the application name.\n\ |
176 \ This name must be less than 16 characters long and be suitable for\n\ |
227 \ This name must be less than 16 characters long and be suitable for\n\ |
177 \ displaying in the menu bar and the application Info window.\n\ |
228 \ displaying in the menu bar and the application Info window.\n\ |
178 \ Defaults to the application name.\n\ |
229 \ Defaults to the application name.\n\ |
179 \ --mac-bundle-identifier <ID string>\n\ |
|
180 \ An identifier that uniquely identifies the application for MacOSX\n\ |
|
181 \ (and on the Mac App Store)\n\ |
|
182 \ May only use alphanumeric (A-Z,a-z,0-9), hyphen (-),\n\ |
|
183 \ and period (.) characters.\n\ |
|
184 \ --mac-app-store-category <category string>\n\ |
|
185 \ Mac App Store Categories\n\ |
|
186 \ Note that the key is the string shown to\n\ |
|
187 \ the user and the value is the ID of the category.\n\ |
|
188 \ --mac-app-store-entitlements <file path>\n\ |
|
189 \ Path of a custom mac app store entitlements file\n\ |
|
190 \ (absolute path or relative to the current directory)\n\ |
|
191 \ --mac-bundle-signing-prefix <prefix string>\n\ |
230 \ --mac-bundle-signing-prefix <prefix string>\n\ |
192 \ When signing the application bundle, this value is prefixed to all\n\ |
231 \ When signing the application bundle, this value is prefixed to all\n\ |
193 \ components that need to be signed that don't have\n\ |
232 \ components that need to be signed that don't have\n\ |
194 \ an existing bundle identifier.\n\ |
233 \ an existing bundle identifier.\n\ |
|
234 \ --mac-sign\n\ |
|
235 \ Request that the bundle be signed\n\ |
|
236 \ --mac-signing-keychain <file path>\n\ |
|
237 \ Path of the keychain to use\n\ |
|
238 \ (absolute path or relative to the current directory)\n\ |
|
239 \ If not specified, the standard keychains are used.\n\ |
195 \ --mac-signing-key-user-name <user name>\n\ |
240 \ --mac-signing-key-user-name <user name>\n\ |
196 \ User name portion of the typical\n\ |
241 \ User name portion of the typical\n\ |
197 \ "Mac Developer ID Application: <user name>" signing key\n\ |
242 \ "Mac Developer ID Application: <user name>" signing key\n\ |
198 \ --mac-signing-keychain <file path>\n\ |
243 |
199 \ Path of the keychain to use\n\ |
244 MSG_Help_linux_install=\ |
200 \ (absolute path or relative to the current directory)\n\ |
|
201 \ If not specified, the standard keychains are used.\n\ |
|
202 |
|
203 MSG_Help_linux=\nThe following options are valid for Linux platforms:\n\ |
|
204 \ --linux-bundle-name <bundle name>\n\ |
245 \ --linux-bundle-name <bundle name>\n\ |
205 \ Name for Linux bundle, defaults to the application name\n\ |
246 \ Name for Linux bundle, defaults to the application name\n\ |
|
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\ |
206 \ --linux-package-deps\n\ |
251 \ --linux-package-deps\n\ |
207 \ Required packages or capabilities for the application\n\ |
252 \ Required packages or capabilities for the application\n\ |
208 \ --linux-rpm-license-type <type string>\n\ |
253 \ --linux-rpm-license-type <type string>\n\ |
209 \ Type of the license ("License: <value>" of the RPM .spec)\n\ |
254 \ Type of the license ("License: <value>" of the RPM .spec)\n\ |
210 \ --linux-deb-maintainer <email address>\n\ |
|
211 \ Maintainer for .deb bundle\n\ |
|
212 |
|
213 MSG_Help_win=\nThe following options are valid for Windows platforms:\n\ |
|
214 \ --win-menu\n\ |
|
215 \ Adds the application to the system menu\n\ |
|
216 \ --win-menu-group <menu group name>\n\ |
|
217 \ Start Menu group this application is placed in\n\ |
|
218 \ --win-per-user-install\n\ |
|
219 \ Request to perform an install on a per-user basis\n\ |
|
220 \ --win-dir-chooser\n\ |
|
221 \ Adds a dialog to enable the user to choose a directory in which\n\ |
|
222 \ the product is installed\n\ |
|
223 \ --win-registry-name <registry name>\n\ |
|
224 \ Name of the application for registry references.\n\ |
|
225 \ The default is the Application Name with only\n\ |
|
226 \ alphanumerics, dots, and dashes (no whitespace)\n\ |
|
227 \ --win-upgrade-uuid <id string>\n\ |
|
228 \ UUID associated with upgrades for this package\n\ |
|
229 \ --win-shortcut\n\ |
|
230 \ Creates a desktop shortcut for the application\n\ |
|
231 \ --win-console\n\ |
|
232 \ Creates a console launcher for the application, should be\n\ |
|
233 \ specified for application which requires console interactions\n\ |
|
234 |
255 |
235 MSG_Help_no_args=Usage: jpackage <mode> <options>\n\ |
256 MSG_Help_no_args=Usage: jpackage <mode> <options>\n\ |
236 \Use jpackage --help (or -h) for a list of possible options\ |
257 \Use jpackage --help (or -h) for a list of possible options\ |
237 |
258 |