Revision of English help pages for different functions (nothing serious).
[scilab.git] / scilab / modules / core / help / en_US / debugging / whereami.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="whereami">
3     <refnamediv>
4         <refname>whereami</refname>
5         <refpurpose>display current instruction calling tree</refpurpose>
6     </refnamediv>
7     <refsynopsisdiv>
8         <title>Calling Sequence</title>
9         <synopsis>whereami()</synopsis>
10     </refsynopsisdiv>
11     <refsection>
12         <title>Description</title>
13         <para>
14             Displays calling tree to instruction which contain <code>whereami()</code>. May be
15             used within <function>pause</function> levels.
16         </para>
17     </refsection>
18     <refsection>
19         <title>Examples</title>
20         <programlisting role="example"><![CDATA[ 
21 deff('y=test(a)',['y=sin(a)+1';
22                   'y=t1(y)';
23                   'y=y+1'])
24 deff('y=t1(y)',['y=y^2';'whereami()'])
25 test(1)
26  ]]></programlisting>
27     </refsection>
28     <refsection role="see also">
29         <title>See Also</title>
30         <simplelist type="inline">
31             <member>
32                 <link linkend="where">where</link>
33             </member>
34             <member>
35                 <link linkend="pause">pause</link>
36             </member>
37             <member>
38                 <link linkend="errcatch">errcatch</link>
39             </member>
40         </simplelist>
41     </refsection>
42 </refentry>