Specifying a startup command for the Client - Revision history

Ekern: Created page with "TOC Command line parameters are available to customize your invocation of the Client (JanusDebugger.exe).
2022-12-21T23:49:24Z

Created page with "TOC <span class="f_Para">Command line parameters are available to customize your invocation of the Client </span><span class="f_Monospace">(JanusDebugger.exe).</span><span..."

New page
TOC
<span class="f_Para">Command line parameters are available to customize your invocation of the Client </span><span class="f_Monospace">(JanusDebugger.exe).</span><span class="f_Para"> You can use these parameters in the following contexts: </span>

* <span class="f_ListBul1">Command prompt/DOS box or Windows Shell</span>

* <span class="f_ListBul1">A Windows shortcut that targets </span><span class="f_Monospace">JanusDebugger.exe</span><span class="f_ListBul1"> </span>

* <span class="f_ListBul1">A script (</span><span class="f_Monospace">.bat file</span><span class="f_ListBul1">) that invokes </span><span class="f_Monospace">JanusDebugger.exe</span><span class="f_ListBul1"> </span>

=== Syntax and general syntax rules ===

<span class="f_Para">Here is the command syntax: </span>

<p class="syntax"><span class="f_CodeExampleTable">JanusDebugger[.exe]</span><span class="f_CodeExampleTable" style="font-size: 11px;"> </span><span class="f_CodeExampleTable">[</span><span class="f_MonoItalTable">configFile</span><span class="f_CodeExampleTable">|]</span><span class="f_CodeExampleTable" style="font-size: 11px;"> </span><span class="f_CodeExampleTable">[</span><span class="f_MonoItalTable">proxyPort</span><span class="f_CodeExampleTable">|]</span><span class="f_CodeExampleTable" style="font-size: 11px;"> </span><span class="f_CodeExampleTable">[</span><span class="f_MonoItalTable">workFolder</span><span class="f_CodeExampleTable">]</span></p>

<span class="f_Para">Where: </span>

* <span class="f_ListBul1">The program name (</span><span class="f_Monospace">JanusDebugger</span><span class="f_ListBul1">) may be specified with or without the</span><span class="f_Monospace">.exe</span><span class="f_ListBul1"> qualifier. </span>

* <span class="f_ListBul1">One or more blanks must separate the parameters from each other and from the program name. </span>

* <span class="f_ListBul1">If a parameter value contains embedded blanks, enclose the value in double-quotation marks (the standard DOS way of handling embedded blanks). Single-quotation marks may not be used. For example: </span>

<p class="syntax"><span class="f_CodeExList">JanusDebugger "config file.xml" </span></p>

* <span class="f_ListBul1">Parameter position is important. To omit a parameter that precedes another, use an asterisk (</span><span class="f_Monospace"></span><span class="f_ListBul1">) for the parameter you are omitting. For example: </span>

<p class="syntax"><span class="f_CodeExList">JanusDebugger  999 </span>
<span class="f_CodeExList">JanusDebugger * * c:\workFile </span></p>

* <span class="f_ListBul1">The </span><span class="term">configFile</span><span class="f_ListBul1"> parameter is an absolute or relative path to an alternate Debugger configuration file (that is, to be used in place of the default file, </span><span class="f_Monospace">[[Customize debuggerConfig file|debuggerConfig.xml]]</span><span class="f_ListBul1">). A r</span><span class="f_ListContinue">elative path is relative to the application folder (the installation target). </span>

<span class="f_ListContinue">Examples: </span>

<p class="syntax"><span class="f_CodeExList">myConfig.xml           </span>(relative path)<span class="f_CodeExList"> </span>

<span class="f_CodeExList">"my Config.xml"        </span>(relative, embedded blanks)<span class="f_CodeExList"> </span>

<span class="f_CodeExList">a\myConfig.xml         </span>(relative path)<span class="f_CodeExList"> </span>

<span class="f_CodeExList">c:\folder\myConfig.xml </span>(absolute path)<span class="f_CodeExList"> </span></p>

* <span class="f_ListBul1">The </span><span class="term">proxyPort</span><span class="f_ListBul1"> parameter is an override for the proxy port number [[Customize debuggerConfig file#client_listening_port|specified]] in the default or the alternate Debugger configuration file. It must be an integer in the range 1 through 65535. </span>

* <span class="f_ListBul1">The </span><span class="term">workFolder</span><span class="f_ListBul1"> parameter specifies an </span><span class="f_EmphBold">absolute</span><span class="f_ListBul1"> file system path of a writable folder. The command is rejected if the folder does not exist, is not writable, or is relative. </span>

<span class="term">workFolder</span><span class="f_ListContinue"> is an alternate location for state and log files, preferences, macros, and UI customization files. These files, which belong to one of three folders, are described in [[Changing the location of Client work files#A summary of the Client files |A summary of the Client work files]]. </span>

=== Example ===

<span class="f_Para">Consider the following Client startup command: </span>

<p class="syntax"><span class="f_CodeExample">c:\appdir> </span><span class="f_MonoBold">janusdebugger * * c:\work</span><span class="f_CodeExample"> </span></p>

<span class="f_Para">This command makes the Debugger Client look for the following items in the </span><span class="f_Monospace">C:\work</span><span class="f_Para"> folder: </span>

* <span class="f_SimpleList">Client configuration file (</span><span class="f_Monospace">.xml</span><span class="f_SimpleList">)</span><br />
* <span class="f_SimpleList">A sub-folder for state files (see </span><span class="f_Monospace">stateFileFolder</span><span class="f_SimpleList"> tag below)</span><br />
* <span class="f_SimpleList">A sub-folder for UI files (see </span><span class="f_Monospace">uiFolder</span><span class="f_SimpleList"> tag below) </span><br />
* <span
class="f_SimpleList">A sub-folder for macro files (see </span><span class="f_Monospace">macroLibraryFolder</span><span class="f_SimpleList"> tag below) </span>

'''Note:'''<span class="f_Notes"> In the work folder, these items must </span><span class="f_EmphBold">not</span><span class="f_Notes"> be specified by an absolute path. </span>

<span class="f_Notes">For example, if </span><span class="term">workFolder</span><span class="f_Notes"> </span><span class="f_Monospace">C:\work</span><span class="f_Notes"> has this directory content: </span>

<p class="syntax"><span class="f_CodeExample">11/04/2013  11:28 AM          3,388 debuggerConfig.xml</span><br />
<span class="f_CodeExample">11/04/2013  11:13 AM    <DIR>       macros</span><br />
<span class="f_CodeExample">11/04/2013  11:28 AM    <DIR>       state</span><br />
<span class="f_CodeExample">11/04/2013  11:12 AM    <DIR>       uiconfig </span></p>

<span class="f_Para">And the </span><span class="f_Monospace">debuggerConfig.xml</span><span class="f_Para"> file has these folder tags: </span>

<p class="syntax"><span class="f_CodeExample"><stateFileFolder>state</stateFileFolder> </span><br />
<span class="f_CodeExample"><uiFolder>uiconfig</uiFolder> </span><br />
<span class="f_CodeExample"><macroLibraryFolder>macros</macroLibraryFolder> </span></p>

<span class="f_Para">The Client will do the following: </span>

* <span class="f_ListBul1">Look for the configuration file in: </span><span class="f_Monospace">C:\work</span><span class="f_ListBul1"> </span>

* <span class="f_ListBul1">Use this macroLibraryFolder: </span><span class="f_Monospace">C:\work\macros</span><span class="f_ListBul1"> </span>

* <span class="f_ListBul1">Use this stateFileFolder: </span><span class="f_Monospace">C:\work\state</span><span class="f_ListBul1"> </span>

* <span class="f_ListBul1">Use this uiFolder: </span><span class="f_Monospace">C:\work\uiconfig</span><span class="f_ListBul1"> </span>

* <span class="f_ListBul1">Report to the Client's </span><span class="f_GUIlabel">Help > About</span><span class="f_ListBul1"> box the locations of the preceding items </span>

[[Category:Debugger Home]]