Fix some build issues in the documentation
[scilab.git] / scilab / modules / core / help / en_US / variables / whos.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="whos">
3     <refnamediv>
4         <refname>whos</refname>
5         <refpurpose>listing of variables in long form</refpurpose>
6     </refnamediv>
7     <refsynopsisdiv>
8         <title>Calling Sequence</title>
9         <synopsis>
10             whos()
11             whos -type typ
12             whos -name nam
13         </synopsis>
14     </refsynopsisdiv>
15     <refsection>
16         <title>Arguments</title>
17         <variablelist>
18             <varlistentry>
19                 <term>typ</term>
20                 <listitem>
21                     <para>
22                         a name of selected variable type (see <link linkend="typeof">typeof</link>)
23                     </para>
24                 </listitem>
25             </varlistentry>
26             <varlistentry>
27                 <term>nam</term>
28                 <listitem>
29                     <para>first characters of selected names</para>
30                 </listitem>
31             </varlistentry>
32         </variablelist>
33     </refsection>
34     <refsection>
35         <title>Description</title>
36         <para>
37             <code>whos()</code> displays all current variable names 
38             sorted by name (case insensitive), types and memory used.
39         </para>
40         <para>
41             <literal>whos -type typ</literal> displays all current variables with specified type <varname>typ</varname>.
42         </para>
43         <para>
44             <literal>whos -name nam</literal> displays all current variables whose names begin with <varname>nam</varname>.
45         </para>
46         <para>
47             <note>
48                 Note: If a variable is global, a <literal>*</literal> appears after its type name.
49             </note>
50         </para>
51     </refsection>
52     <refsection>
53         <title>Examples</title>
54         <programlisting role="example"><![CDATA[ 
55 lines(0) 
56 whos()
57 whos -type boolean
58 whos -name %
59  ]]></programlisting>
60     </refsection>
61     <refsection role="see also">
62         <title>See Also</title>
63         <simplelist type="inline">
64             <member>
65                 <link linkend="who">who</link>
66             </member>
67             <member>
68                 <link linkend="who_user">who_user</link>
69             </member>
70             <member>
71                 <link linkend="typeof">typeof</link>
72             </member>
73         </simplelist>
74     </refsection>
75 </refentry>