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 -o outputdir -i inputdir -n name \\\n\
  33 \            --main-class className --main-jar MyJar.jar\n\
  34 \    Generate a modular application image:\n\
  35 \        jpackage -o outputdir -n name -p modulePath -m moduleName/className\n\
  36 \        To provide your own options to jlink, run jlink separately:\n\
  37 \            jlink --output appRuntimeImage -p ModulePath -m moduleName \\\n\
  38 \                --no-header-files [<additional jlink options>...]\n\
  39 \            jpackage -o outputdir -n name \\\n\
  40 \                -m moduleName/className --runtime-image appRuntimeImage\n\
  41 \    Generate an application package:\n\
  42 \        jpackage --package-type <type> -o outputdir -n name \\\n\
  43 \            -p modulePath -m moduleName/className\n\
  44 \        jpackage --package-type <type> -i inputdir -o outputdir -n name \\\n\
  45 \            --main-class package.ClassName --main-jar MyJar.jar\n\
  46 \        jpackage --package-type <type> -o outputdir -n name \\\n\
  47 \            --app-image <app image dir>\n\
  48 \    Generate a Java runtime package:\n\
  49 \        jpackage --package-type <type> -o outputdir -n name \\\n\
  50 \            --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 \  --package-type <type> \n\
  57 \          The type of package to create\n\
  58 \          Valid values are: {1} \n\
  59 \          If this option is not specified an application image will be\n\
  60 \          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 \  --output -o <output path>\n\
  73 \          Path where generated output file is placed\n\
  74 \          (absolute path or relative to the current directory)\n\
  75 \  --temp-root <file path>\n\
  76 \          Path of a new or empty directory used to create temporary files\n\
  77 \          (absolute path or relative to the current directory)\n\
  78 \          If specified, the temp-root will not be removed upon the task\n\
  79 \          completion and must be removed manually\n\
  80 \          If not specified, a temporary directory will be created and\n\
  81 \          removed upon the task completion.\n\
  82 \  --vendor <vendor string>\n\
  83 \          Vendor of the application\n\
  84 \  --verbose\n\
  85 \          Enables verbose output\n\
  86 \  --version\n\
  87 \          Print the product version to the output stream and exit\n\
  88 \n\
  89 \Options for creating the runtime image:\n\
  90 \  --add-modules <module name>[,<module name>...]\n\
  91 \          A comma (",") separated list of modules to add.\n\
  92 \          This module list, along with the main module (if specified)\n\
  93 \          will be passed to jlink as the --add-module argument.\n\
  94 \          if not specified, either just the main module (if --module is\n\
  95 \          specified), or the default set of modules (if --main-jar is \n\
  96 \          specified) are used.\n\
  97 \          This option can be used multiple times.\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 \          This option can be used multiple times.\n\
 104 \  --runtime-image <file path>\n\
 105 \          Path of the predefined runtime image that will be copied into\n\
 106 \          the application image\n\
 107 \          (absolute path or relative to the current directory)\n\
 108 \          If --runtime-image is not specified, jpackage will run jlink to\n\
 109 \          create the runtime image using options:\n\
 110 \          --strip-debug, --no-header-files, --no-man-pages, and\n\
 111 \          --strip-native-commands.  --bind-services will also be added if\n\
 112 \          --add-modules is not specified.\n\
 113 \n\
 114 \Options for creating the application image:\n\
 115 \  --icon <icon file path>\n\
 116 \          Path of the icon of the application bundle\n\
 117 \          (absolute path or relative to the current directory)\n\
 118 \  --input -i <input path>\n\
 119 \          Path of the input directory that contains the files to be packaged\n\
 120 \          (absolute path or relative to the current directory)\n\
 121 \          All files in the input directory will be packaged into the\n\
 122 \          application image.\n\
 123 \n\
 124 \Options for creating the application launcher(s):\n\
 125 \  --add-launcher <launcher name>=<file path>\n\
 126 \          Name of launcher, and a path to a Properties file that contains\n\
 127 \          a list of key, value pairs\n\
 128 \          (absolute path or relative to the current directory)\n\
 129 \          The keys "module", "main-jar", "main-class",\n\
 130 \          "arguments", "java-options", "app-version", "icon", and\n\
 131 \          "win-console" can be used.\n\
 132 \          These options are added to, or used to overwrite, the original\n\
 133 \          command line options to build an additional alternative launcher.\n\
 134 \          The main application launcher will be built from the command line\n\
 135 \          options. Additional alternative launchers can be built using\n\
 136 \          this option, and this option can be used multiple times to\n\
 137 \          build multiple additional launchers. \n\
 138 \  --arguments <main class arguments>\n\
 139 \          Command line arguments to pass to the main class if no command\n\
 140 \          line arguments are given to the launcher\n\
 141 \          This option can be used multiple times.\n\
 142 \  --java-options <java options>\n\
 143 \          Options to pass to the Java runtime\n\
 144 \          This option can be used multiple times.\n\
 145 \  --main-class <class name>\n\
 146 \          Qualified name of the application main class to execute\n\
 147 \          This option can only be used if --main-jar is specified.\n\
 148 \  --main-jar <main jar file>\n\
 149 \          The main JAR of the application; containing the main class\n\
 150 \          (specified as a path relative to the input path)\n\
 151 \          Either --module or --main-jar option can be specified but not\n\
 152 \          both.\n\
 153 \  --module -m <module name>[/<main class>]\n\
 154 \          The main module (and optionally main class) of the application\n\
 155 \          This module must be located on the module path.\n\
 156 \          When this option is specified, the main module will be linked\n\
 157 \          in the Java runtime image.  Either --module or --main-jar\n\
 158 \          option can be specified but not both.\n\
 159 {2}\n\
 160 \Options for creating the application package:\n\
 161 \  --app-image <file path>\n\
 162 \          Location of the predefined application image that is used\n\
 163 \          to build an installable package\n\
 164 \          (absolute path or relative to the current directory)\n\
 165 \  --file-associations <file path>\n\
 166 \          Path to a Properties file that contains list of key, value pairs\n\
 167 \          (absolute path or relative to the current directory)\n\
 168 \          The keys "extension", "mime-type", "icon", and "description"\n\
 169 \          can be used to describe the association.\n\
 170 \          This option can be used multiple times.\n\
 171 \  --identifier <id string>\n\
 172 \          An identifier that uniquely identifies the application\n\
 173 \          Defaults to the main class name.\n\
 174 \          The value should be a valid DNS name.\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-registry-name <registry name>\n\
 211 \          Name of the application for registry references.\n\
 212 \          The default is the Application Name with only\n\
 213 \          alphanumerics, dots, and dashes (no whitespace)\n\
 214 \  --win-shortcut\n\
 215 \          Creates a desktop shortcut for the application\n\
 216 \  --win-upgrade-uuid <id string>\n\
 217 \          UUID associated with upgrades for this package\n\
 218 
 219 MSG_Help_win_install_dir=\
 220 \Relative sub-path under the default installation location\n\
 221 
 222 MSG_Help_mac_launcher=\
 223 \  --mac-bundle-identifier <ID string>\n\
 224 \          An identifier that uniquely identifies the application for MacOSX\n\
 225 \          Defaults to the value of --identifier option.\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 search for the signing identity\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 <team name>\n\
 245 \          Team name portion in Apple signing identities' names.\n\
 246 \          For example "Developer ID Application: "\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-deb-copyright-file <file path>\n\
 254 \          Path to custom copyright file for Debian packaging\n\
 255 \          (absolute path or relative to the current directory)\n\
 256 \  --linux-menu-group <menu-group-name>\n\
 257 \          Menu group this application is placed in\n\
 258 \  --linux-package-deps\n\
 259 \          Required packages or capabilities for the application\n\
 260 \  --linux-rpm-license-type <type string>\n\
 261 \          Type of the license ("License: <value>" of the RPM .spec)\n\
 262 \  --linux-app-release <release value>\n\
 263 \          Release value of the RPM <name>.spec file or DEB control file.\n\
 264 \  --linux-app-category <category value>\n\
 265 \          Group value of the RPM <name>.spec file or \n\
 266 \          Section value of DEB control file.\n\
 267 
 268 MSG_Help_mac_linux_install_dir=\
 269 \Absolute path of the installation directory of the application\n\
 270 
 271 MSG_Help_default_install_dir=\
 272 \Absolute path of the installation directory of the application on OS X\n\
 273 \          or Linux. Relative sub-path of the installation location of the application\n\
 274 \          such as "Program Files" or "AppData" on Windows.\n\
 275 
 276 MSG_Help_no_args=Usage: jpackage <mode> <options>\n\
 277 \Use jpackage --help (or -h) for a list of possible options\
 278