scilab/modules/core/help/en_US/variables/clearglobal.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="clearglobal">
   3     <refnamediv>
   4         <refname>clearglobal</refname>
   5         <refpurpose>kills global variables</refpurpose>
   6     </refnamediv>
   7     <refsynopsisdiv>
   8         <title>Calling Sequence</title>
   9         <synopsis>clearglobal()
  10             clearglobal nam1 ... namn
  11             clearglobal('nam1', ...,'namn')
  12         </synopsis>
  13     </refsynopsisdiv>
  14     <refsection>
  15         <title>Arguments</title>
  16         <variablelist>
  17             <varlistentry>
  18                 <term>nam1,..., namn</term>
  19                 <listitem>
  20                     <para>valid variable names</para>
  21                 </listitem>
  22             </varlistentry>
  23         </variablelist>
  24     </refsection>
  25     <refsection>
  26         <title>Description</title>
  27         <para>
  28             <literal>clearglobal()</literal> kills all the global variables.
  29         </para>
  30         <para>
  31             <literal>clearglobal nam1 ... namn</literal>  kills  the global variables given by
  32             their names.
  33         </para>
  34         <para>
  35             Note that <literal>clearglobal() </literal> only clears the global variables, the
  36             local copies of these global variables are not destroyed.
  37         </para>
  38     </refsection>
  39     <refsection>
  40         <title>Examples</title>
  41         <programlisting role="example"><![CDATA[
  42 global a b c
  43 a=1;b=2;c=3;
  44 who('global')
  45 clearglobal b
  46 who('global')
  47  ]]></programlisting>
  48     </refsection>
  49     <refsection role="see also">
  50         <title>See Also</title>
  51         <simplelist type="inline">
  52             <member>
  53                 <link linkend="global">global</link>
  54             </member>
  55             <member>
  56                 <link linkend="who">who</link>
  57             </member>
  58         </simplelist>
  59     </refsection>
  60 </refentry>