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