tm viewprefs
displays preferences for test management commands
Synopsis
tm viewprefs [--[no]global] [--command=value] [--[no]showValidValues] [--[no]ask] [--ui=[unspecified|gui|cli|api]] [(-?|--usage)] [(-N|--no)] [(-Y|--yes)] [(-F value|--selectionFile=value)] [--[no]batch] [--cwd=value] [--forceConfirm=[yes|no]] [(-g|--gui)] [--quiet] [--settingsUI=[gui|default]] [--status=[none|gui|default]]
Description
tm viewprefs displays preferences and configuration options for Windchill RV&S test management commands. These settings are used to determine default behaviors for other commands. You can only view one set of preferences at a time.
Options
This command takes the universal options available to all
Windchill RV&S 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, type the
tm viewprefs command, either piped through
|more or redirected to a file, for example:
tm viewprefs --global --showValidValues >prefs.txt
Alternatively, the --gui option presents a dialog box that lets you view and configure the preferences.
• --[no]global
specifies whether to show all preferences.
• --command=value
identifies the command that preferences are to be viewed for.
• --[no]showValidValues
specifies whether to display a list of valid values for the preferences.
• --[no]ask
specifies whether to show the ask preference. Each preference option may be set to either --ask or --noask. When the command itself is run, any option set to --ask and that is not explicitly set with command line options will be queried. If this --ask option is set, then you do not specify a value for the preference at the same time, but instead the pref=value must supply one of the following four valid ask values:
◦ once
asks the user the first time only, and then uses the provided value every time after.
◦ never
never asks the user for a response, but uses the current setting (which may be specified by a preference).
◦ element-last
asks the user for each element of the selection, providing the most recently used value as the default.
◦ element-pref
asks the user for each element of the selection, resetting the default to the value specified by the preference.
• --ui=[unspecified|gui|cli|api
controls whether to view the preference for the graphical user interface, the command line interface, or an unspecified interface. By default,
--ui=
cli is implied when using
tm viewprefs. To view preferences for GUI behavior, however, you should specify
--ui=
gui. For example, to view the preference for the
tm resulteditor command, type:
tm viewprefs --command=resulteditor --ui=gui
These correlate to settings in theIntegrityClient.rc file that have the gui.tm. or cli.tm. prefix, or the tm. prefix when it is unspecified.
See Also
• Commands:
tm setprefs.
tm createresult,
tm editresult,
tm viewresult,
tm extractattachments,
tm stepresults,
tm resulteditor,
tm deleteresult,
tm editresult,
tm testcases,
tm setresults,
tm results,
tm viewuntested