saveafterncommands() set obsolete
[scilab.git] / scilab / modules / history_manager / help / en_US / saveafterncommands.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!--
3  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
4  * Copyright (C) 2006-2008 - INRIA - Allan CORNET
5  *
6  * Copyright (C) 2012 - 2016 - Scilab Enterprises
7  *
8  * This file is hereby licensed under the terms of the GNU GPL v2.0,
9  * pursuant to article 5.3.4 of the CeCILL v.2.1.
10  * This file was originally licensed under the terms of the CeCILL v2.1,
11  * and continues to be available under such terms.
12  * For more information, see the COPYING file which you should have received
13  * along with this program.
14  *
15  -->
16 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"
17           xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML"
18           xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org"
19           xml:lang="en" xml:id="saveafterncommands">
20     <refnamediv>
21         <refname>saveafterncommands</refname>
22         <refpurpose>
23             Save the history file after n statements are added to the file
24             <emphasis role="bold">(obsolete)</emphasis>
25     </refpurpose>
26     </refnamediv>
27     <refsynopsisdiv>
28         <title>Syntax</title>
29         <synopsis>
30             saveafterncommands(n)
31             v = saveafterncommands()
32         </synopsis>
33     </refsynopsisdiv>
34     <refsection>
35         <title>Arguments</title>
36         <variablelist>
37             <varlistentry>
38                 <term>n</term>
39                 <listitem>
40                     <para>an integer, n statements</para>
41                 </listitem>
42             </varlistentry>
43             <varlistentry>
44                 <term>v</term>
45                 <listitem>
46                     <para>current value</para>
47                 </listitem>
48             </varlistentry>
49         </variablelist>
50     </refsection>
51     <refsection>
52         <title>Description</title>
53         <warning>
54             saveafterncommand(..) is canceled and does nothing. The history is now always
55             updated after each instruction run in the console. saveafterncommand(..) will
56             be removed from Scilab 6.1.x.
57         </warning>
58         <para>Save the history file after n statements are added to the file.</para>
59         <para>For example, when you select the option and set n to 5, after every 5 statements are added,
60             the history file is automatically saved.
61         </para>
62         <para>Use this option if you do not want to risk losing entries to the saved history because of an abnormal termination,
63             such as a power failure.
64         </para>
65         <para>saveafterncommands() returns current value.</para>
66         <para>default value is 0. History file saved at the end of scilab session.</para>
67     </refsection>
68     <refsection>
69         <title>Examples</title>
70         <programlisting role="example"><![CDATA[
71 saveafterncommands(3)
72  ]]></programlisting>
73     </refsection>
74     <refsection role="history">
75         <title>History</title>
76         <revhistory>
77             <revision>
78                 <revnumber>6.1.0</revnumber>
79                 <revdescription>
80                     saveafterncommands(..) is canceled. It will be removed from Scilab 6.1.x
81                 </revdescription>
82             </revision>
83         </revhistory>
84     </refsection>
85 </refentry>