jpackageコマンド

名前

jpackage - 自己完結型Javaアプリケーションをパッケージ化するためのツール。

シノプシス

jpackage [options]

options

スペースで区切ったコマンド行オプション。 「jpackageオプション」を参照してください。

説明

jpackageツールは、JavaアプリケーションとJavaランタイム・イメージを入力として取り、必要な依存関係をすべて含むJavaアプリケーション・イメージを生成します。 ネイティブ・パッケージは、Windowsでの実行やmacOSでのdmgなどのプラットフォーム固有の形式で生成できます。 各形式は実行するプラットフォーム上に構築する必要があり、クロス・プラットフォーム・サポートはありません。 ツールには、パッケージ・アプリケーションを様々な方法でカスタマイズできるオプションがあります。

jpackageオプション

一般的なオプション:

@filename

ファイルからオプションを読み取ります。

このオプションは複数回使用できます。

--typeまたは-t <type string>

作成するパッケージのタイプ

有効な値は次のとおりです: {"app-image", "exe", "msi", "rpm", "deb", "pkg", "dmg"}

このオプションが指定されない場合、プラットフォーム依存のデフォルト・タイプが作成されます。

--app-version <version>

アプリケーションおよびパッケージのバージョン

--copyright <copyright string>

アプリケーションのコピーライト

--description <description string>

アプリケーションの説明

--helpまたは-h

現行のプラットフォームで出力ストリームに対して有効な各オプションのリストと説明を出力し、終了します。

--icon <icon file path>

アプリケーション・パッケージ(現在のディレクトリへの絶対パスまたは相対パス)のアイコンのパス

--nameまたは-n <name>

アプリケーションおよびパッケージの名前

--destまたは-d <output path>

生成された出力ファイルが配置されるパス

現行の作業ディレクトリにデフォルト設定されます。(現在のディレクトリへの絶対パスまたは相対パス)。

--temp <directory path>

一時ファイルの作成に使用される新規ディレクトリまたは空のディレクトリのパス (現在のディレクトリへの絶対パスまたは相対パス)

指定した場合、タスクの完了時に一時ディレクトリは削除されず、手動で削除する必要があります。

指定しない場合は、タスクの完了時に一時ディレクトリが作成および削除されます。

--vendor <vendor string>

アプリケーションのベンダー

--verbose

詳細出力を有効にします。

--version

製品バージョンを出力ストリームに出力して終了します

ランタイム・イメージを作成するためのオプション:

--add-modules <module name> [,<module name>...]

追加するモジュールのカンマ(",")区切りリスト

このモジュール・リストは、メイン・モジュールの(指定されている場合)とともにjlinkに--add-module引数として渡されます。 指定しない場合は、メイン・モジュールの(--moduleが指定されている場合)のみ、または(--main-jarが指定されている場合)モジュールのデフォルト・セットが使用されます。

このオプションは複数回使用できます。

--module-pathまたは-p <module path>...

パスのFile.pathSeparator区切りリスト

各パスは、モジュールのディレクトリまたはモジュラjarへのパスで、絶対パスまたは現在のディレクトリからの相対パスです。

このオプションは複数回使用できます。

--jlink-options <jlink options>

jlinkに渡すオプションのスペース区切りのリスト

指定しない場合、"--strip-native-commands --strip-debug --no-man-pages --no-header-files"にデフォルト設定されます

このオプションは複数回使用できます。

--runtime-image <directory path>

アプリケーション・イメージ(現在のディレクトリへの絶対パスまたは相対パス)にコピーされる事前定義済ランタイム・イメージのパス

--runtime-imageが指定されていない場合、jpackageはjlinkを実行して、--jlink-optionsで指定されたオプションを使用してランタイム・イメージを作成します。

アプリケーション・イメージを作成するためのオプション:

--inputまたは-i <input path>

パッケージする(現在のディレクトリへの絶対パスまたは相対パス)ファイルを含む入力ディレクトリのパス

入力ディレクトリ内のすべてのファイルがアプリケーション・イメージにパッケージ化されます。

アプリケーション・ランチャを作成するためのオプション:

--add-launcher <launcher name>=<file path>

ランチャの名前、およびキーのリスト、値のペア(現在のディレクトリへの絶対パスまたは相対パス)を含むプロパティ・ファイルへのパス

キー"module"、"main-jar"、"main-class"、"arguments"、"java-options"、"app-version"、"icon"、"linux-app-category"、"linux-app-release"および"win-console"を使用できます。

これらのオプションは、追加の代替ランチャを構築するために、元のコマンドライン・オプションに追加するか、または上書きするために使用します。 メイン・アプリケーション・ランチャは、コマンド行オプションから構築されます。 このオプションを使用して追加の代替ランチャを構築でき、このオプションを複数回使用して複数の追加のランチャを構築できます。

--arguments <main class arguments>

起動ツールにコマンドライン引数が指定されていない場合にメイン・クラスに渡すコマンドライン引数

このオプションは複数回使用できます。

--java-options <java options>

Javaランタイムに渡すオプション

このオプションは複数回使用できます。

--main-class <class name>

実行するアプリケーション・メイン・クラスの修飾名

このオプションを使用できるのは、--main-jarが指定されている場合だけです。

--main-jar <main jar file>

アプリケーションの主なJAR(メイン・クラス(入力パスに対して相対パスとして指定されます)を含む)

--moduleまたは--main-jarオプションのいずれかを指定できますが、両方は指定できません。

--moduleまたは-m <module name>/<main class>]

アプリケーションのメイン・モジュール(およびオプションでメイン・クラス)

このモジュールは、モジュール・パスに置かれている必要があります。

このオプションを指定すると、メイン・モジュールがJavaランタイム・イメージ内でリンクされます。 --moduleまたは--main-jarオプションのいずれかを指定できますが、両方は指定できません。

アプリケーション・ランチャを作成するためのプラットフォーム依存オプション:

Windowsプラットフォームのオプション(Windowsで実行中のみ使用可能):

--win-console

アプリケーションのコンソール・ランチャを作成します。コンソール対話が必要なアプリケーションに対して指定する必要があります

macOSプラットフォームのオプション(macOSで実行中のみ使用可能):

--mac-package-identifier <ID string>

macOSのアプリケーションを一意に識別する識別子

デフォルトはメイン・クラス名です。

使用できるのは、英数字の(A-Z,a-z,0-9)、ハイフン(-)および期間(.)文字のみです。

--mac-package-name <name string>

メニュー・バーに表示されるアプリケーションの名前

これは、アプリケーション名と異なる場合があります。

この名前は16文字未満で、メニュー・バーおよびアプリケーションの情報ウィンドウに表示するのに適しています。 デフォルトはアプリケーション名です。

--mac-package-signing-prefix <prefix string>

アプリケーション・パッケージに署名する場合、この値は、既存のパッケージ識別子を持たない署名する必要があるすべてのコンポーネントにプレフィクスとして付けられます。

--mac-sign

バンドルに署名をリクエストします。

--mac-signing-keychain <keychain name>

署名アイデンティティを検索するキー・チェーンの名前

指定しない場合は、標準のキー・チェーンが使用されます。

--mac-signing-key-user-name <team name>

Appleの署名IDのチームまたはユーザー名部分

--mac-app-store

jpackage出力がMac App Storeを対象としていることを示します。

--mac-entitlements <file path>

バンドル内の実行可能ファイルおよびライブラリに署名するときに使用する資格を含むファイルへのパス

--mac-app-category <category string>

アプリケーション・レートでLSApplicationCategoryTypeを作成するために使用する文字列

デフォルト値は"ユーティリティ"です。

アプリケーション・パッケージを作成するためのオプション:

--about-url <url>

アプリケーションのホームページのURL

--app-image <directory path>

インストール可能なパッケージの構築に使用される事前定義済アプリケーション・イメージのロケーション

(絶対パスまたは現在のディレクトリからの相対パス)

アプリケーション・イメージを作成するには、create-app-imageモード・オプションを参照してください。

--file-associations <file path>

キーと値のペアのリストを含むプロパティ・ファイルへのパス(現在のディレクトリへの絶対パスまたは相対パス)

キー"extension"、"mime-type"、"icon"および"description"を使用して関連付けを記述できます。

このオプションは複数回使用できます。

--install-dir <directory path>

アプリケーション(on macos or linux)のインストール・ディレクトリの絶対パス、または"プログラム・ファイル"や"AppData" (Windows上で)などのインストール・ディレクトリの相対パス

--license-file <file path>

ライセンス・ファイル(現在のディレクトリへの絶対パスまたは相対パス)へのパス

--resource-dir <directory path>

jpackageリソースをオーバーライドするパス(現在のディレクトリへの絶対パスまたは相対パス)

このディレクトリに置換リソースを追加することによって、jpackageのアイコン、テンプレート・ファイルおよびその他のリソースを上書きできます。

--runtime-image <directory path>

(現在のディレクトリへの絶対パスまたは相対パス)をインストールする事前定義済のランタイム・イメージのパス

ランタイム・インストーラの作成時にはオプションが必要です。

アプリケーション・パッケージを作成するためのプラットフォーム依存オプション:

Windowsプラットフォームのオプション(Windowsで実行中のみ使用可能):

--win-dir-chooser

製品がインストールされているディレクトリをユーザーが選択できるダイアログを追加します。

--win-help-url <url>

ユーザーが詳細な情報またはテクニカル・サポートを取得できるURL

--win-menu

このアプリケーションのスタート・メニュー・ショートカットの追加リクエスト

--win-menu-group <menu group name>

このアプリケーションが配置されるスタート・メニュー・グループ

--win-per-user-install

ユーザーごとにインストールを実行するリクエスト

--win-shortcut

このアプリケーションのデスクトップ・ショートカットの作成をリクエスト

--win-shortcut-prompt

インストーラによってショートカットを作成するかどうかをユーザーが選択できるようにするためのダイアログを追加

--win-update-url <url>

使用可能なアプリケーション更新情報のURL

--win-upgrade-uuid <id string>

このパッケージのアップグレードに関連付けられたUUID

Linuxプラットフォームのオプション(Linuxで実行中のみ使用可能):

--linux-package-name <package name>

Linuxパッケージの名前

デフォルトはアプリケーション名です。

--linux-deb-maintainer <email address>

.debバンドルの保守者

--linux-menu-group <menu-group-name>

このアプリケーションが配置されるメニュー・グループ

--linux-package-deps

アプリケーションに必要なパッケージまたは機能

--linux-rpm-license-type <type string>

ライセンスのタイプ (RPM .specの"ライセンス: <value>")

--linux-app-release <release string>

DEB制御ファイルのRPM <name>.specファイルまたはDebianリビジョン値のリリース値

--linux-app-category <category string>

RPMの<name>.specファイルのグループ値、またはDEB制御ファイルのセクション値

--linux-shortcut

アプリケーションのショートカットを作成します。

jpackageの例

Generate an application package suitable for the host system:

For a modular application:
    jpackage -n name -p modulePath -m moduleName/className
For a non-modular application:
    jpackage -i inputDir -n name \
        --main-class className --main-jar myJar.jar
From a pre-built application image:
    jpackage -n name --app-image appImageDir

Generate an application image:

For a modular application:
    jpackage --type app-image -n name -p modulePath \
        -m moduleName/className
For a non-modular application:
    jpackage --type app-image -i inputDir -n name \
        --main-class className --main-jar myJar.jar
To provide your own options to jlink, run jlink separately:
    jlink --output appRuntimeImage -p modulePath \
        --add-modules moduleName \
        --no-header-files [<additional jlink options>...]
    jpackage --type app-image -n name \
        -m moduleName/className --runtime-image appRuntimeImage

Generate a Java runtime package:

jpackage -n name --runtime-image <runtime-image>