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             </para>
  50     </refsection>
  51     <refsection>
  52         <title>Examples</title>
  53         <programlisting role="example"><![CDATA[
  54 lines(0)
  55 whos()
  56 whos -type boolean
  57 whos -name %
  58  ]]></programlisting>
  59     </refsection>
  60     <refsection role="see also">
  61         <title>See Also</title>
  62         <simplelist type="inline">
  63             <member>
  64                 <link linkend="who">who</link>
  65             </member>
  66             <member>
  67                 <link linkend="who_user">who_user</link>
  68             </member>
  69             <member>
  70                 <link linkend="typeof">typeof</link>
  71             </member>
  72         </simplelist>
  73     </refsection>
  74 </refentry>