1 #
2 # Copyright (c) 2017, 2018, 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_common=Usage: jpackager <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 <type>\n\
33 \ Generates a platform-specific installer for the application.\n\
34 \ Valid values for "type" are "msi", "exe", "rpm", "deb", "dmg",\n\
35 \ "pkg", and "pkg-app-store".\n\
36 \ If "type" is omitted, all supported types of installable packages\n\
37 \ for current platform will be generated.\n\
38 \ create-jre-installer <type>\n\
39 \ Generates a platform-specific installer for Server JRE.\n\
40 \ Valid values for "type" are "msi", "exe", "rpm", "deb", "dmg", \n\
41 \ and "pkg".\n\
42 \ If "type" is omitted, all supported types of installable packages\n\
43 \ for current platform will be generated.\n\
44 \ \n\
45 Sample usages:\n\
46 --------------\n\
47 jpackager create-image --input inputdir --output outputdir --name AppName --class package.ClassName\n\
48 or\n\
49 jpackager create-image -i inputdir -o outputdir -n AppName -c package.ClassName\n\
50 Generates an application image.\n\
51 \n\
52 jpackager create-installer -i inputdir -o outputdir -n "App Name" -c package.ClassName\n\
53 Generates an application installer.\n\
54 \n\
55 jpackager create-jre-installer -n <jre_name> -o outputdir\n\
56 Generates a Server JRE installer.\n\
57 \n\
58 The following options are valid for all platforms:\n\
59 \ --help -h \n\
60 \ Shows the usage text, followed by a list and description of each valid option for the current platform and the given mode.\n\
61 \ If no mode is given, shows the usage text, followed by a list and description of each valid option for the current platform.\n\
62 \ When this option is used, all other options are ignored.\n\
63 \ --output -o <output dir>\n\
64 \ Name of the directory where generated output file is placed.\n\
65 \ --input -i <input dir>\n\
66 \ Name of the base directory that contains the files to package.\n\
67 \ --files -f <input files>\n\
68 \ List of files in the base directory. If omitted, all files from "input"\n\
69 \ directory (which is a mandatory argument in this case) will be packaged.\n\
70 \ --name -n <application name>\n\
71 \ Name of the application.\n\
72 \ --main-jar -j <main jar name>\n\
73 \ The main JAR of the application. This JAR should have the main-class,\n\
74 \ and is relative to the assembled application directory.\n\
75 \ --class -c <class name>\n\
76 \ Qualified name of the application class to execute.\n\
77 \ --version -v <version string>\n\
78 \ Version of the application.\n\
79 \ --arguments -a <main class arguments>\n\
80 \ Command line arguments to pass to the main class if no arguments\n\
81 \ are specified by the launcher.\n\
82 \ --icon <icon file name>\n\
83 \ Icon of the application bundle.\n\
84 \ --singleton\n\
85 \ Prevents multiple instances of the application from launching\n\
86 \ (see SingleInstanceService API for more details).\n\
87 \ --identifier <id string>\n\
88 \ Machine readable identifier of the application. The format\n\
89 \ must be a DNS name in reverse order, such as com.example.myapplication.\n\
90 \ The identifier is used for composing Single Instance unique id.\n\
91 \ --verbose\n\
92 \ Enables verbose output.\n\
93 \ --strip-native-commands\n\
94 \ Removes native executables from the custom run-time images.\n\
95 \ --jvm-args <java vm arguments>\n\
96 \ JVM flags and options to pass to the application.\n\
97 \ --file-associations <file path>\n\
98 \ Properties file that contains list of key=value parameters that\n\
99 \ describe a file association. "extension", "mime-type", "icon",\n\
100 \ "description" can be used as keys for the association.\n\
101 \ --secondary-launcher <file path>\n\
102 \ Properties file that contains a collection of options for a secondary launcher.\n\
103 \ --build-root <file path>\n\
104 \ Directory in which to use and place temporary files.\n\
105 \ --runtime-image <file path>\n\
106 \ Location of the predefined runtime image that is used to build\n\
107 \ an application image and installable package.\n\
108 \ --app-image <file path>\n\
109 \ Location of the predefined application image that is used to build\n\
110 \ an installable package.\n\
111 \ --install-dir <file path>\n\
112 \ Installation directory of the application. Ignored on Windows, use\n\
113 \ --win-dir-chooser to provide an ability to choose an installation directory.\n\
114 \ --license-file <file name>\n\
115 \ The license file, relative to the base directory.\n\
116 \ --copyright <copyright string>\n\
117 \ Copyright for the application.\n\
118 \ --description <description string>\n\
119 \ Description of the application.\n\
120 \ --category <category string>\n\
121 \ Category or group of the application.\n\
122 \ --vendor <vendor string>\n\
123 \ Vendor of the application.\n\
124 \n\
125 Modular options:\n\
126 \ --module -m <module name>\n\
127 \ Main module of the application. This module must have the main-class,\n\
128 \ and be on the module path.\n\
129 \ --module-path -p <module path>\n\
130 \ When packaging the Java Runtime, this is the path JLink looks in for modules.\n\
131 \ --add-modules <module list>\n\
132 \ List of modules to add to JImage creation, including possible services.\n\
133 \ --limit-modules <module list>\n\
134 \ Modules to limit JImage creation to.\n\
135
136 MSG_Help_mac=\nThe following options are valid for Mac OS X platforms:\n\
137 \ --mac-sign\n\
138 \ Request that the bundle be signed.\n\
139 \ --mac-bundle-name <name string>\n\
140 \ Name of the application as it appears in the Menu Bar. This can be\n\
141 \ different from the application name. This name must be less than 16\n\
142 \ characters long and be suitable for displaying in the menu bar and\n\
143 \ the application Info window. Defaults to the application name.\n\
144 \ --mac-bundle-identifier <ID string>\n\
145 \ An identifier that uniquely identifies the application for MacOSX\n\
146 \ (and on the Mac App Store). May only use alphanumeric (A-Z,a-z,0-9),\n\
147 \ hyphen (-), and period (.) characters.\n\
148 \ --mac-app-store-category <category string>\n\
149 \ Mac App Store Categories. Note that the key is the string shown to\n\
150 \ the user and the value is the ID of the category.\n\
151 \ --mac-app-store-entitlements <file path>\n\
152 \ File location of a custom mac app store entitlements file.\n\
153 \ --mac-bundle-signing-prefix <prefix string>\n\
154 \ When signing the application bundle, this value is prefixed to all\n\
155 \ components that need to be signed that don't have an existing bundle identifier.\n\
156 \ --mac-signing-key-user-name <user name>\n\
157 \ User name portion of the typical "Mac Developer ID Application: <user name>" signing key.\n\
158 \ --mac-signing-keychain <file path>\n\
159 \ Location of the keychain to use. If not specified, the standard keychains are used.\n\
160
161 MSG_Help_linux=\nThe following options are valid for Linux platforms:\n\
162 \ --linux-bundle-name <bundle name>\n\
163 \ Name for Linux bundle. Defaults to the application name.\n\
164 \ --linux-package-deps\n\
165 \ Required packages or capabilities for the application.\n\
166 \ --linux-rpm-license-type <type string>\n\
167 \ Type of the license ("License: <value>" of the RPM .spec).\n\
168 \ --linux-deb-maintainer <email address>\n\
169 \ Maintainer for .deb bundle.\n\
170
171 MSG_Help_win=\nThe following options are valid for Windows platforms:\n\
172 \ --win-menu\n\
173 \ Adds the application to the system menu.\n\
174 \ --win-menu-group <menu group name>\n\
175 \ Start Menu group this application is placed in.\n\
176 \ --win-per-user-install\n\
177 \ Request to perform an install on a per-user basis.\n\
178 \ --win-dir-chooser\n\
179 \ Adds a dialog to enable the user to choose a directory in which\n\
180 \ the product is installed.\n\
181 \ --win-registry-name <registry name>\n\
182 \ Name of the application for registry references. Default is\n\
183 \ the Application Name with only alphanumerics, dots, and dashes (no whitespace).\n\
184 \ --win-upgrade-uuid <id string>\n\
185 \ UUID associated with upgrades for this package.\n\
186 \ --win-shortcut\n\
187 \ Creates a desktop shortcut for the application.\n\
188 \ --win-console\n\
189 \ Creates a console launcher for the application. Should be specified for\n\
190 \ application which requires console interactions.\n\