si viewprefs
displays preferences
Synopsis
si viewprefs [--[no]global] [--command=value] [--[no]showValidValues] [--[no]ask] [--ui=[unspecified|gui|cli|api]] [(-?|--usage)] [(-N|--no)] [(-Y|--yes)] [--[no]batch] [--cwd=directory] [--forceConfirm=[yes|no]] [(-g|--gui)] [--quiet] [(-F file|--selectionFile=file)] [--settingsUI=[gui|default]] [--status=[none|gui|default]]
Description
si viewprefs displays preferences and configuration options. These settings are used to determine default behaviors for other commands.
Your administrator can lock certain preferences from the
Windchill RV&S Server, preventing you from configuring them using the
si setprefs command. Preferences that are locked display (locked) at the end of the output line. The following preferences can be locked from the server by editing
Windchill RV&S policies in the Administration Client:
|
|
For information on editing the Windchill RV&S policies, see the online help.
|
|
Preference
|
Affected Commands
|
|
branchIfVariant
|
|
|
breakLock
|
|
|
changePackageID
|
|
|
moveLock
|
|
|
onExistingArchive
|
|
|
restoreTimestamp
|
|
|
retainWorkingFile
|
|
|
saveTimestamp
|
|
|
sparse
|
|
|
updateMemberRev
|
|
|
Do not edit the IntegrityClient.rc file manually, because preferences that appear more than once in the IntegrityClient.rc file can cause Windchill RV&S to behave unpredictably.
|
|
Options
This command takes the universal options available to all
si commands, as well as some general options. See the
options reference page for descriptions. For an easy way to see a list of commands and values that may be set, simply type the
si viewprefs command, either piped through
|more or redirected to a file, for example:
si viewprefs --global --showValidValues >prefs.txt
Alternatively, the --gui option presents a simple-to-use dialog box that lets you view and configure the preferences.
• --[no]global
controls whether to view all preferences.
• --command=value
identifies the command preference to be viewed.
• --[no]showValidValues
controls whether to list valid values for the preferences.
• --[no]ask
controls whether to view the ask control over the preference options. See the description for
--[no]ask on the
si setprefs command.
• -ui=-[unspecified|gui|cli|api]
controls whether to view the preference as it applies to the graphical user interface, the command line interface, application programming interface, or when the interface is unspecified. By default, --ui=cli is implied when issuing the si viewprefs. To view preferences for GUI behavior, however, you should specify --ui=gui.
The preferences you see correlate to settings in the IntegrityClient.rc file, which can be seen as having the gui.si. or cli.si. prefix, or simply the si. prefix when it is unspecified.
Diagnostics
See the
diagnostics reference page for possible exit status values.
Preferences
Using
si setprefs or
si viewprefs, you are able to set or view the preference keys for this command.
See Also
