Command Name - 具体的なコマンドタイトルを続けて記述

形式

   commandname [ options ] [ sourcefiles ] [ classes ] [ @argfiles ]

パラメータ

たとえば、必要に応じて次のような項目を導入できます。

説明

ユーザーがこのツールを使用して行う一般的な処理内容について記述します。

また、このツールの開発目的について記します。

サポートされる各 OS (オペレーティングシステム) での使用や機能について一般的な違いを記述できます。

オプション

概要を記述します。次に、オプションに各種のカテゴリがある場合はレベル 3 見出しを複数使用し、必要に応じてサブセクションを作成します。オプションは、サブセクション内でアルファベット順にリストする必要があります。

次に、jconsole および apt のマニュアルページのオプションの例をいくつか示します。これらは、サブセクションの体裁の例を単に示すために、3 つのサブセクションに分けられています。

jconsole のオプション

-interval=n
更新間隔を n 秒に設定します (デフォルトは 4 秒)。
-notile 
最初にウィンドウをタイリングしません (複数の接続のため)。
-pluginpath  plugins
JConsole プラグインの検索先となるディレクトリまたは JAR ファイルのリストを指定します。plugins パスには、次の名前のプロバイダ構成ファイルを含めてください。
   META-INF/services/com.sun.tools.jconsole.JConsolePlugin

これには、com.sun.tools.jconsole.JConsolePlugin クラスを実装するクラスの完全修飾クラス名を指定する行が、プラグインごとに 1 行ずつ含まれています。

-version 
バージョン情報を出力して終了します。
-help 
ヘルプメッセージを出力して終了します。
-J<flag> 
jconsole が実行されている Java 仮想マシンに <flag> を渡します。

apt 固有のオプション

-s dir
プロセッサの生成するソースファイルを置くディレクトリルートを指定します。ファイルは、パッケージの名前空間に基づいてサブディレクトリに置かれます。
-nocompile
ソースファイルをクラスファイルにコンパイルしません。
-print
指定したタイプのテキスト表現を出力します。注釈処理またはコンパイルは行いません。
-A[key[=val]]
注釈プロセッサへ渡すオプションです。このオプションは、apt が直接解釈するのではなく、それぞれのプロセッサによって使用できるように変えられます。
-factorypath path
注釈プロセッサファクトリを検索する場所を指定します。このオプションを使用する場合、クラスパスのファクトリは検索されません。
-factory classname
使用する注釈プロセッサファクトリの名前です。デフォルトの検出プロセスを省略します。

apt javac と共用するオプション

-d dir
プロセッサと javac 生成のクラスファイルを置く場所を指定します。
-cp path または -classpath path
ユーザークラスファイルと注釈プロセッサファクトリを検索する場所を指定します。-factorypath が指定されている場合、クラスパスはファクトリ用に検索されません。

javac オプションの詳細については、javac(1) のマニュアルページを参照してください。

使用法

このセクションでは、開発者がこのツールを使用する一般的な方法について簡単に説明します。

次に jstatd を起動する例を紹介します。jstatd スクリプトによって、サーバーはバックグラウンドで自動的に起動します。

内部 RMI レジストリの使用

この例は、内部 RMI レジストリを使用した jstatd の起動を表しています。この例では、デフォルトの RMI レジストリポート (ポート 1099) には、ほかのサーバーはバインドされていないと想定しています。

jstatd -J-Djava.security.policy=all.policy

外部 RMI レジストリの使用

この例は、外部 RMI レジストリを使用した jstatd の起動を表しています。

rmiregistry&
jstatd -J-Djava.security.policy=all.policy

この例は、ポート 2020 の外部 RMI レジストリを使用した jstatd の起動を表しています。

rmiregistry 2020&
jstatd -J-Djava.security.policy=all.policy -p 2020

この例は、AlternateJstatdServerName の名前にバインドされた、ポート 2020 の外部 RMI レジストリを使用した jstatd の起動を表しています。

rmiregistry 2020&
jstatd -J-Djava.security.policy=all.policy -p 2020 -n AlternateJstatdServerName

インプロセス RMI レジストリの作成の禁止

この例は、RMI レジストリが見つからない場合に RMI レジストリを作成しない jstatd の起動を表しています。この例では、RMI レジストリがすでに実行していると想定しています。実行していない場合は、該当するエラーメッセージが表示されます。

jstatd -J-Djava.security.policy=all.policy -nr

RMI ロギング機能の有効化

この例は、RMI ロギング機能を有効にした jstatd の起動を表しています。この方法は、トラブルシューティングまたはサーバー活動の監視に役立ちます。

jstatd -J-Djava.security.policy=all.policy -J-Djava.rmi.server.logCalls=true

関連項目

次に、jstatd のマニュアルページにある「関連項目」セクションを示します。


Copyright © 1993, 2013, Oracle and/or its affiliates. All rights reserved.