* Bug #12333 fixed - Cleaned command history is restored after reopening Scilab.
[scilab.git] / scilab / modules / history_manager / help / en_US / savehistory.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) 2007-2008 - INRIA - Allan CORNET
5  *
6  * This file must be used under the terms of the CeCILL.
7  * This source file is licensed as described in the file COPYING, which
8  * you should have received as part of this distribution.  The terms
9  * are also available at
10  * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
11  *
12  -->
13 <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="savehistory">
14     <refnamediv>
15         <refname>savehistory</refname>
16         <refpurpose>save the current history in a file</refpurpose>
17     </refnamediv>
18     <refsynopsisdiv>
19         <title>Calling Sequence</title>
20         <synopsis>savehistory()
21             savehistory(f)
22         </synopsis>
23     </refsynopsisdiv>
24     <refsection>
25         <title>Arguments</title>
26         <variablelist>
27             <varlistentry>
28                 <term>f</term>
29                 <listitem>
30                     <para>file pathname</para>
31                 </listitem>
32             </varlistentry>
33         </variablelist>
34     </refsection>
35     <refsection>
36         <title>Description</title>
37         <para>save the current history in a file.</para>
38         <para>by default, history filename is SCIHOME/history</para>
39     </refsection>
40     <refsection>
41         <title>Examples</title>
42         <programlisting role="example"><![CDATA[
43 savehistory(SCI+'/session.scilab')
44  ]]></programlisting>
45     </refsection>
46     <refsection role="see also">
47         <title>See Also</title>
48         <simplelist type="inline">
49             <member>
50                 <link linkend="loadhistory">loadhistory</link>
51             </member>
52             <member>
53                 <link linkend="resethistory">resethistory</link>
54             </member>
55             <member>
56                 <link linkend="gethistory">gethistory</link>
57             </member>
58         </simplelist>
59     </refsection>
60     <refsection>
61         <title>History</title>
62         <revhistory>
63             <revision>
64                 <revnumber>5.4.1</revnumber>
65                 <revremark>
66                     Default history file is SCIHOME/history (instead of SCIHOME/.history.scilab).
67                 </revremark>
68             </revision>
69         </revhistory>
70     </refsection>
71 </refentry>