Difference between revisions of "RCUG RootCause Command Reference"

From OC Systems Wiki!
Jump to: navigation, search
m
m
 
(34 intermediate revisions by 2 users not shown)
Line 1: Line 1:
  
<div><div>
+
<!--  <div><div>  -->
  
 
[[RCUG_7_Selected_Topics|Next]] [[RCUG_RootCause_GUI_Reference|Previous]] [[RCUG_Index|Index]] [[RCUG_Top|Top]]
 
[[RCUG_7_Selected_Topics|Next]] [[RCUG_RootCause_GUI_Reference|Previous]] [[RCUG_Index|Index]] [[RCUG_Top|Top]]
  
RootCause User Guide
+
'''RootCause User Guide'''
  
</div>
+
<!--  </div>  -->
  
 
= RootCause Command Reference =
 
= RootCause Command Reference =
 +
----
 +
 +
The following commands are available from the command line after RootCause has been installed and the setup script in the RootCause installation directory has been executed (see [[RCUG_4_Getting_Started#MARKER-9-508|Chapter 4, &quot;Getting Started&quot;]]).
 +
<!--  <A HREF="rcc-7.html#MARKER-9-508">Chapter 4, "Getting Started"</A>  -->
 +
<!--  [[RCUG_4_Getting_Started|CHAPTER 4 - Getting Started]]  -->
 +
<DIV ID=HEADING12-2></DIV>
 +
<DIV ID="UID-09command_rc.fm-998723"></DIV><DIV ID=MARKER-9-2009></DIV>
 +
<DIV ID=MARKER-9-2009></DIV>
 +
<!--  <H2>RootCause and Different Shells</H2>  -->
 +
== RootCause and Different Shells ==
 +
 +
Different shells on Solaris have different capabilities. The following differences apply to the different shells:
 +
<DIV ID=MARKER-2-2010></DIV><DIV ID=MARKER-2-2011></DIV>
 +
<!--  <H4>sh (Bourne shell):</H4>  -->
 +
==== sh (Bourne shell) ====
 +
 +
<DIV ID=MARKER-2-2012></DIV><DIV ID=MARKER-2-2013></DIV>
 +
The <CODE>rootcause_on</CODE> and <CODE>rootcause_off</CODE> commands are not available. Instead, you must use the dot commands:
 +
<DIV ID=MARKER-2-2014></DIV><DIV ID=MARKER-2-2015></DIV>
 +
<PRE>
 +
. rootcause_enable
 +
. rootcause_disable
 +
</PRE>
 +
<DIV ID=MARKER-2-2016></DIV>
 +
<!--  <H4>ksh (Korn shell)</H4>  -->
 +
==== ksh (Korn shell) ====
 +
 +
You may use <CODE>rootcause on</CODE> and <CODE>rootcause off</CODE> instead of <CODE>rootcause_on</CODE>, and <CODE>rootcause_off</CODE>, because rootcause is defined as a shell function. Note that RootCause requires that <CODE>ksh</CODE> be installed, though you need not use it as your shell.  On Linux you may have to install <CODE>pdksh</CODE>.
 +
<DIV ID=MARKER-2-2017></DIV>
 +
<!--  <H4>csh (C shell)</H4>  -->
 +
==== csh (C shell) ====
 +
 +
'''rootcause_on''' and '''rootcause_off''' are aliases defined in your shell when you "source" setup.csh. C shell does not support shell functions, so "rootcause on" and "rootcause off" won't work.
 +
<DIV ID=MARKER-2-2018></DIV>
 +
<!--  <H4>bash</H4>  -->
 +
==== bash ====
  
----
+
<DIV ID=MARKER-2-2019></DIV><DIV ID=MARKER-2-2020></DIV>
 +
<DIV ID=HEADING12-14></DIV><DIV ID="UID-09command_rc.fm-976940"></DIV>
 +
The setup script and shell functions for <CODE>ksh</CODE> work for <CODE>bash</CODE> as well. However, ksh is still needed for install_rootcause, rootcause_status, and other scripts.
 +
<!--  <H2> rootcause</H2>  -->
 +
== rootcause ==
  
The following commands are available from the command line after RootCause has been installed and the setup script in the RootCause installation directory has been executed (see <A HREF="rcc-7.html#MARKER-9-508">Chapter 4, "Getting Started"</A>). <A NAME=HEADING12-2></A><A NAME="UID-09command_rc.fm-998723"></A><H2><A NAME=MARKER-9-2009></A>RootCause and Different Shells</H2>
+
<DIV ID=MARKER-2-2021></DIV>
Different shells on Solaris have different capabilities. The following differences apply to the different shells:<H4><A NAME=MARKER-2-2010></A>sh (<A NAME=MARKER-2-2011></A>Bourne shell):</H4>
+
The <CODE>rootcause</CODE> command is designed to run in a simple, intuitive manner when default file names are used. When run with no arguments, it gives version and license information. When run with rootcause -h, it shows the following commands, which are described in detail in this chapter.
The <CODE><A NAME=MARKER-2-2012></A>rootcause_on</CODE> and <CODE><A NAME=MARKER-2-2013></A>rootcause_off</CODE> commands are not available. Instead, you must use the dot commands:<PRE>
+
<DL>
. <A NAME=MARKER-2-2014></A>rootcause_enable
+
<DT>'''[[#MARKER-9-2022|rootcause build]]'''<DD> build traces/probes in workspace.
. <A NAME=MARKER-2-2015></A>rootcause_disable
+
<DT>'''[[#MARKER-9-2027|rootcause collect]]'''<DD> collect agent workspace data for analysis.
</PRE><H4><A NAME=MARKER-2-2016></A>ksh (Korn shell)</H4>
+
<DT>'''[[#MARKER-9-2039|rootcause config]]'''<DD> show current configuration information.
You may use <CODE>rootcause on</CODE> and <CODE>rootcause off</CODE> instead of <CODE>rootcause_on</CODE>, and <CODE>rootcause_off</CODE>, because rootcause is defined as a shell function. Note that RootCause requires that <CODE>ksh</CODE> be installed, though you need not use it as your shell.  On Linux you may have to install <CODE>pdksh</CODE>.<H4><A NAME=MARKER-2-2017></A>csh (C shell)</H4>
+
<DT>'''[[#MARKER-9-2051|rootcause decollect]]'''<DD> unpack collected workspace data for analysis.
rootcause_on and rootcause_off are aliases defined in your shell when you "source" setup.csh. C shell does not support shell functions, so "rootcause on" and "rootcause off" won't work.<H4><A NAME=MARKER-2-2018></A>bash</H4>
+
<DT>'''[[#MARKER-9-2053|rootcause deploy]]'''<DD> package a workspace for remote deployment.
The setup script and shell functions for <CODE>ksh</CODE> work for <CODE>bash</CODE> as well. However, ksh is still needed for <A NAME=MARKER-2-2019></A>install_rootcause, <A NAME=MARKER-2-2020></A>rootcause_status, and other scripts.<A NAME=HEADING12-14></A><A NAME="UID-09command_rc.fm-976940"></A><H2> rootcause</H2>
+
<DT>'''[[#MARKER-9-2063|rootcause format]]'''<DD> format data in workspace.
The <A NAME=MARKER-2-2021></A><CODE>rootcause</CODE> command is designed to run in a simple, intuitive manner when default file names are used. When run with no arguments, it gives version and license information. When run with rootcause -h, it shows the following commands, which are described in detail in this chapter.<DL>
+
<DT>'''[[#MARKER-9-2075|rootcause log]]'''<DD> perform operations on rootcause log file.
<DT>'''<A HREF="#MARKER-9-2022">rootcause build</A>'''<DD> build traces/probes in workspace.
+
<DT>'''[[#MARKER-9-2079|rootcause merge]]'''<DD> merge two workspaces to create a third.
<DT>'''<A HREF="#MARKER-9-2027">rootcause collect</A>'''<DD> collect agent workspace data for analysis.
+
<DT>'''[[#MARKER-9-2084|rootcause new]]'''<DD> create a new workspace.
<DT>'''<A HREF="#MARKER-9-2039">rootcause config</A>'''<DD> show current configuration information.
+
<DT>'''[[#MARKER-9-2089|rootcause_off]]'''<DD> disable rootcause intercept of applications.
<DT>'''<A HREF="#MARKER-9-2051">rootcause decollect</A>'''<DD> unpack collected workspace data for analysis.
+
<DT>'''[[#MARKER-9-2094|rootcause_on]]'''<DD> enable rootcause intercept of applications.
<DT>'''<A HREF="#MARKER-9-2053">rootcause deploy</A>'''<DD> package a workspace for remote deployment.
+
<DT>'''[[#MARKER-9-2101|rootcause open]]'''<DD> start the RootCause GUI.
<DT>'''<A HREF="#MARKER-9-2063">rootcause format</A>'''<DD> format data in workspace.
+
<DT>'''[[#MARKER-9-2107|rootcause register]]'''<DD> register an application with a workspace.
<DT>'''<A HREF="#MARKER-9-2075">rootcause log</A>'''<DD> perform operations on rootcause log file.
+
<DT>'''[[#MARKER-9-2119|rootcause run]]'''<DD> run any command under rootcause.
<DT>'''<A HREF="#MARKER-9-2079">rootcause merge</A>'''<DD> merge two workspaces to create a third.
+
<DT>'''[[#MARKER-9-2129|rootcause status]]'''<DD> show if rootcause is enabled.
<DT>'''<A HREF="#MARKER-9-2084">rootcause new</A>'''<DD> create a new workspace.
+
<DIV ID=HEADING12-32></DIV><DIV ID="UID-09command_rc.fm-973633"></DIV>
<DT>'''<A HREF="#MARKER-9-2089">rootcause_off</A>'''<DD> disable rootcause intercept of applications.
+
<DT>'''[[#MARKER-9-2127|rootcause xrun]]'''<DD> run a command under rootcause in a separate window.
<DT>'''<A HREF="#MARKER-9-2094">rootcause_on</A>'''<DD> enable rootcause intercept of applications.
+
</DL>
<DT>'''<A HREF="#MARKER-9-2101">rootcause open</A>'''<DD> start the RootCause GUI.
 
<DT>'''<A HREF="#MARKER-9-2107">rootcause register</A>'''<DD> register an application with a workspace.
 
<DT>'''<A HREF="#MARKER-9-2119">rootcause run</A>'''<DD> run any command under rootcause.
 
<DT>'''<A HREF="#MARKER-9-2129">rootcause status</A>'''<DD> show if rootcause is enabled.
 
<DT>'''<A HREF="#MARKER-9-2127">rootcause xrun</A>'''<DD> run a command under rootcause in a separate window.</DL><A NAME=HEADING12-32></A><A NAME="UID-09command_rc.fm-973633"></A>
 
 
----
 
----
<H2><A NAME=MARKER-9-2022></A>rootcause build</H2>
+
<DIV ID=MARKER-9-2022></DIV>
The <CODE><A NAME=MARKER-2-2023></A>rootcause <A NAME=MARKER-2-2024></A>build</CODE> command updates a RootCause workspace without opening the GUI. This is useful for maintaining workspaces as part of a script-driven product development process. The location of a workspace is provided, along with paths to all relevant programs and modules whose locations or contents may have changed.  Note that a side-effect of this process may be to lose traces that no longer apply to a changed module.<H4> Syntax:</H4><PRE>  
+
<!-- <H2>rootcause build</H2> -->
rootcause build
+
== rootcause build ==
['''-Fh'''] [ '''-x'''<EM>program_file</EM> | <EM>file</EM>.class | <EM>file</EM>.jar ]
 
['''-m'''<EM>module</EM>]*
 
['''-w'''] <EM>workspace</EM>.aws
 
  
</PRE><H4> Options:</H4><DL>
+
<DIV ID=MARKER-2-2023></DIV><DIV ID=MARKER-2-2024></DIV>
 +
The <CODE>rootcause build</CODE> command updates a RootCause workspace without opening the GUI. This is useful for maintaining workspaces as part of a script-driven product development process. The location of a workspace is provided, along with paths to all relevant programs and modules whose locations or contents may have changed.  Note that a side-effect of this process may be to lose traces that no longer apply to a changed module.
 +
<H4> Syntax:</H4>
 +
<code>
 +
rootcause build  ['''-Fh'''] [ '''-x'''<EM>program_file</EM> | <EM>file</EM>.class | <EM>file</EM>.jar ] ['''-m'''<EM>module</EM>]* ['''-w'''] <EM>workspace</EM>.aws
 +
</code>
 +
<H4> Options: </H4>
 +
<DL>
 
<DT>''''''-F''''''<DD> force the build even if the workspace is locked.
 
<DT>''''''-F''''''<DD> force the build even if the workspace is locked.
 
<DT>''''''-h''''''<DD> give this command's usage
 
<DT>''''''-h''''''<DD> give this command's usage
<DT>''''''-x <EM>program_file</EM>''''''<DD>
+
<DT>''''''-x <EM>program_file</EM>''''''<DD>the executable program, or the  <CODE>.class</CODE> or <CODE>.jar</CODE> file containing your Java application's main entry. This is the same as the argument to [[RCUG_RootCause_GUI_Reference#MARKER-9-1376|Reset Program]] in the GUI.
the executable program, or the  <CODE>.class</CODE> or <CODE>.jar</CODE> file containing your Java application's main entry. This is the same as the argument to <A HREF="rcc-11.html#MARKER-9-1376">Reset Program</A> in the GUI.
+
<!--  <A HREF="rcc-11.html#MARKER-9-1376">Reset Program</A> -->
<DT>''''''-m <EM>module</EM>''''''<DD> the path of a <A HREF="rcc-6.html#MARKER-9-416">dynamic module</A> that the program applies to. This is the same as the argument to <A HREF="rcc-11.html#MARKER-9-1386">Reset Dynamic Module</A> in the GUI.
+
<!--  [[RCUG_RootCause_GUI_Reference|CHAPTER 8 - RootCause GUI Reference]]  -->
<DT>''''''-w <EM>workspace</EM>'''.aws'''<DD>
+
<DT>''''''-m <EM>module</EM>''''''<DD> the path of a [[RCUG_3_Terminology_and_Concepts#MARKER-9-416|dynamic module]] that the program applies to.  This is the same as the argument to [[RCUG_RootCause_GUI_Reference#MARKER-9-1386|Reset Dynamic Module]] in the GUI.
an existing RootCause workspace.
+
<!--  <A HREF="rcc-6.html#MARKER-9-416">dynamic module</A>  -->
<DT><DD></DL><H4> Examples:</H4><OL><LI>
+
<!--  <A HREF="rcc-11.html#MARKER-9-1386">Reset Dynamic Module</A> -->
Rebuild workspace pi_demo.aws<A NAME=MARKER-10-2025></A> against current modules in case they've changed:  
+
<!--  [[RCUG_3_Terminology_and_Concepts|CHAPTER 3 - Terminology and Concepts]]  -->
 +
<!--  [[RCUG_RootCause_GUI_Reference|CHAPTER 8 - RootCause GUI Reference]]  -->
 +
<DT>''''''-w <EM>workspace</EM>'''.aws'''<DD>an existing RootCause workspace.
 +
<DT><DD>
 +
</DL>
 +
<H4> Examples:</H4>
 +
<OL>
 +
<DIV ID=MARKER-10-2025></DIV>
 +
<LI>Rebuild workspace pi_demo.aws against current modules in case they've changed:  
 
rootcause build Pi.aws  
 
rootcause build Pi.aws  
<LI>
+
<DIV ID=MARKER-10-2026></DIV>
Update the RootCause self-analysis workspace for the current installation location:<A NAME=MARKER-10-2026></A>rootcause build     -x $APROBE/lib/probeit.jar
+
<LI>Update the RootCause self-analysis workspace for the current installation location:
 +
rootcause build
 +
    -x $APROBE/lib/probeit.jar
 
     -m $APROBE/lib/libdebugInfo.so
 
     -m $APROBE/lib/libdebugInfo.so
 
     -w $APROBE/arca.aws  
 
     -w $APROBE/arca.aws  
</OL><A NAME=HEADING12-48></A><A NAME="UID-09command_rc.fm-973690"></A>
+
</OL>
 +
<DIV ID=HEADING12-48></DIV><DIV ID="UID-09command_rc.fm-973690"></DIV>
 
----
 
----
<H2><A NAME=MARKER-9-2027></A>rootcause collect</H2>
+
<DIV ID=MARKER-9-2027></DIV>
  The <CODE><A NAME=MARKER-2-2028></A>rootcause <A NAME=MARKER-2-2029></A>collect</CODE> command is executed on a <A NAME=MARKER-2-2030></A>remote computer where the <A NAME=MARKER-2-2031></A>RootCause Agent component has been installed to gather the RootCause data together into a single <CODE><A NAME=MARKER-2-2032></A>.clct</CODE> file to be transmitted to a computer where the RootCause GUI component has been installed for subsequent <A NAME=MARKER-2-2033></A>decollection and analysis. It examines the rootcause registry to determine the workspace for the applications<A NAME=MARKER-10-2034></A>, if no workspace is specified. Multiple applications<A NAME=MARKER-10-2035></A> and workspaces may be specified for collection.    If no arguments are supplied, the <A NAME=MARKER-2-2036></A>RootCause log and <A NAME=MARKER-2-2037></A>registry are collected.<H4> Syntax:</H4><PRE>  
+
<!--  <H2>rootcause collect</H2>  -->
rootcause collect   
+
 
[-'''AFh'''] [ '''-o'''<EM>clct_file</EM> ] [ '''-f''' other_file ]  
+
== rootcause collect ==
[ ['''-x''']  <EM>program_file</EM> | '''-c'''<EM>class</EM> | ['''-w'''] <EM>workspace</EM>.aws ]...  
+
 
</PRE><H4> Options:</H4><DL>
+
<DIV ID=MARKER-2-2028></DIV><DIV ID=MARKER-2-2029></DIV><DIV ID=MARKER-2-2030></DIV><DIV ID=MARKER-2-2031></DIV>
<DT>''''''-A''''''<DD> suppress generation and collection of <A HREF="rcc-6.html#MARKER-9-389">ADI file</A>s for native modules. This might be done to reduce the download size if you are sure the local and remote modules are identical.
+
<DIV ID=MARKER-2-2032></DIV><DIV ID=MARKER-2-2033></DIV><DIV ID=MARKER-10-2034></DIV><DIV ID=MARKER-10-2035></DIV><DIV ID=MARKER-2-2036></DIV><DIV ID=MARKER-2-2037></DIV>
 +
The <CODE>rootcause collect</CODE> command is executed on a remote computer where the RootCause Agent component has been installed to gather the RootCause data together into a single <CODE>.clct</CODE> file to be transmitted to a computer where the RootCause GUI component has been installed for subsequent decollection and analysis. It examines the rootcause registry to determine the workspace for the applications, if no workspace is specified. Multiple applications and workspaces may be specified for collection.    If no arguments are supplied, the RootCause log and registry are collected.
 +
<H4> Syntax:</H4>
 +
<code>
 +
rootcause collect  [-'''AFh'''] [ '''-o''' <EM>clct_file</EM> ] [ '''-f''' ''other_file'' ] [ ['''-x''']  <EM>program_file</EM> | '''-c''' <EM>class</EM> | ['''-w'''] <EM>workspace</EM>.aws ]...  
 +
</code>
 +
<H4> Options:</H4>
 +
<DL>
 +
<DT>''''''-A''''''<DD> suppress generation and collection of [[RCUG_3_Terminology_and_Concepts#MARKER-9-389|ADI file]]s for native modules. This might be done to reduce the download size if you are sure the local and remote modules are identical.
 +
<!--  <A HREF="rcc-6.html#MARKER-9-389">ADI file</A>  -->
 +
<!--  [[RCUG_3_Terminology_and_Concepts|CHAPTER 3 - Terminology and Concepts]]  -->
 
<DT>''''''-F''''''<DD> force overwriting of <EM>clct_file</EM>, if present.
 
<DT>''''''-F''''''<DD> force overwriting of <EM>clct_file</EM>, if present.
 
<DT>''''''-h''''''<DD> give this command's usage
 
<DT>''''''-h''''''<DD> give this command's usage
 
<DT>''''''-o <EM>clct_file</EM>''''''<DD> the collect file to create (default: <EM>first_argument</EM>.clct)
 
<DT>''''''-o <EM>clct_file</EM>''''''<DD> the collect file to create (default: <EM>first_argument</EM>.clct)
 
<DT>''''''-f <EM>other_file</EM>''''''<DD> any other file (not directory) to be added to the <EM>clct_file</EM>. You can also simply copy files or directories into the workspace.
 
<DT>''''''-f <EM>other_file</EM>''''''<DD> any other file (not directory) to be added to the <EM>clct_file</EM>. You can also simply copy files or directories into the workspace.
<DT>''''''-x <EM>program_file</EM>''''''<DD>
+
<DT>''''''-x <EM>program_file</EM>''''''<DD>the registered program to which deployed workspace applies
the registered program to which deployed workspace applies
 
 
<DT>''''''-c <EM>class</EM>''''''<DD> the registered Java class to which deployed workspace applies
 
<DT>''''''-c <EM>class</EM>''''''<DD> the registered Java class to which deployed workspace applies
<DT>''''''-w <EM>workspace</EM>''''''<DD>
+
<DT>''''''-w <EM>workspace</EM>''''''<DD>the workspace contents to be collected if program or class is not known
the workspace contents to be collected if program or class is not known</DL><H4> Examples:</H4><OL><LI>
+
</DL>
Collect the data logged in the workspace registered with program converter.exe and the workspace fred.aws, and places those two traces in the single file myserver.clct.  
+
<H4> Examples:</H4>
rootcause collect -x converter.exe -w fred.aws
+
 
-o myserver.clct  
+
<LI>Collect the data logged in the workspace registered with program converter.exe and the workspace fred.aws, and places those two traces in the single file myserver.clct.  
</OL><A NAME=HEADING12-64></A><A NAME="UID-09command_rc.fm-973736"></A>
+
<pre>
 +
rootcause collect -x converter.exe -w fred.aws -o myserver.clct  
 +
</pre>
 +
<DIV ID=HEADING12-64></DIV><DIV ID="UID-09command_rc.fm-973736"></DIV>
 
----
 
----
<H2><A NAME=MARKER-10-2038></A><A NAME=MARKER-9-2039></A>rootcause config</H2>
+
<DIV ID=MARKER-10-2038></DIV><DIV ID=MARKER-9-2039></DIV>
The <A NAME=MARKER-2-2040></A>rootcause config command reports current configuration information. With no arguments it shows the installation directory and license information.<H4> Syntax:</H4><PRE>  
+
<!--  <H2>rootcause config</H2> -->
 +
 
 +
== rootcause config ==
 +
 
 +
<DIV ID=MARKER-2-2040></DIV>
 +
The rootcause config command reports current configuration information. With no arguments it shows the installation directory and license information.
 +
<H4> Syntax:</H4>
 +
<code>
 
rootcause config [ '''-dhlLnRuvV''' ]  
 
rootcause config [ '''-dhlLnRuvV''' ]  
</PRE><H4> Options:</H4><DL>
+
</code>
<DT>''''''-d''''''<DD> give installation directory (that is, the value of $<A NAME=MARKER-10-2041></A><A HREF="rcc-10.html#MARKER-9-979">APROBE</A><A NAME=MARKER-10-2042></A>)
+
<H4> Options:</H4>
 +
<DL>
 +
<DIV ID=MARKER-10-2041></DIV><DIV ID=MARKER-10-2042></DIV>
 +
<DT>''''''-d''''''<DD> give installation directory (that is, the value of $[[RCUG_RootCause_Files_and_Environment_Variables#MARKER-9-979|APROBE]])
 +
<!--  <A HREF="rcc-10.html#MARKER-9-979">APROBE</A> -->
 +
<!--  [[RCUG_RootCause_Files_and_Environment_Variables|CHAPTER 7 - RootCause Files and Environment Variables]]  -->
 
<DT>''''''-h''''''<DD> give this command's usage
 
<DT>''''''-h''''''<DD> give this command's usage
 
<DT>''''''-l''''''<DD> give license information
 
<DT>''''''-l''''''<DD> give license information
<DT>''''''-L''''''<DD> give application log path ($<A NAME=MARKER-10-2043></A>APROBE_LOG<A NAME=MARKER-10-2044></A> or default location).
+
<DIV ID=MARKER-10-2043></DIV><DIV ID=MARKER-10-2044></DIV>
 +
<DT>''''''-L''''''<DD> give application log path ($APROBE_LOG or default location).
 
<DT>''''''-n''''''<DD> give product name (Console or Agent).
 
<DT>''''''-n''''''<DD> give product name (Console or Agent).
<DT>''''''-R''''''<DD> give application log path ($<A NAME=MARKER-10-2045></A>APROBE_REGISTRY<A NAME=MARKER-10-2046></A> or default location).
+
<DIV ID=MARKER-10-2045></DIV><DIV ID=MARKER-10-2046></DIV>
<DT>''''''-u''''''<DD> give user directory ($<A NAME=MARKER-10-2047></A><A HREF="rcc-10.html#MARKER-9-982">APROBE_HOME</A><A NAME=MARKER-10-2048></A> or default).
+
<DT>''''''-R''''''<DD> give application log path ($APROBE_REGISTRY or default location).
 +
<DIV ID=MARKER-10-2047></DIV><DIV ID=MARKER-10-2048></DIV>
 +
<DT>''''''-u''''''<DD> give user directory ($[[RCUG_RootCause_Files_and_Environment_Variables#MARKER-9-982|APROBE_HOME]] or default).
 +
<!--  <A HREF="rcc-10.html#MARKER-9-982">APROBE_HOME</A> -->
 +
<!--  [[RCUG_RootCause_Files_and_Environment_Variables|CHAPTER 7 - RootCause Files and Environment Variables]]  -->
 
<DT>''''''-v''''''<DD> give product version number.
 
<DT>''''''-v''''''<DD> give product version number.
<DT>''''''-V''''''<DD> give product version description (default).</DL><H4> Examples:</H4><OL><LI>
+
<DT>''''''-V''''''<DD> give product version description (default).
Show the current installation information:  
+
</DL>
$<A NAME=MARKER-10-2049></A> rootcause config
+
<H4> Examples:</H4>
 +
 
 +
<li>Show the current installation information:  
 +
<pre>
 +
$ rootcause config
 
RootCause Console 2.0.5 (030405)
 
RootCause Console 2.0.5 (030405)
 
Installed in /app1/product/aprobe
 
Installed in /app1/product/aprobe
<A NAME=MARKER-10-2050></A>This product is licensed to 1111 OC Systems, Inc.
+
This product is licensed to 1111 OC Systems, Inc.
 
This license will expire on 31-dec-2006.
 
This license will expire on 31-dec-2006.
</OL><A NAME=HEADING12-81></A><A NAME="UID-09command_rc.fm-973510"></A>
+
</pre>
 +
<DIV ID=HEADING12-81></DIV><DIV ID="UID-09command_rc.fm-973510"></DIV>
 
----
 
----
<H2><A NAME=MARKER-9-2051></A>rootcause decollect</H2>
+
<DIV ID=MARKER-9-2051></DIV>
The <A NAME=MARKER-2-2052></A>rootcause decollect command unpackas a '''.clct''' file built by the <A HREF="#MARKER-9-2027">rootcause collect</A> command. This function is also performed by the <A HREF="rcc-11.html#MARKER-9-1430">Decollect</A> operation in the RootCause GUI (see <A HREF="rcc-11.html#MARKER-9-1528">"Decollect Data Dialog"</A>).
+
<!--  <H2>rootcause decollect</H2>  -->
  The result of this operation is a directory tree whose root directory has suffix '''.dclct'''.<H4> Syntax:</H4><PRE>  
+
 
rootcause decollect ['''-F'''] ['''-o'''<EM>directory</EM>] <EM>clct_file</EM></PRE><H4> Options:</H4><DL>
+
== rootcause decollect ==
 +
 
 +
<DIV ID=MARKER-2-2052></DIV>
 +
The rootcause decollect command unpackas a '''.clct''' file built by the  
 +
[[#MARKER-9-2027|rootcause collect]] command. This function is also performed by the [[RCUG_RootCause_GUI_Reference#MARKER-9-1430|Decollect]] operation in the RootCause GUI (see [[RCUG_RootCause_GUI_Reference#MARKER-9-1528|"Decollect Data Dialog"]]).
 +
<!--  <A HREF="rcc-11.html#MARKER-9-1430">Decollect</A> -->
 +
<!--  <A HREF="rcc-11.html#MARKER-9-1528">"Decollect Data Dialog"</A> -->
 +
<!--  [[RCUG_RootCause_GUI_Reference|CHAPTER 8 - RootCause GUI Reference]] -->
 +
 
 +
The result of this operation is a directory tree whose root directory has suffix '''.dclct'''.
 +
<H4> Syntax:</H4>
 +
<code>
 +
rootcause decollect ['''-F'''] ['''-o''' <EM>directory</EM>] <EM>clct_file</EM>
 +
</code>
 +
<H4> Options:</H4>
 +
<DL>
 
<DT>''''''-F''''''<DD> force delete of <EM>directory</EM>, if present
 
<DT>''''''-F''''''<DD> force delete of <EM>directory</EM>, if present
 
<DT>''''''-o<EM> directory</EM>''''''<DD> extract into <EM>directory</EM> (default: <EM>clct_file_name</EM>.dclct)
 
<DT>''''''-o<EM> directory</EM>''''''<DD> extract into <EM>directory</EM> (default: <EM>clct_file_name</EM>.dclct)
<DT>'''<EM>clct_file</EM>'''<DD>  collect file that was built by <A HREF="#MARKER-9-2027">rootcause collect</A></DL><H4> Examples:</H4><OL><LI>
+
<DT>'''<EM>clct_file</EM>'''<DD>  collect file that was built by [[#MARKER-9-2027|rootcause collect]]
Decollect the data in <CODE>myserver.clct</CODE> into <CODE>myserver.dclct</CODE>  
+
</DL>
 +
<H4> Examples:</H4>
 +
 
 +
<LI>Decollect the data in <CODE>myserver.clct</CODE> into <CODE>myserver.dclct</CODE>
 +
<pre>
 
rootcause decollect myserver.clct  
 
rootcause decollect myserver.clct  
</OL><A NAME=HEADING12-93></A><A NAME="UID-09command_rc.fm-974261"></A>
+
</pre>
 +
<DIV ID=HEADING12-93></DIV><DIV ID="UID-09command_rc.fm-974261"></DIV>
 
----
 
----
<H2><A NAME=MARKER-9-2053></A>rootcause deploy</H2>
+
<DIV ID=MARKER-9-2053></DIV>
The <A NAME=MARKER-2-2054></A>rootcause deploy command packages a <A HREF="rcc-6.html#MARKER-9-482">workspace</A> for use in a <A HREF="rcc-6.html#MARKER-9-456">remote</A> (<A HREF="rcc-6.html#MARKER-9-399">agent</A>) environment. This function is also performed by the <A HREF="rcc-11.html#MARKER-9-1429">Deploy</A> operation in the RootCause GUI (see <A HREF="rcc-11.html#MARKER-9-1520">"Deploy Dialog"</A>). The result of this operation is a zip file with suffix '''.dply'''.  '''Note''' that this command does not verify the workspace is already built. If you're not sure, do <A HREF="#MARKER-9-2022">rootcause build</A> first.<H4> Syntax:</H4><PRE>  
+
<!--  <H2>rootcause deploy</H2> -->
 +
 
 +
== rootcause deploy ==
 +
 
 +
<DIV ID=MARKER-2-2054></DIV>
 +
The rootcause deploy command packages a [[RCUG_3_Terminology_and_Concepts#MARKER-9-482|workspace]] for use in a [[RCUG_3_Terminology_and_Concepts#MARKER-9-456|remote]] ([[RCUG_3_Terminology_and_Concepts#MARKER-9-399|agent]]) environment. This function is also performed by the [[RCUG_RootCause_GUI_Reference#MARKER-9-1429|Deploy]] operation in the RootCause GUI (see [[RCUG_RootCause_GUI_Reference#MARKER-9-1520|"Deploy Dialog"]]). The result of this operation is a zip file with suffix '''.dply'''.  '''Note''' that this command does not verify the workspace is already built. If you're not sure, do [[#MARKER-9-2022|rootcause build]] first.
 +
<!--  <A HREF="rcc-6.html#MARKER-9-482">workspace</A>  -->
 +
<!--  <A HREF="rcc-6.html#MARKER-9-456">remote</A>  -->
 +
<!--  <A HREF="rcc-6.html#MARKER-9-399">agent</A>  -->
 +
<!--  <A HREF="rcc-11.html#MARKER-9-1429">Deploy</A> -->
 +
<!--  <A HREF="rcc-11.html#MARKER-9-1520">"Deploy Dialog"</A>  -->
 +
<!--  [[RCUG_3_Terminology_and_Concepts|CHAPTER 3 - Terminology and Concepts]]  -->
 +
<!--  [[RCUG_RootCause_GUI_Reference|CHAPTER 8 - RootCause GUI Reference]]  -->
 +
<H4> Syntax:</H4>
 +
<code>
 
rootcause deploy   
 
rootcause deploy   
['''-Fh'''][ ['''-x'''] <EM>program_file</EM> | ['''-c'''<EM>class</EM>] ['''-w''']<EM>workspace</EM>.aws ]  
+
['''-Fh'''][ ['''-x'''] <EM>program_file</EM> | ['''-c''' <EM>class</EM>] ['''-w'''] <EM>workspace</EM>.aws ]  
['''-l'''<EM>license_file</EM>] ['''-m'''<EM>module</EM>]['''-o'''<EM>dply_file</EM>]  
+
['''-l''' <EM>license_file</EM>] ['''-m''' <EM>module</EM>]['''-o''' <EM>dply_file</EM>]  
</PRE><H4> Options:</H4><DL>
+
</code>
 +
<H4> Options:</H4>
 +
<DL>
 
<DT>''''''-c <EM>class</EM>''''''<DD> the Java class registered with the workspace you wish to deploy.
 
<DT>''''''-c <EM>class</EM>''''''<DD> the Java class registered with the workspace you wish to deploy.
 
<DT>''''''-F''''''<DD> force overwriting of <EM>dply_file</EM>, if present.
 
<DT>''''''-F''''''<DD> force overwriting of <EM>dply_file</EM>, if present.
 
<DT>''''''-h''''''<DD> give this command's usage
 
<DT>''''''-h''''''<DD> give this command's usage
<DT>''''''-l <EM>license_file</EM>''''''<DD>
+
<DIV ID=MARKER-10-2055></DIV>
the agent license file to include in the deployed workspace (default <CODE>$APROBE/licenses/<A NAME=MARKER-10-2055></A>agent_license.dat</CODE>.
+
<DT>''''''-l <EM>license_file</EM>''''''<DD>the agent license file to include in the deployed workspace (default <CODE>$APROBE/licenses/agent_license.dat</CODE>.
<DT>''''''-m <EM>module</EM>''''''<DD>  is a <A HREF="rcc-6.html#MARKER-9-440">module</A> (<A NAME=MARKER-10-2056></A><A HREF="rcc-6.html#MARKER-9-461">shared library</A>) for which an <A HREF="rcc-6.html#MARKER-9-389">ADI file</A> should be generated.
+
<DIV ID=MARKER-10-2056></DIV>
 +
<DT>''''''-m <EM>module</EM>''''''<DD>  is a [[RCUG_3_Terminology_and_Concepts#MARKER-9-440|module]] ([[RCUG_3_Terminology_and_Concepts#MARKER-9-461|shared library]]) for which an [[RCUG_3_Terminology_and_Concepts#MARKER-9-389|ADI file]] should be generated.
 +
<!--  <A HREF="rcc-6.html#MARKER-9-440">module</A> -->
 +
<!--  <A HREF="rcc-6.html#MARKER-9-461">shared library</A> -->
 +
<!--  <A HREF="rcc-6.html#MARKER-9-389">ADI file</A> -->
 +
<!--  [[RCUG_3_Terminology_and_Concepts|CHAPTER 3 - Terminology and Concepts]]  -->
 
<DT>''''''-o <EM>dply_file</EM>''''''<DD> the deploy file to create (default: <EM>workspace</EM>.clct)
 
<DT>''''''-o <EM>dply_file</EM>''''''<DD> the deploy file to create (default: <EM>workspace</EM>.clct)
<DT>''''''-x <EM>program_file</EM>''''''<DD>
+
<DT>''''''-x <EM>program_file</EM>''''''<DD>the program registered with the workspace you wish to deploy.
the program registered with the workspace you wish to deploy.
+
<DT>''''''-w <EM>workspace</EM>'''.aws'''<DD>an existing, <EM>built</EM> RootCause workspace.
<DT>''''''-w <EM>workspace</EM>'''.aws'''<DD>
+
</DL>
an existing, <EM>built</EM> RootCause workspace.</DL><H4> Examples:</H4><OL><LI>
+
<H4> Examples:</H4>
Deploy workspace pi_demo.aws<A NAME=MARKER-10-2057></A>.
+
<OL>
rootcause deploy pi_demo.aws<A NAME=MARKER-10-2058></A>.  
+
<DIV ID=MARKER-10-2057></DIV>
<LI>
+
<LI>Deploy workspace pi_demo.aws.
Deploy workspace for factor<A NAME=MARKER-10-2059></A> and module libFactor.so<A NAME=MARKER-10-2060></A> into Factor.dply.  
+
<DIV ID=MARKER-10-2058></DIV>
rootcause deploy -x /app/bin/factor<A NAME=MARKER-10-2061></A> -m <A NAME=MARKER-10-2062></A> -o Factor.dply  
+
<pre>
</OL><A NAME=HEADING12-111></A><A NAME="UID-09command_rc.fm-973769"></A>
+
rootcause deploy pi_demo.aws.  
 +
</pre>
 +
<DIV ID=MARKER-10-2059></DIV><DIV ID=MARKER-10-2060></DIV>
 +
<LI>Deploy workspace for factor and module libFactor.so into Factor.dply.  
 +
<DIV ID=MARKER-10-2061></DIV><DIV ID=MARKER-10-2062></DIV>
 +
<pre>
 +
rootcause deploy -x /app/bin/factor -m  -o Factor.dply  
 +
</pre>
 +
</OL>
 +
<DIV ID=HEADING12-111></DIV><DIV ID="UID-09command_rc.fm-973769"></DIV>
 
----
 
----
<H2><A NAME=MARKER-9-2063></A>rootcause format</H2>
+
<DIV ID=MARKER-9-2063></DIV>
The rootcause format command runs <A HREF="rcc-6.html#MARKER-9-400">apformat</A> on the data collected in the specified workspace. This produces output similar to that produced by <A HREF="rcc-11.html#MARKER-9-1743">Save As Text</A> in the RootCause GUI. By default <CODE>rootcause format</CODE> operates on the most current process. Because it formats all the data it can take a while for large amounts of data. You can use the -O option in conjunction with the apformat "-n" option to limit it to specific APD files, as shown in Example 3 below.<H4> Syntax:</H4><PRE>  
+
<!--  <H2>rootcause format</H2>  -->
rootcause format   
+
 
['''-hlr''']['''-p'''<EM>PID</EM>]['''-O''' "<EM>options</EM>"]['''-t'''<EM>tmpdir</EM>]  
+
== rootcause format ==
['''-w'''] <EM>workspace</EM>.aws  
+
 
</PRE><H4> Options:</H4><DL>
+
The rootcause format command runs [[RCUG_3_Terminology_and_Concepts#MARKER-9-400|apformat]] on the data collected in the specified workspace. This produces output similar to that produced by [[RCUG_RootCause_GUI_Reference#MARKER-9-1743|Save As Text]] in the RootCause GUI. By default <CODE>rootcause format</CODE> operates on the most current process. Because it formats all the data it can take a while for large amounts of data. You can use the -O option in conjunction with the apformat "-n" option to limit it to specific APD files, as shown in Example 3 below.
 +
<!--  <A HREF="rcc-6.html#MARKER-9-400">apformat</A>  -->
 +
<!--  <A HREF="rcc-11.html#MARKER-9-1743">Save As Text</A>  -->
 +
<!--  [[RCUG_3_Terminology_and_Concepts|CHAPTER 3 - Terminology and Concepts]]  -->
 +
<!--  [[RCUG_RootCause_GUI_Reference|CHAPTER 8 - RootCause GUI Reference]]  -->
 +
<H4> Syntax:</H4>
 +
<code>  
 +
rootcause format  ['''-hlr''']['''-p''' <EM>PID</EM>]['''-O''' "<EM>options</EM>"]['''-t''' <EM>tmpdir</EM>] ['''-w'''] <EM>workspace</EM>.aws  
 +
</code>
 +
<H4> Options:</H4>
 +
<DL>
 
<DT>''''''-h''''''<DD> give this command's usage
 
<DT>''''''-h''''''<DD> give this command's usage
<DT>''''''-l''''''<DD> list the <A HREF="rcc-6.html#MARKER-9-393">APD ring</A>s (<A HREF="rcc-6.html#MARKER-9-444">Process Data Set</A>s) in the workspace, but don't format anything. The newest data set is listed first.
+
<DT>''''''-l''''''<DD> list the [[RCUG_3_Terminology_and_Concepts#MARKER-9-393|APD ring]]s ([[RCUG_3_Terminology_and_Concepts#MARKER-9-444|Process Data Set]]s) in the workspace, but don't format anything. The newest data set is listed first.
 +
<!--  <A HREF="rcc-6.html#MARKER-9-393">APD ring</A> -->
 +
<!--  <A HREF="rcc-6.html#MARKER-9-444">Process Data Set</A> -->
 +
<!--  [[RCUG_3_Terminology_and_Concepts|CHAPTER 3 - Terminology and Concepts]]  -->
 
<DT>''''''-r''''''<DD> raw: just run apformat directly on the APD file (with options specified using '''-O''') rather than using the workspace's formatting script.
 
<DT>''''''-r''''''<DD> raw: just run apformat directly on the APD file (with options specified using '''-O''') rather than using the workspace's formatting script.
<DT>''''''-p <EM>PID</EM>''''''<DD> format data for the process given by <A HREF="rcc-6.html#MARKER-9-443">PID</A>
+
<DT>''''''-p <EM>PID</EM>''''''<DD> format data for the process given by [[RCUG_3_Terminology_and_Concepts#MARKER-9-443|PID]]
<DT>''''''-O "<EM>options"</EM>''''''<DD>
+
<!--  <A HREF="rcc-6.html#MARKER-9-443">PID</A>  -->
pass <EM>options</EM> to the apformat command. The options must be in quotes, and quotes in the options themselves must be preceded by a backslash.
+
<!--  [[RCUG_3_Terminology_and_Concepts|CHAPTER 3 - Terminology and Concepts]]  -->
 +
<DT>''''''-O "<EM>options"</EM>''''''<DD>pass <EM>options</EM> to the apformat command. The options must be in quotes, and quotes in the options themselves must be preceded by a backslash.
 
<DT>''''''-t <EM>tmpdir</EM>''''''<DD>  specifies the directory where intermediate files are to be produced. These can get very large--up to 10 times the size of the APD files depending on the formatting--and this can be used to avoid disk-space restrictions where the workspace resides.
 
<DT>''''''-t <EM>tmpdir</EM>''''''<DD>  specifies the directory where intermediate files are to be produced. These can get very large--up to 10 times the size of the APD files depending on the formatting--and this can be used to avoid disk-space restrictions where the workspace resides.
<DT>''''''-w<EM> workspace</EM>'''.aws'''<DD>
+
<DT>''''''-w<EM> workspace</EM>'''.aws'''<DD>the RootCause workspace containing the data to be formatted.
the RootCause workspace containing the data to be formatted.</DL><H4><A NAME=MARKER-9-2064></A>Examples:</H4><OL><LI>
+
</DL>
Format the newest data set in pi_demo.aws<A NAME=MARKER-10-2065></A> the file <CODE>pi_demo<A NAME=MARKER-10-2066></A>.txt</CODE>.  
+
<DIV ID=MARKER-9-2064></DIV>
rootcause format<CODE> pi_demo.aws<A NAME=MARKER-10-2067></A> > pi_demo<A NAME=MARKER-10-2068></A>.txt
+
<H4>Examples:</H4>
</CODE><LI>
+
<OL>
List the <A HREF="rcc-6.html#MARKER-9-444">Process Data Set</A> in workspace pi_demo.aws<A NAME=MARKER-10-2069></A>.
+
<DIV ID=MARKER-10-2065></DIV><DIV ID=MARKER-10-2066></DIV>
$<A NAME=MARKER-10-2070></A> rootcause format -l<CODE> pi_demo.aws<A NAME=MARKER-10-2071></A>
+
<LI>Format the newest data set in pi_demo.aws the file <CODE>pi_demo.txt</CODE>.  
</CODE>/work/pi_demo.aws/pi_demo.apd.11991/pi_demo.apd
+
<DIV ID=MARKER-10-2067></DIV><DIV ID=MARKER-10-2068></DIV>
 +
<code>
 +
$ rootcause format pi_demo.aws > pi_demo.txt</CODE>
 +
<DIV ID=MARKER-10-2069></DIV>
 +
<LI>List the [[RCUG_3_Terminology_and_Concepts#MARKER-9-444|Process Data Set]] in workspace pi_demo.aws.
 +
<!--  <A HREF="rcc-6.html#MARKER-9-444">Process Data Set</A> -->
 +
<!--  [[RCUG_3_Terminology_and_Concepts|CHAPTER 3 - Terminology and Concepts]]  -->
 +
<DIV ID=MARKER-10-2070></DIV><DIV ID=MARKER-10-2071></DIV>
 +
<code>
 +
$ rootcause format -l pi_demo.aws
 +
/work/pi_demo.aws/pi_demo.apd.11991/pi_demo.apd
 
/work/pi_demo.aws/pi_demo.apd.11785/pi_demo.apd
 
/work/pi_demo.aws/pi_demo.apd.11785/pi_demo.apd
<A NAME=MARKER-10-2072></A><LI>
+
</code>
Run <A HREF="rcc-6.html#MARKER-9-400">apformat</A> directly on the newest data file for process 11785 in pi_demo.aws<A NAME=MARKER-10-2073></A>.
+
<DIV ID=MARKER-10-2072></DIV><DIV ID=MARKER-10-2073></DIV>
rootcause format -r -O "-n 0" -p<CODE> 11785 pi_demo.aws<A NAME=MARKER-10-2074></A>
+
<LI>Run [[RCUG_3_Terminology_and_Concepts#MARKER-9-400|apformat]] directly on the newest data file for process 11785 in pi_demo.aws.
</CODE></OL><A NAME=HEADING12-132></A><A NAME="UID-09command_rc.fm-973882"></A>
+
<!--  <A HREF="rcc-6.html#MARKER-9-400">apformat</A> -->
 +
<!--  [[RCUG_3_Terminology_and_Concepts|CHAPTER 3 - Terminology and Concepts]]  -->
 +
<DIV ID=MARKER-10-2074></DIV>
 +
<code>
 +
$ rootcause format -r -O "-n 0" -p 11785 pi_demo.aws
 +
</CODE>
 +
</OL>
 +
<DIV ID=HEADING12-132></DIV><DIV ID="UID-09command_rc.fm-973882"></DIV>
 
----
 
----
<H2><A NAME=MARKER-9-2075></A>rootcause log</H2>
+
<DIV ID=MARKER-9-2075></DIV>
The <CODE><A NAME=MARKER-2-2076></A>rootcause log</CODE> command provides information about the RootCause Log, and allows its maximum <A NAME=MARKER-2-2077></A>size to be changed.<H4> Syntax:</H4><PRE>  
+
<!--  <H2>rootcause log</H2>  -->
rootcause log ['''-hlnsFZ''' | '''-s'''<EM>size</EM> ]  
+
 
</PRE><H4> Options:</H4><DL>
+
== rootcause log ==
 +
 
 +
<DIV ID=MARKER-2-2076></DIV><DIV ID=MARKER-2-2077></DIV>
 +
The <CODE>rootcause log</CODE> command provides information about the RootCause Log, and allows its maximum size to be changed.
 +
<H4> Syntax:</H4>
 +
<code>  
 +
rootcause log ['''-hlnsFZ''' | '''-s''' <EM>size</EM> ]  
 +
</code>
 +
<H4> Options:</H4>
 +
<DL>
 
<DT>''''''-F''''''<DD> force -s size or -Z operation without confirmation
 
<DT>''''''-F''''''<DD> force -s size or -Z operation without confirmation
 
<DT>''''''-h''''''<DD> give command-line help
 
<DT>''''''-h''''''<DD> give command-line help
Line 177: Line 351:
 
<DT>''''''-s''''''<DD> list the log file size to standard output
 
<DT>''''''-s''''''<DD> list the log file size to standard output
 
<DT>''''''-s <EM>size</EM>''''''<DD> set the maximum size of the log to <EM>size</EM> bytes (size > 1000)
 
<DT>''''''-s <EM>size</EM>''''''<DD> set the maximum size of the log to <EM>size</EM> bytes (size > 1000)
<DT>''''''-Z''''''<DD> clear the contents of the log file</DL><H4><A NAME=MARKER-9-2078></A>Examples:</H4><OL><LI>
+
<DT>''''''-Z''''''<DD> clear the contents of the log file
Write the contents of the log to standard output:  
+
</DL>
rootcause log  
+
<DIV ID=MARKER-9-2078></DIV>
<LI>
+
<H4>Examples:</H4>
Set the size of the log to 20000 bytes:  
+
<OL>
rootcause log -s 20000  
+
<LI>Write the contents of the log to standard output:  
 +
<pre>
 +
$ rootcause log  
 +
</pre>
 +
<LI>Set the size of the log to 20000 bytes:  
 +
<pre>
 +
$ rootcause log -s 20000  
 +
</pre>
 
</OL>
 
</OL>
<A NAME=HEADING12-150></A><A NAME="UID-09command_rc.fm-973824"></A>
+
<DIV ID=HEADING12-150></DIV><DIV ID="UID-09command_rc.fm-973824"></DIV>
 
----
 
----
<H2><A NAME=MARKER-9-2079></A>rootcause merge</H2>
+
<DIV ID=MARKER-9-2079></DIV>
  The <CODE><A NAME=MARKER-2-2080></A>rootcause merge</CODE> command merges two <A HREF="rcc-6.html#MARKER-9-482">workspace</A>s to create a new, third workspace. It works by copying the first <EM>primary</EM> workspace to the third <EM>result</EM> workspace, then adding compatible traces and UALs from the second <EM>secondary</EM> workspace. A <A HREF="rcc-6.html#MARKER-9-440">module</A> must exist in both the <EM>primary</EM> and <EM>secondary</EM> workspaces in order that traces for that module appear in the <EM>result</EM> workspace.  
+
<!--  <H2>rootcause merge</H2>  -->
  There is no GUI operation equivalent to rootcause merge.  You can use it in conjunction with the GUI by:<UL><LI>
+
 
Using <EM>Workspace->Close</EM> to close your current workspace<LI>
+
== rootcause merge ==
Applying <CODE>rootcause merge</CODE> from the command line<LI>
+
 
Using <EM>Workspace->Open</EM> on the result workspace.</UL>
+
<DIV ID=MARKER-2-2080></DIV>
'''Note: '''The <A HREF="#MARKER-9-2022">rootcause build</A> and <A HREF="#MARKER-9-2107">rootcause register</A> operations must be applied to the <EM>result</EM> workspace before the result workspace can be used to trace an application. <H4> Syntax:</H4><PRE>  
+
The <CODE>rootcause merge</CODE> command merges two [[RCUG_3_Terminology_and_Concepts#MARKER-9-482|workspace]]s to create a new, third workspace. It works by copying the first <EM>primary</EM> workspace to the third <EM>result</EM> workspace, then adding compatible traces and UALs from the second <EM>secondary</EM> workspace. A [[RCUG_3_Terminology_and_Concepts#MARKER-9-440|module]] must exist in both the <EM>primary</EM> and <EM>secondary</EM> workspaces in order that traces for that module appear in the <EM>result</EM> workspace.  
 +
<!-- <A HREF="rcc-6.html#MARKER-9-482">workspace</A>  -->
 +
<!--  <A HREF="rcc-6.html#MARKER-9-440">module</A>  -->
 +
<!--  [[RCUG_3_Terminology_and_Concepts|CHAPTER 3 - Terminology and Concepts]]  -->
 +
 
 +
There is no GUI operation equivalent to rootcause merge.  You can use it in conjunction with the GUI by:
 +
<UL>
 +
<LI>Using <EM>Workspace->Close</EM> to close your current workspace
 +
<LI>Applying <CODE>rootcause merge</CODE> from the command line
 +
<LI>Using <EM>Workspace->Open</EM> on the result workspace.
 +
</UL>
 +
'''Note: '''The [[#MARKER-9-2022|rootcause build]] and [[#MARKER-9-2107|rootcause register]] operations must be applied to the <EM>result</EM> workspace before the result workspace can be used to trace an application.  
 +
<H4> Syntax:</H4>
 +
<code>  
 
rootcause merge ['''-Fh'''] <EM>primary</EM>.aws <EM>secondary</EM>.aws <EM>result</EM>.aws  
 
rootcause merge ['''-Fh'''] <EM>primary</EM>.aws <EM>secondary</EM>.aws <EM>result</EM>.aws  
</PRE><H4> Options:</H4><DL>
+
</code>
 +
<H4> Options:</H4>
 +
<DL>
 
<DT>''''''-F''''''<DD> force <EM>result.aws</EM> to be overwritten if it exists
 
<DT>''''''-F''''''<DD> force <EM>result.aws</EM> to be overwritten if it exists
 
<DT>''''''-h''''''<DD> give command-line help
 
<DT>''''''-h''''''<DD> give command-line help
<DT>'''<EM>primary</EM>.aws'''<DD>
+
<DT>'''<EM>primary</EM>.aws'''<DD>The primary workspace, on which the result workspace is based.
The primary workspace, on which the result workspace is based.
+
<DT>'''<EM>secondary</EM>.aws'''<DD>The secondary workspace, from which additional traces and UALS are added to the result workspace.
<DT>'''<EM>secondary</EM>.aws'''<DD>
+
<DT>'''<EM>result</EM>.aws'''<DD> The new workspace that is created.
The secondary workspace, from which additional traces and UALS are added to the result workspace.
+
</DL>
<DT>'''<EM>result</EM>.aws'''<DD> The new workspace that is created.</DL><H4> Examples:</H4><OL><LI>
+
<H4> Examples:</H4>
Merge traces in file_ops.aws into pi_demo.aws to produce pi_demo2.aws and make pi_demo2.aws the new workspace for tracing pi_demo<A NAME=MARKER-10-2081></A>  
+
<OL>
rootcause merge file_ops.aws pi_demo.aws pi_demo2.aws
+
<DIV ID=MARKER-10-2081></DIV>
rootcause build pi_demo2.aws
+
<LI>Merge traces in file_ops.aws into pi_demo.aws to produce pi_demo2.aws and make pi_demo2.aws the new workspace for tracing pi_demo  
rootcause register -F -x pi_demo<A NAME=MARKER-10-2082></A> -w pi_demo2.aws  
+
<pre>
</OL><A NAME=HEADING12-168></A><A NAME="UID-09command_rc.fm-973825"></A>
+
$ rootcause merge file_ops.aws pi_demo.aws pi_demo2.aws
 +
$ rootcause build pi_demo2.aws
 +
$ rootcause register -F -x pi_demo -w pi_demo2.aws  
 +
</pre>
 +
</OL>
 +
<DIV ID=HEADING12-168></DIV><DIV ID="UID-09command_rc.fm-973825"></DIV>
 
----
 
----
<H2><A NAME=MARKER-10-2083></A><A NAME=MARKER-9-2084></A>rootcause new</H2>
+
<DIV ID=MARKER-10-2083></DIV><DIV ID=MARKER-9-2084></DIV>
The <A NAME=MARKER-2-2085></A>rootcause new command creates a new <A HREF="rcc-6.html#MARKER-9-482">workspace</A>. Generally this is done through the RootCause GUI using the <A HREF="rcc-11.html#MARKER-9-1362">New</A> menu item or <A HREF="rcc-11.html#MARKER-9-1730">Open Associated Workspace</A>; (see <A HREF="rcc-11.html#MARKER-9-1434">"New Workspace Dialog"</A>). The result of this operation is the named workspace, initialized to do default tracing. If the '''-r''' option is used, the workspace is also registered with the specified program or Java class.<H4> Syntax:</H4><PRE>  
+
<!--  <H2>rootcause new</H2>  -->
rootcause new  
+
 
['''-Fhr''']['''-c'''<EM>class</EM>] '''-x'''<EM>program_file</EM>  ['''-w''']<EM>workspace</EM>.aws ]  
+
== rootcause new ==
</PRE><H4> Options:</H4><DL>
+
 
 +
<DIV ID=MARKER-2-2085></DIV>
 +
The rootcause new command creates a new [[RCUG_3_Terminology_and_Concepts#MARKER-9-482|workspace]]. Generally this is done through the RootCause GUI using the [[RCUG_RootCause_GUI_Reference#MARKER-9-1362|New]] menu item or [[RCUG_RootCause_GUI_Reference#MARKER-9-1730|Open Associated Workspace]]; (see [[RCUG_RootCause_GUI_Reference#MARKER-9-1434|"New Workspace Dialog"]]). The result of this operation is the named workspace, initialized to do default tracing. If the '''-r''' option is used, the workspace is also registered with the specified program or Java class.
 +
<!--  <A HREF="rcc-6.html#MARKER-9-482">workspace</A> -->
 +
<!--  <A HREF="rcc-11.html#MARKER-9-1362">New</A> -->
 +
<!--  <A HREF="rcc-11.html#MARKER-9-1730">Open Associated Workspace</A> -->
 +
<!--  <A HREF="rcc-11.html#MARKER-9-1434">"New Workspace Dialog"</A> -->
 +
<!--  [[RCUG_3_Terminology_and_Concepts|CHAPTER 3 - Terminology and Concepts]]  -->
 +
<!--  [[RCUG_RootCause_GUI_Reference|CHAPTER 8 - RootCause GUI Reference]]  -->
 +
<H4> Syntax:</H4>
 +
<code>  
 +
rootcause new ['''-Fhr''']['''-c''' <EM>class</EM>] '''-x''' <EM>program_file</EM>  ['''-w'''] <EM>workspace</EM>.aws ]  
 +
</code>
 +
<H4> Options:</H4>
 +
<DL>
 
<DT>''''''-c <EM>class</EM>''''''<DD> the Java class registered with the workspace you wish to deploy.
 
<DT>''''''-c <EM>class</EM>''''''<DD> the Java class registered with the workspace you wish to deploy.
 
<DT>''''''-F''''''<DD> force overwriting of <EM>workspace.aws</EM> if it exists.
 
<DT>''''''-F''''''<DD> force overwriting of <EM>workspace.aws</EM> if it exists.
 
<DT>''''''-h''''''<DD> give this command's usage
 
<DT>''''''-h''''''<DD> give this command's usage
 
<DT>''''''-r''''''<DD> register the new workspace with the specified program or Java class
 
<DT>''''''-r''''''<DD> register the new workspace with the specified program or Java class
<DT>''''''-x<EM> program_file</EM>''''''<DD>
+
<DT>''''''-x<EM> program_file</EM>''''''<DD>the executable program or Java<CODE> .class</CODE> or <CODE>.jar</CODE> file the workspace will be used to trace (as on the [[#MARKER-9-2101|rootcause open]] command).
the executable program or Java<CODE> .class</CODE> or <CODE>.jar</CODE> file the workspace will be used to trace (as on the <A HREF="#MARKER-9-2101">rootcause open</A> command).
+
<DT>''''''-w<EM> workspace</EM>'''.aws'''<DD>the new workspace to be created.
<DT>''''''-w<EM> workspace</EM>'''.aws'''<DD>
+
</DL>
the new workspace to be created.</DL><H4> Examples:</H4><OL><LI>
+
<H4> Examples:</H4>
Create and register a new workspace for pi_demo.exe<A NAME=MARKER-10-2086></A>.
+
<OL>
rootcause new -r -x pi_demo.exe<A NAME=MARKER-10-2087></A> -w pi_demo.aws<A NAME=MARKER-10-2088></A>.
+
<DIV ID=MARKER-10-2086></DIV>
</OL><A NAME=HEADING12-182></A><A NAME="UID-09command_rc.fm-973929"></A>
+
<LI>Create and register a new workspace for pi_demo.exe.
 +
<DIV ID=MARKER-10-2087></DIV><DIV ID=MARKER-10-2088></DIV>
 +
<pre>
 +
$ rootcause new -r -x pi_demo.exe -w pi_demo.aws.
 +
</pre>
 +
</OL>
 +
<DIV ID=HEADING12-182></DIV><DIV ID="UID-09command_rc.fm-973929"></DIV>
 
----
 
----
<H2><A NAME=MARKER-9-2089></A>rootcause_<A NAME=MARKER-10-2090></A>off</H2>
+
<DIV ID=MARKER-9-2089></DIV><DIV ID=MARKER-10-2090></DIV>
  Use the <CODE><A NAME=MARKER-2-2091></A>rootcause_<A NAME=MARKER-10-2092></A>off</CODE> command to disable rootcause interception of processes on your machine.<H4> Syntax:</H4><PRE>  
+
<!--  <H2>rootcause_off</H2>  -->
rootcause<CODE>_<A NAME=MARKER-10-2093></A></CODE>off
+
 
</PRE><H4></H4><H4></H4><A NAME=HEADING12-188></A><A NAME="UID-09command_rc.fm-976801"></A>
+
== rootcause_off ==
 +
 
 +
<DIV ID=MARKER-2-2091></DIV><DIV ID=MARKER-10-2092></DIV>
 +
Use the <CODE>rootcause_off</CODE> command to disable rootcause interception of processes on your machine.
 +
<H4> Syntax:</H4>
 +
<DIV ID=MARKER-10-2093></DIV>
 +
<code>  
 +
rootcause_off
 +
</code>
 +
<H4></H4>
 +
<H4></H4>
 +
<DIV ID=HEADING12-188></DIV><DIV ID="UID-09command_rc.fm-976801"></DIV>
 
----
 
----
<H2><A NAME=MARKER-9-2094></A>rootcause_<A NAME=MARKER-10-2095></A>on</H2>
+
<DIV ID=MARKER-9-2094></DIV><DIV ID=MARKER-10-2095></DIV>
  Use the <CODE><A NAME=MARKER-2-2096></A>rootcause_<A NAME=MARKER-10-2097></A>on</CODE> command to start the inspection and interception of processes on your machine to determine if they should be traced with rootcause.<H4> Syntax:</H4><PRE><CODE>rootcause_<A NAME=MARKER-10-2098></A>on<A NAME=MARKER-10-2099></A></CODE></PRE><A NAME=HEADING12-192></A><A NAME="UID-09command_rc.fm-949424"></A>
+
<!--  <H2>rootcause_on</H2>  -->
 +
 
 +
== rootcause_on ==
 +
 
 +
<DIV ID=MARKER-2-2096></DIV><DIV ID=MARKER-10-2097></DIV>
 +
Use the <CODE>rootcause_on</CODE> command to start the inspection and interception of processes on your machine to determine if they should be traced with rootcause.
 +
<H4> Syntax:</H4>
 +
<code>
 +
rootcause_on
 +
</CODE>
 +
<DIV ID=HEADING12-192></DIV><DIV ID="UID-09command_rc.fm-949424"></DIV>
 
----
 
----
<H2><A NAME=MARKER-10-2100></A><A NAME=MARKER-9-2101></A>rootcause open</H2>
+
<DIV ID=MARKER-10-2100></DIV><DIV ID=MARKER-9-2101></DIV>
  The <CODE><A NAME=MARKER-2-2102></A>rootcause <A NAME=MARKER-2-2103></A>open</CODE> command starts the <A NAME=MARKER-2-2104></A>RootCause GUI. If the application class specified on the command line is registered, the GUI will automatically set the workspace from the registry entry for the application. If the application is not registered, the GUI will prompt for a new workspace name and register the application. If no arguments are specified, the current RootCause Log file is opened.<H4> Syntax:</H4><PRE>  
+
<!--  <H2>rootcause open</H2>  -->
rootcause open   
+
 
[['''-x'''] <EM>program_file</EM>]  
+
== rootcause open ==
['''-c'''<EM>classname</EM>] [['''-w'''] <EM>workspace</EM>.aws]  
+
 
[ ['''-d'''] <EM>dir</EM>.dclct | ['''-z'''] <EM>file</EM>.clct ]  
+
<DIV ID=MARKER-2-2102></DIV><DIV ID=MARKER-2-2103></DIV><DIV ID=MARKER-2-2104></DIV>
</PRE><H4> Options:</H4><DL>
+
The <CODE>rootcause open</CODE> command starts the RootCause GUI. If the application class specified on the command line is registered, the GUI will automatically set the workspace from the registry entry for the application. If the application is not registered, the GUI will prompt for a new workspace name and register the application. If no arguments are specified, the current RootCause Log file is opened.
<DT>'''<EM>program_file</EM>'''<DD>
+
<H4> Syntax:</H4>
the executable program file, or the the <CODE>.class</CODE> or <CODE>.jar</CODE> file containing your Java application's main entry
+
<code>  
 +
rootcause open  [['''-x'''] <EM>program_file</EM>] ['''-c''' <EM>classname</EM>] [['''-w'''] <EM>workspace</EM>.aws] [ ['''-d'''] <EM>dir</EM>.dclct | ['''-z'''] <EM>file</EM>.clct ]  
 +
</code>
 +
<H4> Options:</H4>
 +
<DL>
 +
<DT>'''<EM>program_file</EM>'''<DD>the executable program file, or the the <CODE>.class</CODE> or <CODE>.jar</CODE> file containing your Java application's main entry
 
<DT>'''<EM>classname</EM>'''<DD> the main class name. This is required if <EM>classname</EM> is not the same as <EM>file</EM>
 
<DT>'''<EM>classname</EM>'''<DD> the main class name. This is required if <EM>classname</EM> is not the same as <EM>file</EM>
<DT>'''<EM>workspace</EM>.aws'''<DD>
+
<DT>'''<EM>workspace</EM>.aws'''<DD>a new or existing RootCause workspace
a new or existing RootCause workspace
+
<DT>'''<EM>dir</EM>.dclct'''<DD> a directory created by the RootCause <EM>[[RCUG_RootCause_GUI_Reference#MARKER-9-1430|Decollect]]</EM> operation
<DT>'''<EM>dir</EM>.dclct'''<DD> a directory created by the RootCause <EM><A HREF="rcc-11.html#MARKER-9-1430">Decollect</A></EM> operation
+
<!--  <A HREF="rcc-11.html#MARKER-9-1430">Decollect</A> -->
<DT>'''<EM>file</EM>.clct'''<DD> a file created by the <CODE>rootcause collect</CODE> command</DL><H4> Examples:</H4><OL><LI>
+
<!--  [[RCUG_RootCause_GUI_Reference|CHAPTER 8 - RootCause GUI Reference]]  -->
Start the RootCause GUI and examine the RootCause Log file in a Trace Display window.  
+
<DT>'''<EM>file</EM>.clct'''<DD> a file created by the <CODE>rootcause collect</CODE> command
rootcause open  
+
</DL>
<LI>
+
<H4> Examples:</H4>
Start the RootCause GUI to open new or existing workspace converter.aws.  
+
<OL>
rootcause open converter.aws  
+
<LI>Start the RootCause GUI and examine the RootCause Log file in a Trace Display window.  
<LI>
+
<pre>
Start the RootCause GUI to open a new or existing workspace for program converter.exe  
+
$ rootcause open  
rootcause open converter.exe  
+
</pre>
<LI>
+
<LI>Start the RootCause GUI to open new or existing workspace converter.aws.  
<A NAME=MARKER-10-2105></A>Start the RootCause GUI to unpack (<A NAME=MARKER-2-2106></A>decollect) the collected rootcause data in pi_demo.clct.  
+
<pre>
rootcause open pi_demo.clct  
+
$ rootcause open converter.aws  
</OL><A NAME=HEADING12-211></A><A NAME="UID-09command_rc.fm-949448"></A>
+
</pre>
 +
<LI>Start the RootCause GUI to open a new or existing workspace for program converter.exe  
 +
<pre>
 +
$ rootcause open converter.exe  
 +
</pre>
 +
<DIV ID=MARKER-10-2105></DIV><DIV ID=MARKER-2-2106></DIV>
 +
<LI>Start the RootCause GUI to unpack (decollect) the collected rootcause data in pi_demo.clct.  
 +
<pre>
 +
$ rootcause open pi_demo.clct  
 +
</pre>
 +
</OL>
 +
<DIV ID=HEADING12-211></DIV><DIV ID="UID-09command_rc.fm-949448"></DIV>
 
----
 
----
<H2><A NAME=MARKER-9-2107></A>rootcause register</H2>
+
<DIV ID=MARKER-9-2107></DIV>
  The <CODE><A NAME=MARKER-2-2108></A>rootcause <A NAME=MARKER-2-2109></A>register</CODE> command provides the interface to the RootCause <A NAME=MARKER-2-2110></A>registry. The GUI will allow you to add or delete the current workspace from the registry, but you must use the register command to otherwise manipulate the registry. It is likely that, over time, more GUI support will be added to manipulate the registry, but on computers where only the <A NAME=MARKER-2-2111></A>RootCause Agent is installed, there is no GUI and the <CODE>register</CODE> command must be used.<H4> Syntax:</H4><PRE>  
+
<!--  <H2>rootcause register</H2>  -->
 +
 
 +
== rootcause register ==
 +
 
 +
<DIV ID=MARKER-2-2108></DIV><DIV ID=MARKER-2-2109></DIV><DIV ID=MARKER-2-2110></DIV><DIV ID=MARKER-2-2111></DIV>
 +
The <CODE>rootcause register</CODE> command provides the interface to the RootCause registry. The GUI will allow you to add or delete the current workspace from the registry, but you must use the register command to otherwise manipulate the registry. It is likely that, over time, more GUI support will be added to manipulate the registry, but on computers where only the RootCause Agent is installed, there is no GUI and the <CODE>register</CODE> command must be used.
 +
<H4> Syntax:</H4>
 +
<code>  
 
rootcause register [<EM>subcommand</EM> ] <EM>options</EM>  [<EM>deploy_file</EM>]  
 
rootcause register [<EM>subcommand</EM> ] <EM>options</EM>  [<EM>deploy_file</EM>]  
</PRE><H4> Description:</H4><H4><EM>subcommand</EM></H4>
+
</code>
The <EM>subcommand</EM> flag designates the operation to be performed:<DL>
+
<H4> Description:</H4>
 +
<H4><EM>subcommand</EM></H4>
 +
The <EM>subcommand</EM> flag designates the operation to be performed:
 +
<DL>
 
<DT>''''''-a''''''<DD> add a new entry in the registry (default)
 
<DT>''''''-a''''''<DD> add a new entry in the registry (default)
 
<DT>''''''-d''''''<DD> delete an entry from the registry
 
<DT>''''''-d''''''<DD> delete an entry from the registry
Line 272: Line 540:
 
<DT>''''''-lr''''''<DD> list registry name only
 
<DT>''''''-lr''''''<DD> list registry name only
 
<DT>''''''-lw''''''<DD> list workspace name only
 
<DT>''''''-lw''''''<DD> list workspace name only
<DT>''''''-lx''''''<DD> list only registered program<A NAME=MARKER-10-2112></A> only
+
<DIV ID=MARKER-10-2112></DIV>
 +
<DT>''''''-lx''''''<DD> list only registered program only
 
<DT>''''''-s'''<CODE>debug</CODE>'''<DD> enable/disable debug mode with '''-e'''<CODE>on</CODE>/<CODE>off</CODE> (off by default)
 
<DT>''''''-s'''<CODE>debug</CODE>'''<DD> enable/disable debug mode with '''-e'''<CODE>on</CODE>/<CODE>off</CODE> (off by default)
 
<DT>''''''-s'''<CODE>verbose</CODE>'''<DD> enable/disable verbose mode with -e <CODE>on</CODE>/<CODE>off</CODE> (on by default)
 
<DT>''''''-s'''<CODE>verbose</CODE>'''<DD> enable/disable verbose mode with -e <CODE>on</CODE>/<CODE>off</CODE> (on by default)
 
With verbose mode on, all processes are recorded in the log; with verbose off, only traced applications are recorded.
 
With verbose mode on, all processes are recorded in the log; with verbose off, only traced applications are recorded.
<DT>''''''-Z''''''<DD> clear entire registry contents, including '''-s''' settings, returning them to their default values.</DL><H4><EM>options</EM></H4><DL>
+
<DT>''''''-Z''''''<DD> clear entire registry contents, including '''-s''' settings, returning them to their default values.
 +
</DL>
 +
<H4><EM>options</EM></H4>
 +
<DL>
 
<DT>''' Options further qualifying the above are:'''<DD>
 
<DT>''' Options further qualifying the above are:'''<DD>
 
<DT>''''''-c'''<EM>classname</EM>'''<DD> probe Java commands naming main class <EM>classname</EM>
 
<DT>''''''-c'''<EM>classname</EM>'''<DD> probe Java commands naming main class <EM>classname</EM>
Line 286: Line 558:
 
<DT>''''''-w'''<EM>dir</EM>.aws'''<DD> file is workspace to use
 
<DT>''''''-w'''<EM>dir</EM>.aws'''<DD> file is workspace to use
 
<DT>''''''-x'''<EM>file</EM>'''<DD> file is executable to probe
 
<DT>''''''-x'''<EM>file</EM>'''<DD> file is executable to probe
<DT>'''<EM>deploy_file</EM>'''<DD> is a <CODE>.dply</CODE> file to unpack into a registered workspace</DL><H4> Examples:</H4><OL><LI>
+
<DT>'''<EM>deploy_file</EM>'''<DD> is a <CODE>.dply</CODE> file to unpack into a registered workspace
List the registry name and contents:  
+
</DL>
rootcause register -l  
+
<H4> Examples:</H4>
<LI>
+
<OL>
Delete the registry entry for <CODE>driver.exe</CODE>:  
+
<LI>List the registry name and contents:  
rootcause register -d -x /build/bin/driver  
+
<pre>
<LI>
+
$ rootcause register -l  
<A NAME=MARKER-10-2113></A>Turn off recording of all processes in the RootCause log:  
+
</pre>
rootcause register -s verbose -e off  
+
<LI>Delete the registry entry for <CODE>driver.exe</CODE>:  
<LI>
+
<pre>
The following command will do the following all in one step:<UL><LI>
+
$ rootcause register -d -x /build/bin/driver  
register the program<LI>
+
</pre>
create the workspace (if it does not exist)<LI>
+
<DIV ID=MARKER-10-2113></DIV>
deploy the trace into the workspace; and<LI>
+
<li>Turn off recording of all processes in the RootCause log:  
check it's consistency with the modules to be traced
+
<pre>
This would be the typical command used on a remote computer where only the <A NAME=MARKER-2-2114></A>RootCause Agent component was installed in order to implement a <A NAME=MARKER-2-2115></A>.dply file generated by the RootCause GUI component. After this command is issued, you would merely execute rootcause_on in the context of the shell<A NAME=MARKER-10-2116></A> and run the application.  
+
$ rootcause register -s verbose -e off  
rootcause register -x  
+
</pre>
/opt/frobco/bin/frobit
+
<LI>The following command will do the following all in one step:
<A NAME=MARKER-10-2117></A> frobit.dply
+
<UL>
<A NAME=MARKER-10-2118></A></UL></OL><A NAME=HEADING12-255></A><A NAME="UID-09command_rc.fm-974040"></A>
+
<LI>register the program
 +
<LI>create the workspace (if it does not exist)
 +
<LI>deploy the trace into the workspace; and
 +
<LI>check it's consistency with the modules to be traced
 +
<DIV ID=MARKER-2-2114></DIV><DIV ID=MARKER-2-2115></DIV><DIV ID=MARKER-10-2116></DIV>
 +
This would be the typical command used on a remote computer where only the RootCause Agent component was installed in order to implement a .dply file generated by the RootCause GUI component. After this command is issued, you would merely execute rootcause_on in the context of the shell and run the application.  
 +
<pre>
 +
$ rootcause register -x /opt/frobco/bin/frobit frobit.dply
 +
</pre>
 +
<DIV ID=MARKER-10-2118></DIV>
 +
</UL>
 +
</OL>
 +
<DIV ID=HEADING12-255></DIV><DIV ID="UID-09command_rc.fm-974040"></DIV>
 
----
 
----
<H2><A NAME=MARKER-9-2119></A>rootcause run</H2>
+
<DIV ID=MARKER-9-2119></DIV>
  Use <CODE><A NAME=MARKER-2-2120></A>rootcause run</CODE> before your command to cause it to be <A HREF="rcc-6.html#MARKER-9-458">run with rootcause on</A>, independent of the current <A HREF="#MARKER-9-2129">rootcause status</A>.  The command specified will be run in the current window exactly as if it were not preceded by rootcause run. This is equivalent to  
+
<!--  <H2>rootcause run</H2>  -->
rootcause<CODE>_<A NAME=MARKER-10-2121></A></CODE>on
+
 
<EM>command
+
== rootcause run ==
</EM>rootcause<CODE>_<A NAME=MARKER-10-2122></A></CODE>off
+
 
<H4> Syntax:</H4><PRE><CODE>rootcause run</CODE><EM>command</EM></PRE><H4> Options:</H4><DL>
+
<DIV ID=MARKER-2-2120></DIV>
<DT>'''<EM>command</EM>'''<DD> any shell command</DL><H4> Example:</H4><OL><LI>
+
Use <CODE>rootcause run</CODE> before your command to cause it to be [[RCUG_3_Terminology_and_Concepts#MARKER-9-458|run with rootcause on]], independent of the current  
Run the pi_demo<A NAME=MARKER-10-2123></A> application with rootcause on:  
+
[[#MARKER-9-2129|rootcause status]].  The command specified will be run in the current window exactly as if it were not preceded by rootcause run. This is equivalent to  
rootcause run $APROBE/demo/RootCause/C++/pi_demo  
+
<DIV ID=MARKER-10-2121></DIV><DIV ID=MARKER-10-2122></DIV>
</OL><H4><A NAME=MARKER-10-2124></A><A NAME=MARKER-10-2125></A></H4><A NAME=HEADING12-266></A><A NAME="UID-09command_rc.fm-976908"></A>
+
rootcause<CODE>_</CODE>on <EM>command</EM>rootcause<CODE>_</CODE>off
 +
<!--  <A HREF="rcc-6.html#MARKER-9-458">run with rootcause on</A> -->
 +
<!--  [[RCUG_3_Terminology_and_Concepts|CHAPTER 3 - Terminology and Concepts]]  -->
 +
<H4> Syntax:</H4>
 +
<code>
 +
rootcause run <EM>command</EM>
 +
</code>
 +
<H4> Options:</H4>
 +
<DL>
 +
<DT>'''<EM>command</EM>'''<DD> any shell command
 +
</DL>
 +
<H4> Example:</H4>
 +
<OL>
 +
<DIV ID=MARKER-10-2123></DIV>
 +
<LI>Run the pi_demo application with rootcause on:  
 +
<pre>
 +
$ rootcause run $APROBE/demo/RootCause/C++/pi_demo  
 +
</pre>
 +
</OL>
 +
<DIV ID=MARKER-10-2124></DIV><DIV ID=MARKER-10-2125></DIV>
 +
<H4></H4>
 +
<DIV ID=HEADING12-266></DIV><DIV ID="UID-09command_rc.fm-976908"></DIV>
 
----
 
----
<H2><A NAME=MARKER-10-2126></A><A NAME=MARKER-9-2127></A>rootcause xrun</H2>
 
Identical to <A HREF="#MARKER-9-2119">rootcause run</A>, but the <EM>command</EM> is run in a separate window. This is used by the <A HREF="rcc-11.html#MARKER-9-1428">Run</A> button in the RootCause GUI.<H4> Syntax:</H4><PRE><CODE><A NAME=MARKER-2-2128></A>rootcause xrun</CODE><EM>command</EM></PRE><H4></H4><A NAME=HEADING12-271></A><A NAME="UID-09command_rc.fm-976931"></A>
 
 
----
 
----
<H2><A NAME=MARKER-9-2129></A>rootcause status</H2>
+
<DIV ID=MARKER-9-2129></DIV>
  Use the <CODE><A NAME=MARKER-2-2130></A>rootcause status</CODE> command to show whether rootcause tracing is currently enabled or disabled.<H4> Syntax:</H4><PRE>  
+
<!--  <H2>rootcause status</H2>  -->
rootcause status  
+
 
</PRE>
+
== rootcause status ==
<A NAME="LINK-09command_rc.fm-lastpage"></A></DIV><DIV>
+
 
 +
<DIV ID=MARKER-2-2130></DIV>
 +
Use the <CODE>rootcause status</CODE> command to show whether rootcause tracing is currently enabled or disabled.
 +
<H4> Syntax:</H4>
 +
<code>
 +
rootcause status
 +
</code>
 +
<DIV ID="LINK-09command_rc.fm-lastpage"></DIV>
 +
<!--  </DIV><DIV>  -->
 
--------
 
--------
 +
<DIV ID=MARKER-10-2126></DIV><DIV ID=MARKER-9-2127></DIV>
 +
<!--  <H2>rootcause xrun</H2>  -->
 +
 +
== rootcause xrun ==
 +
 +
Identical to [[#MARKER-9-2119|rootcause run]], but the <EM>command</EM> is run in a separate window. This is used by the [[RCUG_RootCause_GUI_Reference#MARKER-9-1428|Run]] button in the RootCause GUI.
 +
<!--  <A HREF="rcc-11.html#MARKER-9-1428">Run</A>  -->
 +
<!--  [[RCUG_RootCause_GUI_Reference|CHAPTER 8 - RootCause GUI Reference]]  -->
 +
<H4> Syntax:</H4>
 +
<DIV ID=MARKER-2-2128></DIV>
 +
<code>
 +
rootcause xrun <EM>command</EM>
 +
</code>
 +
<H4></H4>
 +
<DIV ID=HEADING12-271></DIV><DIV ID="UID-09command_rc.fm-976931"></DIV>
 +
 
Copyright 2006-2017 OC Systems, Inc.</div>
 
Copyright 2006-2017 OC Systems, Inc.</div>
  
 
[[RCUG_7_Selected_Topics|Next]] [[RCUG_RootCause_GUI_Reference|Previous]] [[RCUG_Index|Index]] [[RCUG_Top|Top]]
 
[[RCUG_7_Selected_Topics|Next]] [[RCUG_RootCause_GUI_Reference|Previous]] [[RCUG_Index|Index]] [[RCUG_Top|Top]]
 
  
 
[[Category:RCUG]]
 
[[Category:RCUG]]

Latest revision as of 00:12, 13 January 2018


Next Previous Index Top

RootCause User Guide


RootCause Command Reference


The following commands are available from the command line after RootCause has been installed and the setup script in the RootCause installation directory has been executed (see Chapter 4, "Getting Started").

RootCause and Different Shells

Different shells on Solaris have different capabilities. The following differences apply to the different shells:

sh (Bourne shell)

The rootcause_on and rootcause_off commands are not available. Instead, you must use the dot commands:

 
. rootcause_enable 
. rootcause_disable 

ksh (Korn shell)

You may use rootcause on and rootcause off instead of rootcause_on, and rootcause_off, because rootcause is defined as a shell function. Note that RootCause requires that ksh be installed, though you need not use it as your shell. On Linux you may have to install pdksh.

csh (C shell)

rootcause_on and rootcause_off are aliases defined in your shell when you "source" setup.csh. C shell does not support shell functions, so "rootcause on" and "rootcause off" won't work.

bash

The setup script and shell functions for ksh work for bash as well. However, ksh is still needed for install_rootcause, rootcause_status, and other scripts.

rootcause

The rootcause command is designed to run in a simple, intuitive manner when default file names are used. When run with no arguments, it gives version and license information. When run with rootcause -h, it shows the following commands, which are described in detail in this chapter.

rootcause build
build traces/probes in workspace.
rootcause collect
collect agent workspace data for analysis.
rootcause config
show current configuration information.
rootcause decollect
unpack collected workspace data for analysis.
rootcause deploy
package a workspace for remote deployment.
rootcause format
format data in workspace.
rootcause log
perform operations on rootcause log file.
rootcause merge
merge two workspaces to create a third.
rootcause new
create a new workspace.
rootcause_off
disable rootcause intercept of applications.
rootcause_on
enable rootcause intercept of applications.
rootcause open
start the RootCause GUI.
rootcause register
register an application with a workspace.
rootcause run
run any command under rootcause.
rootcause status
show if rootcause is enabled.
rootcause xrun
run a command under rootcause in a separate window.

rootcause build

The rootcause build command updates a RootCause workspace without opening the GUI. This is useful for maintaining workspaces as part of a script-driven product development process. The location of a workspace is provided, along with paths to all relevant programs and modules whose locations or contents may have changed. Note that a side-effect of this process may be to lose traces that no longer apply to a changed module.

Syntax:

rootcause build [-Fh] [ -xprogram_file | file.class | file.jar ] [-mmodule]* [-w] workspace.aws

Options:

'-F'
force the build even if the workspace is locked.
'-h'
give this command's usage
'-x program_file'
the executable program, or the .class or .jar file containing your Java application's main entry. This is the same as the argument to Reset Program in the GUI.
'-m module'
the path of a dynamic module that the program applies to. This is the same as the argument to Reset Dynamic Module in the GUI.
'-w workspace'.aws
an existing RootCause workspace.

Examples:

  1. Rebuild workspace pi_demo.aws against current modules in case they've changed: rootcause build Pi.aws
  2. Update the RootCause self-analysis workspace for the current installation location: rootcause build -x $APROBE/lib/probeit.jar -m $APROBE/lib/libdebugInfo.so -w $APROBE/arca.aws

rootcause collect

The rootcause collect command is executed on a remote computer where the RootCause Agent component has been installed to gather the RootCause data together into a single .clct file to be transmitted to a computer where the RootCause GUI component has been installed for subsequent decollection and analysis. It examines the rootcause registry to determine the workspace for the applications, if no workspace is specified. Multiple applications and workspaces may be specified for collection. If no arguments are supplied, the RootCause log and registry are collected.

Syntax:

rootcause collect [-AFh] [ -o clct_file ] [ -f other_file ] [ [-x] program_file | -c class | [-w] workspace.aws ]...

Options:

'-A'
suppress generation and collection of ADI files for native modules. This might be done to reduce the download size if you are sure the local and remote modules are identical.
'-F'
force overwriting of clct_file, if present.
'-h'
give this command's usage
'-o clct_file'
the collect file to create (default: first_argument.clct)
'-f other_file'
any other file (not directory) to be added to the clct_file. You can also simply copy files or directories into the workspace.
'-x program_file'
the registered program to which deployed workspace applies
'-c class'
the registered Java class to which deployed workspace applies
'-w workspace'
the workspace contents to be collected if program or class is not known

Examples:

  • Collect the data logged in the workspace registered with program converter.exe and the workspace fred.aws, and places those two traces in the single file myserver.clct.
    rootcause collect -x converter.exe -w fred.aws -o myserver.clct 
    

    rootcause config

    The rootcause config command reports current configuration information. With no arguments it shows the installation directory and license information.

    Syntax:

    rootcause config [ -dhlLnRuvV ]

    Options:

    '-d'
    give installation directory (that is, the value of $APROBE)
    '-h'
    give this command's usage
    '-l'
    give license information
    '-L'
    give application log path ($APROBE_LOG or default location).
    '-n'
    give product name (Console or Agent).
    '-R'
    give application log path ($APROBE_REGISTRY or default location).
    '-u'
    give user directory ($APROBE_HOME or default).
    '-v'
    give product version number.
    '-V'
    give product version description (default).

    Examples:

  • Show the current installation information:
    $ rootcause config
    RootCause Console 2.0.5 (030405)
    Installed in /app1/product/aprobe
    This product is licensed to 1111 OC Systems, Inc.
    This license will expire on 31-dec-2006.
    

    rootcause decollect

    The rootcause decollect command unpackas a .clct file built by the rootcause collect command. This function is also performed by the Decollect operation in the RootCause GUI (see "Decollect Data Dialog").

    The result of this operation is a directory tree whose root directory has suffix .dclct.

    Syntax:

    rootcause decollect [-F] [-o directory] clct_file

    Options:

    '-F'
    force delete of directory, if present
    '-o directory'
    extract into directory (default: clct_file_name.dclct)
    clct_file
    collect file that was built by rootcause collect

    Examples:

  • Decollect the data in myserver.clct into myserver.dclct
    rootcause decollect myserver.clct 
    

    rootcause deploy

    The rootcause deploy command packages a workspace for use in a remote (agent) environment. This function is also performed by the Deploy operation in the RootCause GUI (see "Deploy Dialog"). The result of this operation is a zip file with suffix .dply. Note that this command does not verify the workspace is already built. If you're not sure, do rootcause build first.

    Syntax:

    rootcause deploy [-Fh][ [-x] program_file | [-c class] [-w] workspace.aws ] [-l license_file] [-m module][-o dply_file]

    Options:

    '-c class'
    the Java class registered with the workspace you wish to deploy.
    '-F'
    force overwriting of dply_file, if present.
    '-h'
    give this command's usage
    '-l license_file'
    the agent license file to include in the deployed workspace (default $APROBE/licenses/agent_license.dat.
    '-m module'
    is a module (shared library) for which an ADI file should be generated.
    '-o dply_file'
    the deploy file to create (default: workspace.clct)
    '-x program_file'
    the program registered with the workspace you wish to deploy.
    '-w workspace'.aws
    an existing, built RootCause workspace.

    Examples:

    1. Deploy workspace pi_demo.aws.
      rootcause deploy pi_demo.aws. 
      
    2. Deploy workspace for factor and module libFactor.so into Factor.dply.
      rootcause deploy -x /app/bin/factor -m  -o Factor.dply 
      

    rootcause format

    The rootcause format command runs apformat on the data collected in the specified workspace. This produces output similar to that produced by Save As Text in the RootCause GUI. By default rootcause format operates on the most current process. Because it formats all the data it can take a while for large amounts of data. You can use the -O option in conjunction with the apformat "-n" option to limit it to specific APD files, as shown in Example 3 below.

    Syntax:

    rootcause format [-hlr][-p PID][-O "options"][-t tmpdir] [-w] workspace.aws

    Options:

    '-h'
    give this command's usage
    '-l'
    list the APD rings (Process Data Sets) in the workspace, but don't format anything. The newest data set is listed first.
    '-r'
    raw: just run apformat directly on the APD file (with options specified using -O) rather than using the workspace's formatting script.
    '-p PID'
    format data for the process given by PID
    '-O "options"'
    pass options to the apformat command. The options must be in quotes, and quotes in the options themselves must be preceded by a backslash.
    '-t tmpdir'
    specifies the directory where intermediate files are to be produced. These can get very large--up to 10 times the size of the APD files depending on the formatting--and this can be used to avoid disk-space restrictions where the workspace resides.
    '-w workspace'.aws
    the RootCause workspace containing the data to be formatted.

    Examples:

    1. Format the newest data set in pi_demo.aws the file pi_demo.txt.

      $ rootcause format pi_demo.aws > pi_demo.txt

    2. List the Process Data Set in workspace pi_demo.aws.

      $ rootcause format -l pi_demo.aws /work/pi_demo.aws/pi_demo.apd.11991/pi_demo.apd /work/pi_demo.aws/pi_demo.apd.11785/pi_demo.apd

    3. Run apformat directly on the newest data file for process 11785 in pi_demo.aws.

      $ rootcause format -r -O "-n 0" -p 11785 pi_demo.aws


    rootcause log

    The rootcause log command provides information about the RootCause Log, and allows its maximum size to be changed.

    Syntax:

    rootcause log [-hlnsFZ | -s size ]

    Options:

    '-F'
    force -s size or -Z operation without confirmation
    '-h'
    give command-line help
    '-l'
    list log file contents to standard output
    '-n'
    list the log file name to standard output
    '-s'
    list the log file size to standard output
    '-s size'
    set the maximum size of the log to size bytes (size > 1000)
    '-Z'
    clear the contents of the log file

    Examples:

    1. Write the contents of the log to standard output:
      $ rootcause log 
      
    2. Set the size of the log to 20000 bytes:
      $ rootcause log -s 20000 
      

    rootcause merge

    The rootcause merge command merges two workspaces to create a new, third workspace. It works by copying the first primary workspace to the third result workspace, then adding compatible traces and UALs from the second secondary workspace. A module must exist in both the primary and secondary workspaces in order that traces for that module appear in the result workspace.

    There is no GUI operation equivalent to rootcause merge. You can use it in conjunction with the GUI by:

    • Using Workspace->Close to close your current workspace
    • Applying rootcause merge from the command line
    • Using Workspace->Open on the result workspace.

    Note: The rootcause build and rootcause register operations must be applied to the result workspace before the result workspace can be used to trace an application.

    Syntax:

    rootcause merge [-Fh] primary.aws secondary.aws result.aws

    Options:

    '-F'
    force result.aws to be overwritten if it exists
    '-h'
    give command-line help
    primary.aws
    The primary workspace, on which the result workspace is based.
    secondary.aws
    The secondary workspace, from which additional traces and UALS are added to the result workspace.
    result.aws
    The new workspace that is created.

    Examples:

    1. Merge traces in file_ops.aws into pi_demo.aws to produce pi_demo2.aws and make pi_demo2.aws the new workspace for tracing pi_demo
      $ rootcause merge file_ops.aws pi_demo.aws pi_demo2.aws
      $ rootcause build pi_demo2.aws
      $ rootcause register -F -x pi_demo -w pi_demo2.aws 
      

    rootcause new

    The rootcause new command creates a new workspace. Generally this is done through the RootCause GUI using the New menu item or Open Associated Workspace; (see "New Workspace Dialog"). The result of this operation is the named workspace, initialized to do default tracing. If the -r option is used, the workspace is also registered with the specified program or Java class.

    Syntax:

    rootcause new [-Fhr][-c class] -x program_file [-w] workspace.aws ]

    Options:

    '-c class'
    the Java class registered with the workspace you wish to deploy.
    '-F'
    force overwriting of workspace.aws if it exists.
    '-h'
    give this command's usage
    '-r'
    register the new workspace with the specified program or Java class
    '-x program_file'
    the executable program or Java .class or .jar file the workspace will be used to trace (as on the rootcause open command).
    '-w workspace'.aws
    the new workspace to be created.

    Examples:

    1. Create and register a new workspace for pi_demo.exe.
      $ rootcause new -r -x pi_demo.exe -w pi_demo.aws. 
      

    rootcause_off

    Use the rootcause_off command to disable rootcause interception of processes on your machine.

    Syntax:

    rootcause_off


    rootcause_on

    Use the rootcause_on command to start the inspection and interception of processes on your machine to determine if they should be traced with rootcause.

    Syntax:

    rootcause_on


    rootcause open

    The rootcause open command starts the RootCause GUI. If the application class specified on the command line is registered, the GUI will automatically set the workspace from the registry entry for the application. If the application is not registered, the GUI will prompt for a new workspace name and register the application. If no arguments are specified, the current RootCause Log file is opened.

    Syntax:

    rootcause open [[-x] program_file] [-c classname] [[-w] workspace.aws] [ [-d] dir.dclct | [-z] file.clct ]

    Options:

    program_file
    the executable program file, or the the .class or .jar file containing your Java application's main entry
    classname
    the main class name. This is required if classname is not the same as file
    workspace.aws
    a new or existing RootCause workspace
    dir.dclct
    a directory created by the RootCause Decollect operation
    file.clct
    a file created by the rootcause collect command

    Examples:

    1. Start the RootCause GUI and examine the RootCause Log file in a Trace Display window.
      $ rootcause open 
      
    2. Start the RootCause GUI to open new or existing workspace converter.aws.
      $ rootcause open converter.aws 
      
    3. Start the RootCause GUI to open a new or existing workspace for program converter.exe
      $ rootcause open converter.exe 
      
    4. Start the RootCause GUI to unpack (decollect) the collected rootcause data in pi_demo.clct.
      $ rootcause open pi_demo.clct 
      

    rootcause register

    The rootcause register command provides the interface to the RootCause registry. The GUI will allow you to add or delete the current workspace from the registry, but you must use the register command to otherwise manipulate the registry. It is likely that, over time, more GUI support will be added to manipulate the registry, but on computers where only the RootCause Agent is installed, there is no GUI and the register command must be used.

    Syntax:

    rootcause register [subcommand ] options [deploy_file]

    Description:

    subcommand

    The subcommand flag designates the operation to be performed:

    '-a'
    add a new entry in the registry (default)
    '-d'
    delete an entry from the registry
    '-h'
    give command help
    '-k'
    return 0 iff specified args are already registered & enabled
    '-l'
    lists all registry contents
    '-lr'
    list registry name only
    '-lw'
    list workspace name only
    '-lx'
    list only registered program only
    '-s'debug
    enable/disable debug mode with -eon/off (off by default)
    '-s'verbose
    enable/disable verbose mode with -e on/off (on by default) With verbose mode on, all processes are recorded in the log; with verbose off, only traced applications are recorded.
    '-Z'
    clear entire registry contents, including -s settings, returning them to their default values.

    options

    Options further qualifying the above are:
    '-c'classname
    probe Java commands naming main class classname
    '-e'on | off
    off specifies 'disabled' (default: on)
    '-F'
    force without confirmation
    '-j'dir
    dir is root of JRE containing java exe to probe
    '-m'file
    file is a module required for deploy_file consistency checking
    '-r'file
    file is registry file to use
    '-w'dir.aws
    file is workspace to use
    '-x'file
    file is executable to probe
    deploy_file
    is a .dply file to unpack into a registered workspace

    Examples:

    1. List the registry name and contents:
      $ rootcause register -l 
      
    2. Delete the registry entry for driver.exe:
      $ rootcause register -d -x /build/bin/driver 
      
    3. Turn off recording of all processes in the RootCause log:
      $ rootcause register -s verbose -e off 
      
    4. The following command will do the following all in one step:
      • register the program
      • create the workspace (if it does not exist)
      • deploy the trace into the workspace; and
      • check it's consistency with the modules to be traced

        This would be the typical command used on a remote computer where only the RootCause Agent component was installed in order to implement a .dply file generated by the RootCause GUI component. After this command is issued, you would merely execute rootcause_on in the context of the shell and run the application.

        $ rootcause register -x /opt/frobco/bin/frobit frobit.dply 
        

    rootcause run

    Use rootcause run before your command to cause it to be run with rootcause on, independent of the current rootcause status. The command specified will be run in the current window exactly as if it were not preceded by rootcause run. This is equivalent to

    rootcause_on commandrootcause_off

    Syntax:

    rootcause run command

    Options:

    command
    any shell command

    Example:

    1. Run the pi_demo application with rootcause on:
      $ rootcause run $APROBE/demo/RootCause/C++/pi_demo 
      



    rootcause status

    Use the rootcause status command to show whether rootcause tracing is currently enabled or disabled.

    Syntax:

    rootcause status


    rootcause xrun

    Identical to rootcause run, but the command is run in a separate window. This is used by the Run button in the RootCause GUI.

    Syntax:

    rootcause xrun command

    Copyright 2006-2017 OC Systems, Inc.

    Next Previous Index Top