Changing the location of Client work files: Difference between revisions

From m204wiki
Jump to navigation Jump to search
(Created page with "__TOC__ <span class="f_Para">The Debugger Client uses a variety of text files to store information about user activity to maintain its tools and displays, as well as a compreh...")
 
No edit summary
Line 1: Line 1:
__TOC__
__TOC__
<span class="f_Para">The Debugger Client uses a variety of text files to store information about user activity to maintain its tools and displays, as well as a comprehensive troubleshooting log. These work files are catalogued [[change_location_client_work.html#client_work_file_sum|below]]. </span>
<span class="f_Para">The Debugger Client uses a variety of text files to store information about user activity to maintain its tools and displays, as well as a comprehensive troubleshooting log. These work files are catalogued [[Changing the location of Client work files#A summary of the Client files|below]]. </span>


<span class="f_Para">The Client [[customize_debugger_cfg_file.html|configuration file]] (</span><span class="f_Monospace">debuggerConfig.xml</span><span class="f_Para">) has optional XML elements with which you can specify alternative folder locations for the Client work files. The files are divided into three groups, each of which is controlled by a single element, as follows: </span>
<span class="f_Para">The Client [[Customize debuggerConfig file|configuration file]] (</span><span class="f_Monospace">debuggerConfig.xml</span><span class="f_Para">) has optional XML elements with which you can specify alternative folder locations for the Client work files. The files are divided into three groups, each of which is controlled by a single element, as follows: </span>


* <span class="f_MonoBold">&lt;stateFileFolder&gt;</span><span class="f_ListBul1"> specifies where most Client work files are written (log, preferences, searches, for example) </span>
* <span class="f_MonoBold">&lt;stateFileFolder&gt;</span><span class="f_ListBul1"> specifies where most Client work files are written (log, preferences, searches, for example) </span>
Line 10: Line 10:
<span class="f_Para">Within </span><span class="f_Monospace">debuggerConfig.xml</span><span class="f_Para">, you specify folder path values for the elements as in the following: </span>
<span class="f_Para">Within </span><span class="f_Monospace">debuggerConfig.xml</span><span class="f_Para">, you specify folder path values for the elements as in the following: </span>


<p class="syntax"><span class="f_CodeExample">&lt;debuggerConfig version=&quot;1.0&quot;&gt;</span><br />
<p class="syntax"><span class="f_CodeExample">&lt;debuggerConfig version=&quot;1.0&quot;&gt;</span>
<span class="f_CodeExample">       ...</span><br />
<span class="f_CodeExample">       ...</span>
<span class="f_CodeExample">    &lt;stateFileFolder&gt;c:\myData&lt;/stateFileFolder&gt;</span><br />
<span class="f_CodeExample">    &lt;stateFileFolder&gt;c:\myData&lt;/stateFileFolder&gt;</span>
<span class="f_CodeExample">    &lt;uiFolder&gt;c:\myUI&lt;/uiFolder&gt; </span><br />
<span class="f_CodeExample">    &lt;uiFolder&gt;c:\myUI&lt;/uiFolder&gt; </span>
<span class="f_CodeExample">    &lt;macroLibraryFolder&gt;c:\work\macroLibrary&lt;/macroLibraryFolder&gt;</span><br />
<span class="f_CodeExample">    &lt;macroLibraryFolder&gt;c:\work\macroLibrary&lt;/macroLibraryFolder&gt;</span>
<span class="f_CodeExample">       ...</span><br />
<span class="f_CodeExample">       ...</span>
<span class="f_CodeExample">&lt;/debuggerConfig&gt; </span></p>
<span class="f_CodeExample">&lt;/debuggerConfig&gt; </span></p>


<span class="f_Para">If you include an element, the specified folder location is validated when the Client is started, and you receive an error if the folder is missing or not writable. The locations are also reported in the audit trail. </span>
<span class="f_Para">If you include an element, the specified folder location is validated when the Client is started, and you receive an error if the folder is missing or not writable. The locations are also reported in the audit trail. </span>


<span class="f_Para">If an element is not specified, the installation target folder is the assumed location. The exception to this is the </span><span class="f_Monospace">macroLibraryFolder</span><span class="f_Para"> element: if this element is </span><span class="f_EmphItal">not</span><span class="f_Para"> specified, the Client will initially attempt to store or find macro files in the </span><span class="f_CodeExample">stateFileFolder</span><span class="f_Para"> location, else in the Client installation folder. Similarly, if the </span><span class="f_Monospace">macroLibraryFolder</span><span class="f_Para"> element </span>''is''<span class="f_Para"> specified, the Client tries that location first, else it tries the </span><span class="f_Monospace">stateFileFolder</span><span class="f_Para"> location, else the Client installation folder. </span>
<span class="f_Para">If an element is not specified, the installation target folder is the assumed location. The exception to this is the </span><span class="f_Monospace">macroLibraryFolder</span><span class="f_Para"> element: if this element is </span><span class="term">not</span><span class="f_Para"> specified, the Client will initially attempt to store or find macro files in the </span><span class="f_CodeExample">stateFileFolder</span><span class="f_Para"> location, else in the Client installation folder. Similarly, if the </span><span class="f_Monospace">macroLibraryFolder</span><span class="f_Para"> element </span>''is''<span class="f_Para"> specified, the Client tries that location first, else it tries the </span><span class="f_Monospace">stateFileFolder</span><span class="f_Para"> location, else the Client installation folder. </span>


=== A summary of the Client files ===
=== A summary of the Client files ===
Line 35: Line 35:
|-
|-
| <span class="f_DefListDDTable">'''excludeProc.txt'''</span>
| <span class="f_DefListDDTable">'''excludeProc.txt'''</span>
| <span class="f_DefListDDTable">The list of procedures to be [[selectively_excluding_source.html|excluded from debugging]] </span>
| <span class="f_DefListDDTable">The list of procedures to be [[Selectively excluding source code blocks|excluded from debugging]] </span>
| <span class="f_DefListDDTable">stateFileFolder </span>
| <span class="f_DefListDDTable">stateFileFolder </span>
|-
|-
| <span class="f_DefListDDTable">'''excludeRoutine.txt'''</span>
| <span class="f_DefListDDTable">'''excludeRoutine.txt'''</span>
| <span class="f_DefListDDTable">The list of methods and subroutines to be [[selectively_excluding_source.html|excluded from debugging]] </span>
| <span class="f_DefListDDTable">The list of methods and subroutines to be [[Selectively excluding source code blocks|excluded from debugging]] </span>
| <span class="f_DefListDDTable">stateFileFolder </span>
| <span class="f_DefListDDTable">stateFileFolder </span>
|-
|-
Line 47: Line 47:
|-
|-
| <span class="f_DefListDDTable">'''includeProc.txt'''</span>
| <span class="f_DefListDDTable">'''includeProc.txt'''</span>
| <span class="f_DefListDDTable">The list of procedures </span>'''not'''<span class="f_DefListDDTable"> to be [[selectively_excluding_source.html|excluded from debugging]] </span>
| <span class="f_DefListDDTable">The list of procedures </span>'''not'''<span class="f_DefListDDTable"> to be [[Selectively excluding source code blocks|excluded from debugging]] </span>
| <span class="f_DefListDDTable">stateFileFolder </span>
| <span class="f_DefListDDTable">stateFileFolder </span>
|-
|-
| <span class="f_DefListDDTable">'''includeRoutine.txt'''</span>
| <span class="f_DefListDDTable">'''includeRoutine.txt'''</span>
| <span class="f_DefListDDTable">The list of methods and subroutines </span>'''not''' <span class="f_DefListDDTable">to be [[selectively_excluding_source.html|excluded from debugging]]   </span>
| <span class="f_DefListDDTable">The list of methods and subroutines </span>'''not''' <span class="f_DefListDDTable">to be [[Selectively excluding source code blocks|excluded from debugging]]   </span>
| <span class="f_DefListDDTable">stateFileFolder </span>
| <span class="f_DefListDDTable">stateFileFolder </span>
|-
|-
Line 59: Line 59:
|-
|-
| <span class="f_DefListDDTable">'''until.txt'''</span>
| <span class="f_DefListDDTable">'''until.txt'''</span>
| <span class="f_DefListDDTable">The most recent [[running_to_specific_procedure.html|run-until]] target procedures </span>
| <span class="f_DefListDDTable">The most recent [[Running to a specific procedure|run-until]] target procedures </span>
| <span class="f_DefListDDTable">stateFileFolder </span>
| <span class="f_DefListDDTable">stateFileFolder </span>
|-
|-
Line 67: Line 67:
|-
|-
| <span class="f_DefListDDTable">'''watchmemory.txt'''</span>
| <span class="f_DefListDDTable">'''watchmemory.txt'''</span>
| <span class="f_DefListDDTable">The contents of the </span><span class="f_GUIlabelTable">Watch Window</span><span class="f_DefListDDTable"> between Client runs (if [[add_item_to_watch_window.html#redisplay_item|feature]] is enabled) </span>
| <span class="f_DefListDDTable">The contents of the </span><span class="f_GUIlabelTable">Watch Window</span><span class="f_DefListDDTable"> between Client runs (if [[Add item to watch window#Redisplaying items|feature]] is enabled) </span>
| <span class="f_DefListDDTable">stateFileFolder </span>
| <span class="f_DefListDDTable">stateFileFolder </span>
|-
|-
| <span class="f_DefListDDTable">'''whitelist.txt'''</span>
| <span class="f_DefListDDTable">'''whitelist.txt'''</span>
| <span class="f_DefListDDTable">The [[run_only_to_listed_procs.html|white list]] of procedures to omit from debugging  </span>
| <span class="f_DefListDDTable">The [[Running only to listed procedures|white list]] of procedures to omit from debugging  </span>
| <span class="f_DefListDDTable">stateFileFolder </span>
| <span class="f_DefListDDTable">stateFileFolder </span>
|-
|-

Revision as of 03:18, 7 November 2022

The Debugger Client uses a variety of text files to store information about user activity to maintain its tools and displays, as well as a comprehensive troubleshooting log. These work files are catalogued below.

The Client configuration file (debuggerConfig.xml) has optional XML elements with which you can specify alternative folder locations for the Client work files. The files are divided into three groups, each of which is controlled by a single element, as follows:

  • <stateFileFolder> specifies where most Client work files are written (log, preferences, searches, for example)
  • <uiFolder> specifies where the Client interface-customization files (ui.xml, uimore.xml) are stored  
  • <macroLibraryFolder> specifies where Client macro files are stored  

Within debuggerConfig.xml, you specify folder path values for the elements as in the following:

<debuggerConfig version="1.0">        ...     <stateFileFolder>c:\myData</stateFileFolder>     <uiFolder>c:\myUI</uiFolder>      <macroLibraryFolder>c:\work\macroLibrary</macroLibraryFolder>        ... </debuggerConfig> 

If you include an element, the specified folder location is validated when the Client is started, and you receive an error if the folder is missing or not writable. The locations are also reported in the audit trail.

If an element is not specified, the installation target folder is the assumed location. The exception to this is the macroLibraryFolder element: if this element is not specified, the Client will initially attempt to store or find macro files in the stateFileFolder location, else in the Client installation folder. Similarly, if the macroLibraryFolder element is specified, the Client tries that location first, else it tries the stateFileFolder location, else the Client installation folder.

A summary of the Client files

File (by type) File content Configuration file element that specifies file default location
name.macro Client macro macroLibraryFolder
excludeProc.txt The list of procedures to be excluded from debugging stateFileFolder
excludeRoutine.txt The list of methods and subroutines to be excluded from debugging stateFileFolder
find.txt The most recent Search terms stateFileFolder
includeProc.txt The list of procedures not to be excluded from debugging stateFileFolder
includeRoutine.txt The list of methods and subroutines not to be excluded from debugging   stateFileFolder
log.txt The Debugger Client log stateFileFolder
until.txt The most recent run-until target procedures stateFileFolder
vars.txt The most recent entries in the text box above the Watch Window stateFileFolder
watchmemory.txt The contents of the Watch Window between Client runs (if feature is enabled) stateFileFolder
whitelist.txt The white list of procedures to omit from debugging   stateFileFolder
name.watch Saved Watch Window lists stateFileFolder
about.xml The remembered position and size of the Client's About box stateFileFolder
console.xml The remembered position and size of the Macro Console window stateFileFolder
getVariableList.xml The remembered position and size of the getVariablesForClass command output window stateFileFolder
history.xml The remembered position and size of the Execution History window stateFileFolder
preferences.xml The settings from the Preferences and Color Preferences dialog boxes stateFileFolder
shortcuts.xml The remembered position and size of the Keyboard Shortcuts window stateFileFolder
textviewer.xml The remembered position and size of the Text Viewer window stateFileFolder
ui.xml Modifications to the Client's default buttons and hot key associations uiFolder
uimore.xml Settings that override the  ui.xml file settings uiFolder
valueDisplay.xml Remembered position and size of Value window displays stateFileFolder
windowmemory.xml Remembered position and size of the main Debugger Client window stateFileFolder

See Also:

Alternative locations for Debugger documentation files