License Header change: Removed the LICENSE_END before beta
[scilab.git] / scilab / modules / atoms / help / en_US / atomsRestoreConfig.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) DIGITEO - Simon GARESTE <simon.gareste@scilab.org>
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" 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="atomsRestoreConfig">
17     <refnamediv>
18         <refname>atomsRestoreConfig</refname>
19         <refpurpose>Restore the configuration from the backup file</refpurpose>
20     </refnamediv>
21     <!-- ===================================================================== -->
22     <!-- Calling Sequence -->
23     <!-- ===================================================================== -->
24     <refsynopsisdiv>
25         <title>Calling Sequence</title>
26         <synopsis>
27             atomsRestoreConfig()
28         </synopsis>
29     </refsynopsisdiv>
30     <!-- ===================================================================== -->
31     <!-- Description -->
32     <!-- ===================================================================== -->
33     <refsection>
34         <title>Description</title>
35         <para>
36             <literal>atomsRestoreConfig</literal> checks that a config.bak file exists, and set it as the main confiuration file. The backup file is deleted in the process.
37         </para>
38     </refsection>
39     <!-- ===================================================================== -->
40     <!-- Examples -->
41     <!-- ===================================================================== -->
42     <refsection>
43         <title>Examples</title>
44         <programlisting role="example"><![CDATA[ 
45 atomsSaveConfig(%T);
46 deletefile(atomsPath("system","user")+"config");
47 atomsRestoreConfig();
48 ]]></programlisting>
49     </refsection>
50     <!-- ===================================================================== -->
51     <!-- See also -->
52     <!-- ===================================================================== -->
53     <refsection role="see also">
54         <title>See Also</title>
55         <simplelist type="inline">
56             <member>
57                 <link linkend="atomsSaveConfig">atomsSaveConfig</link>
58             </member>
59             <member>
60                 <link linkend="atomsSetConfig">atomsSetConfig</link>
61             </member>
62             <member>
63                 <link linkend="atomsGetConfig">atomsGetConfig</link>
64             </member>
65         </simplelist>
66     </refsection>
67     <!-- ===================================================================== -->
68     <!-- Authors -->
69     <!-- ===================================================================== -->
70     <refsection>
71         <title>History</title>
72         <revhistory>
73             <revision>
74                 <revnumber>5.4.0</revnumber>
75                 <revdescription>Function added</revdescription>
76             </revision>
77         </revhistory>
78     </refsection>
79 </refentry>