xconfmanager コマンドの構文
管理者が使用する xconfmanager コマンドの構文は以下のとおりです。
xconfmanager {-fFhuwvV} {-r <製品のルート>} {-d <プロパティ名>} {-s
<プロパティペア>} {-t <プロパティファイル>} {--add <プロパティペア>} {--remove
<プロパティペア>} {--reset <プロパティ名>} {--setfromfile <プロパティファイル>}
{--undefine <プロパティ名>} {-i <宣言的_XCONF>} {--validateassite
<サイト_xconf>} {--validateasdecl <宣言的_XCONF>} {--validatefilesassite
<サイトリストファイル>} {--validatefilesasdecl <宣言リストファイル>} {-p}
<プロパティペア>} {-t <プロパティファイル>} {--add <プロパティペア>} {--remove
<プロパティペア>} {--reset <プロパティ名>} {--setfromfile <プロパティファイル>}
{--undefine <プロパティ名>} {-i <宣言的_XCONF>} {--validateassite
<サイト_xconf>} {--validateasdecl <宣言的_XCONF>} {--validatefilesassite
<サイトリストファイル>} {--validatefilesasdecl <宣言リストファイル>} {-p}
構文内の中括弧 ({}) は、オプションのパラメータを示しており、同時に指定するパラメータを示しています。この構文には、各パラメータ名の短縮形のみが含まれています。パラメータ名では大文字と小文字が区別されます。構文および以下の表に示すとおりに大文字小文字を区別して名前を入力してください。
複数パラメータの構文では以下の変数を使用します。
• <property_pair> は、コマンドラインでエスケープされた、java.util.Properties の仕様と互換性がある名前 = 値のペアです。使用例は、「プロパティ値の設定と変更の反映」を参照してください。
• <property_names> には、複数のプロパティ名をコンマで区切って指定します。
• <property_file> は、プロパティファイルの相対パス名または完全パス名です。
• <declarative_xconf> は、宣言 XCONF ファイルの完全 URL または相対ファイルパスです。
すべてのパラメータとその説明を以下の表に示します (アルファベット順)。
|
パラメータ名
|
説明
|
|---|---|
|
--add
|
プロパティですでに定義されている順序付けされた値セットの末尾に、指定された値を追加します。プロパティが複数値プロパティとして宣言された場合のみ、このパラメータを使用します。
プロパティが複数の値を持つかどうかを確認するために、-d パラメータを使用して現在の値のセットを表示できます。複数の値を持つプロパティの場合、このパラメータの出力結果として複数の値を持つセパレータがリストされます。
|
|
-d
または
--describe
|
現在設定されている値と、指定されたプロパティ用に各値が設定されている、対応する XCONF ファイルを一覧表示します。
すべてのパラメータ設定オプションおよび -p オプションを実行した後で、このパラメータが実行されます。
|
|
-F
または
--force
|
XCONF からプロパティへのファイル依存性のキャッシュ、および更新する必要のあるプロパティファイルを特定するために通常行われるタイムスタンプの比較が、プロパゲータで強制的に無視されるようにします。このオプションを使用すると、サイトに固有の変更がすべてプロパティファイルに反映されます。
ファイルのタイムスタンプに問題があると思われる場合、または -w オプションと -u オプションを切り替える場合、-p オプションの代わりにこのパラメータを使用します。
|
|
-f
または
--forcescan
|
プロパゲータが、XCONF からプロパティへのファイル依存性のキャッシュを強制的に無視するようにします。-F を指定した場合、このパラメータは無視されます。
キャッシュが古いと思われる場合は、-p の代わりにこのオプションを使用します。
|
|
-h
または
--help
|
xconfmanager コマンドのヘルプを表示します。
|
|
-i
または
--install
|
作成した宣言 XCONF ファイルをインストールします。追加のプロパティファイルを作成する際は、新しい宣言 XCONF ファイルを使用します。新しいプロパティを設定できるコードを追加する場合、プロパティを保存する個別のプロパティファイルを作成することを選択できます。宣言 XCONF ファイルの設定項目の詳細については、XCONF ファイルの使用を参照してください。
|
|
-p
または
--propagate
|
XCONF ファイルに加えられたすべての変更を、使用中のプロパティファイルに反映させます。このオプションは常に、プロパティを設定するオプションの後に実行されます。この順序で実行すると、新しく設定されたプロパティが必ず反映されます。
更新されたプロパティファイルは、Windchill ソリューションを再起動したときにアクセスされます。
|
|
-r
または
--productroot
|
declarations.xconf ファイルで XCONF 参照を指定する場合、および -t パラメータでターゲットファイルパスを指定する場合に、すべての相対パスの基準となるルートディレクトリ。
デフォルトのルートディレクトリは、Windchill ソリューションがインストールされている bin ディレクトリです。
|
|
--remove
|
プロパティで定義されている順序付けされた値セットの中の指定された値を除去します。このオプションは、複数の値を持つプロパティとしてプロパティを宣言した場合のみに使用します。
プロパティが複数の値を持つかどうかを確認するために、-d パラメータを使用して現在の値のセットを表示できます。複数の値を持つプロパティの場合、このパラメータの出力結果として複数の値を持つセパレータがリストされます。
|
|
--reset
|
1 つまたは一連のプロパティの、サイトに固有の値を、宣言されているデフォルト値にリセットします。
|
|
-s
または
--set
|
名前付きのプロパティを site.xconf ファイル内の特定の値に設定します。
1 つのターゲットプロパティファイルで複数のプロパティを設定するには、このパラメータを複数使用するか、以下のパラメータを使用します。
--setfromfile
別々のターゲットプロパティファイルにある複数のプロパティを設定するには、ターゲットファイルごとに 1 つの xconfmanager コマンドを入力します。
このパラメータは、-t パラメータとともに使用します。
|
|
--setfromfile
|
指定したファイルの中にある名前 = 値のペアを site.xconf ファイルの末尾に追加すると、各プロパティの名前は指定された値に設定されます。値セットがデフォルトかどうかを判断するチェックは行われません。
<プロパティファイル> は、一連の名前 = 値ペア (1 行に 1 ペア) が含まれるファイルです。このペアは、1 つのターゲットプロパティファイルで設定するプロパティと値を示します。各ペアで、1 つのプロパティの値が設定されます。
このパラメータを使用すれば、1 つの xconfmanager コマンドを使用して、同じターゲットプロパティファイルに複数のプロパティを設定できます。別々のターゲットプロパティファイルにあるプロパティを設定するには、ターゲットファイルごとに 1 つずつ、複数の xconfmanager コマンドを入力します。
このパラメータは、-t パラメータとともに使用します。
|
|
-t
または
--targetfile
|
-s パラメータまたは以下のパラメータで指定されているプロパティ値を設定するプロパティファイルを識別します。
--setfromfile
このパラメータは、-s または以下のパラメータとともに使用します。
--setfromfile
共通のプロパティを設定して更新するデフォルトプロパティファイルを宣言し、それらのプロパティを xconfmanager ユーティリティで使用できる場合、このパラメータは省略可能です。たとえば、wt.properties および db.properties に格納されているプロパティはこのパラメータを必要としません。
その他のプロパティについては、該当するプロパティファイルのファイルパスをこのパラメータで指定する必要があります。たとえば、federation.properties ファイルのプロパティを更新する場合、codebase/federation.properties ファイルパスを使用してこのパラメータを入力する必要があります。
|
|
-u|w
または
--unix|win
|
プロパティファイルの生成対象であるプラットフォームを示します。通常は、現在のプラットフォームの設定によりプロパティファイルのフォーマットが決まります。
このパラメータは、現在のプラットフォームとは異なる特定のプラットフォーム用にプロパティファイルを生成するときに指定します。
UNIX プラットフォームでは、-u または以下を指定します。
--unix
Windows プラットフォームでは、-w または以下を指定します。
--win
|
|
--undefine
|
java.util.Properties インスタンスを使用して読み取ったときに値が空の文字列ではなく Null になるように、指定されたプロパティをリセットします。
|
|
-v
|
例外のスタックトレースをすべて表示する、詳細コンソールの出力をオンにします。
|
|
-V
|
詳細コンソールのデバッグをオンにします。このオプションでは、例外のスタックトレースすべてと、追加情報が表示されます。
|
|
--validateasdecl
|
特定のファイルを宣言 XCONF ファイルとして検証します。
ファイルが検証できない場合、ゼロ以外の結果が返されます。
|
|
--validatefilesasdecl
|
ファイルのリストを宣言 XCONF ファイルとして検証します。このリストは、指定したファイルに含まれます。このファイルの各行は、宣言 XCONF ファイルの完全 URL または相対ファイルパスです。
検証できないファイルがある場合、ゼロ以外の結果が返されます。
<宣言リストファイル> は、検証する宣言 XCONF ファイルのリストを含むファイルの完全 URL または相対ファイルパスです。
|
|
--validatefilesassite
|
ファイルのリストをサイト固有の XCONF ファイルとして検証します。このリストは、指定したファイルに含まれます。このファイルの各行は、サイト固有の XCONF ファイルの完全 URL または相対ファイルパスです。
検証できないファイルがある場合、ゼロ以外の結果が返されます。
<サイトリストファイル> は、検証するサイト固有 XCONF ファイルのリストを含むファイルの完全 URL または相対ファイルパスです。
|
|
--validateassite
|
特定のファイルをサイト固有 XCONF ファイルとして検証します。
ファイルが検証できない場合、ゼロ以外の結果が返されます。
<site_xconf> は、検証するサイト固有 XCONF ファイルの完全 URL または相対ファイルパスです。
|
 |
xconfmanager は、コマンドで指定されている順序で以下のパラメータを実行します。
-s, --reset, --add, --remove, --undefine
つまり、複数のパラメータで同じプロパティを設定した場合、最後の設定が使用されます。
|
xconfmanager による値の設定、再設定、追加、削除、および定義解除では、常に、前に指定されているパラメータを実行した後で -p パラメータが実行されます。これは、パラメータの設定をすべて反映させるためです。
さらに、必ず、前に指定されているパラメータを実行した後で -d パラメータが実行されます。これは、返される説明に、コマンドで実行されたパラメータの設定をすべて含めるためです。