<?xml version="1.0" encoding="UTF-8"?>
<!--
 * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
 * Copyright (C) 2006-2008 - INRIA - Allan CORNET
 *
 * Copyright (C) 2012 - 2016 - Scilab Enterprises
 *
 * This file is hereby licensed under the terms of the GNU GPL v2.0,
 * pursuant to article 5.3.4 of the CeCILL v.2.1.
 * This file was originally licensed under the terms of the CeCILL v2.1,
 * and continues to be available under such terms.
 * For more information, see the COPYING file which you should have received
 * along with this program.
 *
 -->
<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="saveafterncommands">
    <refnamediv>
        <refname>saveafterncommands</refname>
        <refpurpose>
            Save the history file after n statements are added to the file
            <emphasis role="bold">(obsolete)</emphasis>
    </refpurpose>
    </refnamediv>
    <refsynopsisdiv>
        <title>Syntax</title>
        <synopsis>
            saveafterncommands(n)
            v = saveafterncommands()
        </synopsis>
    </refsynopsisdiv>
    <refsection>
        <title>Arguments</title>
        <variablelist>
            <varlistentry>
                <term>n</term>
                <listitem>
                    <para>an integer, n statements</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>v</term>
                <listitem>
                    <para>current value</para>
                </listitem>
            </varlistentry>
        </variablelist>
    </refsection>
    <refsection>
        <title>Description</title>
        <warning>
            saveafterncommand(..) is canceled and does nothing. The history is now always
            updated after each instruction run in the console. saveafterncommand(..) will
            be removed from Scilab 6.1.x.
        </warning>
        <para>Save the history file after n statements are added to the file.</para>
        <para>For example, when you select the option and set n to 5, after every 5 statements are added,
            the history file is automatically saved.
        </para>
        <para>Use this option if you do not want to risk losing entries to the saved history because of an abnormal termination,
            such as a power failure.
        </para>
        <para>saveafterncommands() returns current value.</para>
        <para>default value is 0. History file saved at the end of scilab session.</para>
    </refsection>
    <refsection>
        <title>Examples</title>
        <programlisting role="example"><![CDATA[
saveafterncommands(3)
 ]]></programlisting>
    </refsection>
    <refsection role="history">
        <title>History</title>
        <revhistory>
            <revision>
                <revnumber>6.1.0</revnumber>
                <revdescription>
                    saveafterncommands(..) is canceled. It will be removed from Scilab 6.1.x
                </revdescription>
            </revision>
        </revhistory>
    </refsection>
</refentry>
