Command Name
- 具体的なコマンドタイトルを続けて記述commandname [ options ] [ sourcefiles ] [ classes ] [ @argfiles ]
たとえば、必要に応じて次のような項目を導入できます。
ユーザーがこのツールを使用して行う一般的な処理内容について記述します。
また、このツールの開発目的について記します。
サポートされる各 OS (オペレーティングシステム) での使用や機能について一般的な違いを記述できます。
概要を記述します。次に、オプションに各種のカテゴリがある場合はレベル 3 見出しを複数使用し、必要に応じてサブセクションを作成します。オプションは、サブセクション内でアルファベット順にリストする必要があります。
次に、jconsole
および apt
のマニュアルページのオプションの例をいくつか示します。これらは、サブセクションの体裁の例を単に示すために、3 つのサブセクションに分けられています。
jconsole
のオプション-interval
=n-notile
-pluginpath
pluginsMETA-INF/services/com.sun.tools.jconsole.JConsolePlugin
これには、com.sun.tools.jconsole.JConsolePlugin クラスを実装するクラスの完全修飾クラス名を指定する行が、プラグインごとに 1 行ずつ含まれています。
-version
-help
-J<flag>
apt
固有のオプション-s
dir-nocompile
-print
-A
[key[=
val]]apt
が直接解釈するのではなく、それぞれのプロセッサによって使用できるように変えられます。-factorypath
path-factory
classnameapt
javac
と共用するオプション-d
dir-cp
path または -classpath
path-factorypath
が指定されている場合、クラスパスはファクトリ用に検索されません。javac
オプションの詳細については、javac(1) のマニュアルページを参照してください。
このセクションでは、開発者がこのツールを使用する一般的な方法について簡単に説明します。
次に jstatd を起動する例を紹介します。jstatd スクリプトによって、サーバーはバックグラウンドで自動的に起動します。
この例は、内部 RMI レジストリを使用した jstatd の起動を表しています。この例では、デフォルトの RMI レジストリポート (ポート 1099) には、ほかのサーバーはバインドされていないと想定しています。
jstatd -J-Djava.security.policy=all.policy
この例は、外部 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 レジストリを作成しない jstatd の起動を表しています。この例では、RMI レジストリがすでに実行していると想定しています。実行していない場合は、該当するエラーメッセージが表示されます。
jstatd -J-Djava.security.policy=all.policy -nr
この例は、RMI ロギング機能を有効にした jstatd の起動を表しています。この方法は、トラブルシューティングまたはサーバー活動の監視に役立ちます。
jstatd -J-Djava.security.policy=all.policy -J-Djava.rmi.server.logCalls=true
次に、jstatd
のマニュアルページにある「関連項目」セクションを示します。