* Bug #12333 fixed - Cleaned command history is restored after reopening Scilab.
[scilab.git] / scilab / modules / history_manager / help / en_US / loadhistory.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  * Copyright (C) 2011 - DIGITEO - Allan CORNET
6  *
7  * This file must be used under the terms of the CeCILL.
8  * This source file is licensed as described in the file COPYING, which
9  * you should have received as part of this distribution.  The terms
10  * are also available at
11  * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
12  *
13  -->
14 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:ns4="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="loadhistory" xml:lang="en">
15     <refnamediv>
16         <refname>loadhistory</refname>
17         <refpurpose>load a history file</refpurpose>
18     </refnamediv>
19     <refsynopsisdiv>
20         <title>Calling Sequence</title>
21         <synopsis>loadhistory()
22             loadhistory(f)
23         </synopsis>
24     </refsynopsisdiv>
25     <refsection>
26         <title>Arguments</title>
27         <variablelist>
28             <varlistentry>
29                 <term>f</term>
30                 <listitem>
31                     <para>file pathname</para>
32                 </listitem>
33             </varlistentry>
34         </variablelist>
35     </refsection>
36     <refsection>
37         <title>Description</title>
38         <para>load a history file.</para>
39         <para>by default, history filename is SCIHOME/history</para>
40         <para>by default, loadhistory read last 20000 lines of history file(to
41             reduce time loading).
42         </para>
43         <para>
44             see <link linkend="historysize">historysize(value)</link> to modify
45             this value.
46         </para>
47     </refsection>
48     <refsection>
49         <title>Examples</title>
50         <programlisting role="example"> loadhistory(SCI+'/session.scilab')  </programlisting>
51     </refsection>
52     <refsection role="see also">
53         <title>See Also</title>
54         <simplelist type="inline">
55             <member>
56                 <link linkend="savehistory">savehistory</link>
57             </member>
58             <member>
59                 <link linkend="resethistory">resethistory</link>
60             </member>
61             <member>
62                 <link linkend="historysize">historysize</link>
63             </member>
64             <member>
65                 <link linkend="gethistory">gethistory</link>
66             </member>
67         </simplelist>
68     </refsection>
69     <refsection>
70         <title>History</title>
71         <revhistory>
72             <revision>
73                 <revnumber>5.4.1</revnumber>
74                 <revremark>
75                     Default history file is SCIHOME/history (instead of SCIHOME/.history.scilab).
76                 </revremark>
77             </revision>
78         </revhistory>
79     </refsection>
80 </refentry>