基本自定义 > Windchill 自定义基础 > Windchill 实用程序 > 使用 xconfmanager 实用程序 > xconfmanager 命令语法
  
xconfmanager 命令语法
管理员应使用的 xconfmanager 命令的语法如下:
xconfmanager {-fFhuwvV} {-r <product_root>} {-d <property_names>} {-s
<property_pair>} {-t <property_file>} {--add <property_pair>} {--remove
<property_pair>} {--reset <property_names>} {--setfromfile <property_file>}
{--undefine <property_names>} {-i <declarative_xconf>} {--validateassite
<site_xconf>} {--validateasdecl <declarative_xconf>} {--validatefilesassite
<site_list_file>} {--validatefilesasdecl <declar_list_file>} {-p}
语法中的括号 ({}) 表示可选的和一起指定的参数。语法中仅包含每个参数名称的缩写。参数名称是区分大小写的,使用在语法中和下表所示的大小写形式输入名称。
下列变量用于多个参数的语法中:
<property_pair> 是一个命令行转换 name=value 对,它符合 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 参数中指定目标文件路径的基础。
默认根目录是 bin 目录 (Windchill 解决方案的安装目录)。
--remove
移除已在特性中定义的有序特性值集中的指定值。只有在将属性声明为多值属性时,才使用此选项。
要确定特性是否为多值,可以使用 -d 参数显示当前特性值集。如果该属性是多值属性,则此参数的输出会列出多值分隔符。
--reset
将一个属性或属性集的站点指定值重置为声明后的默认值。
-s
或者
--set
将命名的属性设置为 site.xconf 文件中指定的值。
要在同一目标属性文件中设置多个属性,请使用此参数的多个具体值或使用以下参数:
--setfromfile
要在不同目标属性文件中设置多个属性,请输入多个 xconfmanager 命令,每个目标文件使用一个命令。
此参数和 -t 参数一起使用。
--setfromfile
将位于指定文件中的 name=value 对添加到 site.xconf 文件的末尾,从而将指定的每个属性设置为指定值。不执行确认值集是否设置为默认值的检查。
<property_file> 是包含一组 name=value 对 (每行对应一对) 的文件,表示在一个目标属性文件中要设置的属性和值。每对为一个属性设置一个值。
通过此参数,可以使用一个 xconfmanager 命令在同一目标属性文件中设置多个属性。要设置不同目标属性文件中的属性,请输入多个 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 或相对文件路径。
如果无法验证任何文件,则返回非零结果。
<declar_list_file> 是文件的完整 URL 或相对文件路径,此文件包含需要验证的声明的 XCONF 文件的列表。
--validatefilesassite
验证文件列表是否可作为特定站点的 XCONF 文件。列表包含在指定文件中,其中文件的每一行都是站点特定的 XCONF 文件的完整 URL 或相对文件路径。
如果无法验证任何文件,则返回非零结果。
<site_list_file> 是文件的完整 URL 或相对文件路径,此文件包含需要验证的站点特定的 XCONF 文件的列表。
--validateassite
验证特定文件是否可作为站点特定的 XCONF 文件。
如果无法验证该文件,则会返回非零结果。
<site_xconf> 是您要验证的站点特定的 XCONF 文件的完整 URL 或相对文件路径。
* 
xconfmanager 按以下参数在命令中的指定顺序执行这些参数:
-s, --reset, --add, --remove, --undefine
这意味着如果在多个参数中设置同一个属性,则使用最后的设置。
xconfmanager 始终在执行先前为设置、重置、添加、删除和取消定义值列出的参数后执行 -p 参数。这样做可将所有参数设置包括在传播中。
此外,xconfmanager 始终在执行先前列出的参数后执行 -d 参数。这样可以使返回的说明中包括对命令所做的所有参数设置。