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