<?xml version="1.0" encoding="UTF-8"?>
<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="getmemory">
    <refnamediv>
        <refname>getmemory</refname>
        <refpurpose>returns free and total system memory</refpurpose>
    </refnamediv>
    <refsynopsisdiv>
        <title>Syntax</title>
        <synopsis>[free, total]=getmemory()</synopsis>
    </refsynopsisdiv>
    <refsection>
        <title>Description</title>
        <para>
            <literal>getmemory()</literal> returns free system memory  (kilo-bytes).
        </para>
        <para>
            <literal>[free, total] = getmemory()</literal> returns free and total system memory  (kilo-bytes).
        </para>
        <para>
            <warning>
                Do not rely too much on this function. Due to various level of caching,
                free memory detection is a tricky thing under most modern operating
                systems.
            </warning>
        </para>
    </refsection>
    <refsection>
        <title>Examples</title>
        <programlisting role="example"><![CDATA[
[a,b] = getmemory()
 ]]></programlisting>
    </refsection>
    <refsection role="see also">
        <title>See also</title>
        <simplelist type="inline">
            <member>
                <link linkend="who">who</link>
            </member>
            <member>
                <link linkend="recursionlimit">recursionlimit</link>
            </member>
            <member>
                <link linkend="host">host</link>
            </member>
        </simplelist>
    </refsection>
</refentry>
