* Bug 16365 fixed: median(m,'r'|'c') was wrong after 5dc990
[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  * Copyright (C) 2012 - 2016 - Scilab Enterprises
8  *
9  * This file is hereby licensed under the terms of the GNU GPL v2.0,
10  * pursuant to article 5.3.4 of the CeCILL v.2.1.
11  * This file was originally licensed under the terms of the CeCILL v2.1,
12  * and continues to be available under such terms.
13  * For more information, see the COPYING file which you should have received
14  * along with this program.
15  *
16  -->
17 <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">
18     <refnamediv>
19         <refname>loadhistory</refname>
20         <refpurpose>load a history file</refpurpose>
21     </refnamediv>
22     <refsynopsisdiv>
23         <title>Syntax</title>
24         <synopsis>loadhistory()
25             loadhistory(f)
26         </synopsis>
27     </refsynopsisdiv>
28     <refsection>
29         <title>Arguments</title>
30         <variablelist>
31             <varlistentry>
32                 <term>f</term>
33                 <listitem>
34                     <para>file pathname</para>
35                 </listitem>
36             </varlistentry>
37         </variablelist>
38     </refsection>
39     <refsection>
40         <title>Description</title>
41         <para>load a history file.</para>
42         <para>by default, history filename is SCIHOME/history</para>
43         <para>by default, loadhistory read last 20000 lines of history file(to
44             reduce time loading).
45         </para>
46         <para>
47             see <link linkend="historysize">historysize(value)</link> to modify
48             this value.
49         </para>
50     </refsection>
51     <refsection>
52         <title>Examples</title>
53         <programlisting role="example"> loadhistory(SCI+'/session.scilab')  </programlisting>
54     </refsection>
55     <refsection role="see also">
56         <title>See also</title>
57         <simplelist type="inline">
58             <member>
59                 <link linkend="savehistory">savehistory</link>
60             </member>
61             <member>
62                 <link linkend="resethistory">resethistory</link>
63             </member>
64             <member>
65                 <link linkend="historysize">historysize</link>
66             </member>
67             <member>
68                 <link linkend="gethistory">gethistory</link>
69             </member>
70         </simplelist>
71     </refsection>
72     <refsection>
73         <title>History</title>
74         <revhistory>
75             <revision>
76                 <revnumber>5.4.1</revnumber>
77                 <revremark>
78                     Default history file is SCIHOME/history (instead of SCIHOME/.history.scilab).
79                 </revremark>
80             </revision>
81         </revhistory>
82     </refsection>
83 </refentry>